1import gdbremote_testcase
2import textwrap
3from lldbsuite.test.decorators import *
4from lldbsuite.test.lldbtest import *
5from lldbsuite.test import lldbutil
6
7def _extract_register_value(reg_info, reg_bank, byte_order, bytes_per_entry=8):
8    reg_offset = int(reg_info["offset"])*2
9    reg_byte_size = int(2 * int(reg_info["bitsize"]) / 8)
10    # Create slice with the contents of the register.
11    reg_slice = reg_bank[reg_offset:reg_offset+reg_byte_size]
12
13    reg_value = []
14    # Wrap slice according to bytes_per_entry.
15    for entry in textwrap.wrap(reg_slice, 2 * bytes_per_entry):
16        # Invert the bytes order if target uses little-endian.
17        if byte_order == lldb.eByteOrderLittle:
18            entry = "".join(reversed([entry[i:i+2] for i in range(0,
19                                          len(entry),2)]))
20        reg_value.append("0x" + entry)
21
22    return reg_value
23
24
25class TestGdbRemoteGPacket(gdbremote_testcase.GdbRemoteTestCaseBase):
26
27    mydir = TestBase.compute_mydir(__file__)
28
29    @skipIfOutOfTreeDebugserver
30    @skipUnlessDarwin # G packet not supported
31    def test_g_packet(self):
32        self.build()
33        self.prep_debug_monitor_and_inferior()
34        self.test_sequence.add_log_lines(
35            ["read packet: $g#67",
36             {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$",
37              "capture": {1: "register_bank"}}],
38            True)
39        context = self.expect_gdbremote_sequence()
40        register_bank = context.get("register_bank")
41        self.assertNotEqual(register_bank[0], 'E')
42
43        self.test_sequence.add_log_lines(
44            ["read packet: $G" + register_bank + "#00",
45             {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$",
46              "capture": {1: "G_reply"}}],
47            True)
48        context = self.expect_gdbremote_sequence()
49        self.assertNotEqual(context.get("G_reply")[0], 'E')
50
51    @skipIf(archs=no_match(["x86_64"]))
52    def g_returns_correct_data(self, with_suffix):
53        procs = self.prep_debug_monitor_and_inferior()
54
55        self.add_register_info_collection_packets()
56        if with_suffix:
57            self.add_thread_suffix_request_packets()
58        self.add_threadinfo_collection_packets()
59        context = self.expect_gdbremote_sequence()
60        self.assertIsNotNone(context)
61
62        # Gather register info.
63        reg_infos = self.parse_register_info_packets(context)
64        self.assertIsNotNone(reg_infos)
65        self.add_lldb_register_index(reg_infos)
66        # Index register info entries by name.
67        reg_infos = {info['name']: info for info in reg_infos}
68
69        # Gather thread info.
70        if with_suffix:
71            threads = self.parse_threadinfo_packets(context)
72            self.assertIsNotNone(threads)
73            thread_id = threads[0]
74            self.assertIsNotNone(thread_id)
75        else:
76            thread_id = None
77
78        # Send vCont packet to resume the inferior.
79        self.test_sequence.add_log_lines(["read packet: $vCont;c#a8",
80                                          {"direction": "send",
81                                           "regex": r"^\$T([0-9a-fA-F]{2}).*#[0-9a-fA-F]{2}$",
82                                           "capture": {1: "hex_exit_code"}},
83                                          ],
84                                         True)
85
86        # Send g packet to retrieve the register bank
87        if thread_id:
88            g_request = "read packet: $g;thread:{:x}#00".format(thread_id)
89        else:
90            g_request = "read packet: $g#00"
91        self.test_sequence.add_log_lines(
92            [g_request,
93             {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$",
94              "capture": {1: "register_bank"}}],
95            True)
96        context = self.expect_gdbremote_sequence()
97        self.assertIsNotNone(context)
98        reg_bank = context.get("register_bank")
99        self.assertNotEqual(reg_bank[0], 'E')
100
101        byte_order = self.get_target_byte_order()
102        get_reg_value = lambda reg_name : _extract_register_value(
103            reg_infos[reg_name], reg_bank, byte_order)
104
105        self.assertEqual(['0x0102030405060708'], get_reg_value('r8'))
106        self.assertEqual(['0x1112131415161718'], get_reg_value('r9'))
107        self.assertEqual(['0x2122232425262728'], get_reg_value('r10'))
108        self.assertEqual(['0x3132333435363738'], get_reg_value('r11'))
109        self.assertEqual(['0x4142434445464748'], get_reg_value('r12'))
110        self.assertEqual(['0x5152535455565758'], get_reg_value('r13'))
111        self.assertEqual(['0x6162636465666768'], get_reg_value('r14'))
112        self.assertEqual(['0x7172737475767778'], get_reg_value('r15'))
113
114        self.assertEqual(
115            ['0x020406080a0c0e01', '0x030507090b0d0f00'], get_reg_value('xmm8'))
116        self.assertEqual(
117            ['0x121416181a1c1e11', '0x131517191b1d1f10'], get_reg_value('xmm9'))
118        self.assertEqual(
119            ['0x222426282a2c2e21', '0x232527292b2d2f20'], get_reg_value('xmm10'))
120        self.assertEqual(
121            ['0x323436383a3c3e31', '0x333537393b3d3f30'], get_reg_value('xmm11'))
122        self.assertEqual(
123            ['0x424446484a4c4e41', '0x434547494b4d4f40'], get_reg_value('xmm12'))
124        self.assertEqual(
125            ['0x525456585a5c5e51', '0x535557595b5d5f50'], get_reg_value('xmm13'))
126        self.assertEqual(
127            ['0x626466686a6c6e61', '0x636567696b6d6f60'], get_reg_value('xmm14'))
128        self.assertEqual(
129            ['0x727476787a7c7e71', '0x737577797b7d7f70'], get_reg_value('xmm15'))
130
131    @expectedFailureAll(oslist=["freebsd"], bugnumber="llvm.org/pr48420")
132    @expectedFailureNetBSD
133    @skipIfDarwin # g packet not supported
134    def test_g_returns_correct_data_with_suffix(self):
135        self.build()
136        self.set_inferior_startup_launch()
137        self.g_returns_correct_data(True)
138
139    @expectedFailureAll(oslist=["freebsd"], bugnumber="llvm.org/pr48420")
140    @expectedFailureNetBSD
141    @skipIfDarwin # g packet not supported
142    def test_g_returns_correct_data_no_suffix(self):
143        self.build()
144        self.set_inferior_startup_launch()
145        self.g_returns_correct_data(False)
146