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    @skipIfOutOfTreeDebugserver
28    @skipUnlessDarwin # G packet not supported
29    def test_g_packet(self):
30        self.build()
31        self.prep_debug_monitor_and_inferior()
32        self.test_sequence.add_log_lines(
33            ["read packet: $g#67",
34             {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$",
35              "capture": {1: "register_bank"}}],
36            True)
37        context = self.expect_gdbremote_sequence()
38        register_bank = context.get("register_bank")
39        self.assertNotEqual(register_bank[0], 'E')
40
41        self.test_sequence.add_log_lines(
42            ["read packet: $G" + register_bank + "#00",
43             {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$",
44              "capture": {1: "G_reply"}}],
45            True)
46        context = self.expect_gdbremote_sequence()
47        self.assertNotEqual(context.get("G_reply")[0], 'E')
48
49    @skipIf(archs=no_match(["x86_64"]))
50    def g_returns_correct_data(self, with_suffix):
51        procs = self.prep_debug_monitor_and_inferior()
52
53        self.add_register_info_collection_packets()
54        if with_suffix:
55            self.add_thread_suffix_request_packets()
56        self.add_threadinfo_collection_packets()
57        context = self.expect_gdbremote_sequence()
58        self.assertIsNotNone(context)
59
60        # Gather register info.
61        reg_infos = self.parse_register_info_packets(context)
62        self.assertIsNotNone(reg_infos)
63        self.add_lldb_register_index(reg_infos)
64        # Index register info entries by name.
65        reg_infos = {info['name']: info for info in reg_infos}
66
67        # Gather thread info.
68        if with_suffix:
69            threads = self.parse_threadinfo_packets(context)
70            self.assertIsNotNone(threads)
71            thread_id = threads[0]
72            self.assertIsNotNone(thread_id)
73        else:
74            thread_id = None
75
76        # Send vCont packet to resume the inferior.
77        self.test_sequence.add_log_lines(["read packet: $vCont;c#a8",
78                                          {"direction": "send",
79                                           "regex": r"^\$T([0-9a-fA-F]{2}).*#[0-9a-fA-F]{2}$",
80                                           "capture": {1: "hex_exit_code"}},
81                                          ],
82                                         True)
83
84        # Send g packet to retrieve the register bank
85        if thread_id:
86            g_request = "read packet: $g;thread:{:x}#00".format(thread_id)
87        else:
88            g_request = "read packet: $g#00"
89        self.test_sequence.add_log_lines(
90            [g_request,
91             {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$",
92              "capture": {1: "register_bank"}}],
93            True)
94        context = self.expect_gdbremote_sequence()
95        self.assertIsNotNone(context)
96        reg_bank = context.get("register_bank")
97        self.assertNotEqual(reg_bank[0], 'E')
98
99        byte_order = self.get_target_byte_order()
100        get_reg_value = lambda reg_name : _extract_register_value(
101            reg_infos[reg_name], reg_bank, byte_order)
102
103        self.assertEqual(['0x0102030405060708'], get_reg_value('r8'))
104        self.assertEqual(['0x1112131415161718'], get_reg_value('r9'))
105        self.assertEqual(['0x2122232425262728'], get_reg_value('r10'))
106        self.assertEqual(['0x3132333435363738'], get_reg_value('r11'))
107        self.assertEqual(['0x4142434445464748'], get_reg_value('r12'))
108        self.assertEqual(['0x5152535455565758'], get_reg_value('r13'))
109        self.assertEqual(['0x6162636465666768'], get_reg_value('r14'))
110        self.assertEqual(['0x7172737475767778'], get_reg_value('r15'))
111
112        self.assertEqual(
113            ['0x020406080a0c0e01', '0x030507090b0d0f00'], get_reg_value('xmm8'))
114        self.assertEqual(
115            ['0x121416181a1c1e11', '0x131517191b1d1f10'], get_reg_value('xmm9'))
116        self.assertEqual(
117            ['0x222426282a2c2e21', '0x232527292b2d2f20'], get_reg_value('xmm10'))
118        self.assertEqual(
119            ['0x323436383a3c3e31', '0x333537393b3d3f30'], get_reg_value('xmm11'))
120        self.assertEqual(
121            ['0x424446484a4c4e41', '0x434547494b4d4f40'], get_reg_value('xmm12'))
122        self.assertEqual(
123            ['0x525456585a5c5e51', '0x535557595b5d5f50'], get_reg_value('xmm13'))
124        self.assertEqual(
125            ['0x626466686a6c6e61', '0x636567696b6d6f60'], get_reg_value('xmm14'))
126        self.assertEqual(
127            ['0x727476787a7c7e71', '0x737577797b7d7f70'], get_reg_value('xmm15'))
128
129    @expectedFailureAll(oslist=["freebsd"], bugnumber="llvm.org/pr48420")
130    @expectedFailureNetBSD
131    @skipIfDarwin # g packet not supported
132    def test_g_returns_correct_data_with_suffix(self):
133        self.build()
134        self.set_inferior_startup_launch()
135        self.g_returns_correct_data(True)
136
137    @expectedFailureAll(oslist=["freebsd"], bugnumber="llvm.org/pr48420")
138    @expectedFailureNetBSD
139    @skipIfDarwin # g packet not supported
140    def test_g_returns_correct_data_no_suffix(self):
141        self.build()
142        self.set_inferior_startup_launch()
143        self.g_returns_correct_data(False)
144