Release 1.5.29.
[wine] / programs / winedbg / be_arm64.c
1 /*
2  * Debugger ARM64 specific functions
3  *
4  * Copyright 2010-2013 AndrĂ© Hentschel
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "debugger.h"
22
23 #if defined(__aarch64__) && !defined(__AARCH64EB__)
24
25 static unsigned be_arm64_get_addr(HANDLE hThread, const CONTEXT* ctx,
26                                   enum be_cpu_addr bca, ADDRESS64* addr)
27 {
28     switch (bca)
29     {
30     case be_cpu_addr_pc:
31         return be_cpu_build_addr(hThread, ctx, addr, 0, ctx->Pc);
32     case be_cpu_addr_stack:
33         return be_cpu_build_addr(hThread, ctx, addr, 0, ctx->Sp);
34     case be_cpu_addr_frame:
35         return be_cpu_build_addr(hThread, ctx, addr, 0, ctx->X29);
36         break;
37     }
38     return FALSE;
39 }
40
41 static unsigned be_arm64_get_register_info(int regno, enum be_cpu_addr* kind)
42 {
43     switch (regno)
44     {
45     case CV_ARM64_PC:      *kind = be_cpu_addr_pc;    return TRUE;
46     case CV_ARM64_SP:      *kind = be_cpu_addr_stack; return TRUE;
47     case CV_ARM64_X0 + 29: *kind = be_cpu_addr_frame; return TRUE;
48     }
49     return FALSE;
50 }
51
52 static void be_arm64_single_step(CONTEXT* ctx, unsigned enable)
53 {
54     dbg_printf("be_arm64_single_step: not done\n");
55 }
56
57 static void be_arm64_print_context(HANDLE hThread, const CONTEXT* ctx, int all_regs)
58 {
59     static const char condflags[] = "NZCV";
60     int i;
61     char        buf[8];
62
63     switch (ctx->PState & 0x0f)
64     {
65     case 0:  strcpy(buf, "EL0t"); break;
66     case 4:  strcpy(buf, "EL1t"); break;
67     case 5:  strcpy(buf, "EL1t"); break;
68     case 8:  strcpy(buf, "EL2t"); break;
69     case 9:  strcpy(buf, "EL2t"); break;
70     case 12: strcpy(buf, "EL3t"); break;
71     case 13: strcpy(buf, "EL3t"); break;
72     default: strcpy(buf, "UNKNWN"); break;
73     }
74
75     dbg_printf("Register dump:\n");
76     dbg_printf("%s %s Mode\n", (ctx->PState & 0x10) ? "ARM" : "ARM64", buf);
77
78     strcpy(buf, condflags);
79     for (i = 0; buf[i]; i++)
80         if (!((ctx->PState >> 26) & (1 << (sizeof(condflags) - i))))
81             buf[i] = '-';
82
83     dbg_printf(" Pc:%016lx Sp:%016lx Pstate:%016lx(%s)\n",
84                ctx->Pc, ctx->Sp, ctx->PState, buf);
85     dbg_printf(" x0: %016lx x1: %016lx x2: %016lx x3: %016lx x4: %016lx\n",
86                ctx->X0, ctx->X1, ctx->X2, ctx->X3, ctx->X4);
87     dbg_printf(" x5: %016lx x6: %016lx x7: %016lx x8: %016lx x9: %016lx\n",
88                ctx->X5, ctx->X6, ctx->X7, ctx->X8, ctx->X9);
89     dbg_printf(" x10:%016lx x11:%016lx x12:%016lx x13:%016lx x14:%016lx\n",
90                ctx->X10, ctx->X11, ctx->X12, ctx->X13, ctx->X14);
91     dbg_printf(" x15:%016lx x16:%016lx x17:%016lx x18:%016lx x19:%016lx\n",
92                ctx->X15, ctx->X16, ctx->X17, ctx->X18, ctx->X19);
93     dbg_printf(" x20:%016lx x21:%016lx x22:%016lx x23:%016lx x24:%016lx\n",
94                ctx->X20, ctx->X21, ctx->X22, ctx->X23, ctx->X24);
95     dbg_printf(" x25:%016lx x26:%016lx x27:%016lx x28:%016lx x29:%016lx\n",
96                ctx->X25, ctx->X26, ctx->X27, ctx->X28, ctx->X29);
97     dbg_printf(" x30:%016lx\n", ctx->X30);
98
99     if (all_regs) dbg_printf( "Floating point ARM64 dump not implemented\n" );
100 }
101
102 static void be_arm64_print_segment_info(HANDLE hThread, const CONTEXT* ctx)
103 {
104 }
105
106 static struct dbg_internal_var be_arm64_ctx[] =
107 {
108     {CV_ARM64_X0 +  0,    "x0",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X0),     dbg_itype_unsigned_long_int},
109     {CV_ARM64_X0 +  1,    "x1",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X1),     dbg_itype_unsigned_long_int},
110     {CV_ARM64_X0 +  2,    "x2",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X2),     dbg_itype_unsigned_long_int},
111     {CV_ARM64_X0 +  3,    "x3",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X3),     dbg_itype_unsigned_long_int},
112     {CV_ARM64_X0 +  4,    "x4",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X4),     dbg_itype_unsigned_long_int},
113     {CV_ARM64_X0 +  5,    "x5",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X5),     dbg_itype_unsigned_long_int},
114     {CV_ARM64_X0 +  6,    "x6",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X6),     dbg_itype_unsigned_long_int},
115     {CV_ARM64_X0 +  7,    "x7",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X7),     dbg_itype_unsigned_long_int},
116     {CV_ARM64_X0 +  8,    "x8",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X8),     dbg_itype_unsigned_long_int},
117     {CV_ARM64_X0 +  9,    "x9",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X9),     dbg_itype_unsigned_long_int},
118     {CV_ARM64_X0 +  10,   "x10",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X10),    dbg_itype_unsigned_long_int},
119     {CV_ARM64_X0 +  11,   "x11",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X11),    dbg_itype_unsigned_long_int},
120     {CV_ARM64_X0 +  12,   "x12",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X12),    dbg_itype_unsigned_long_int},
121     {CV_ARM64_X0 +  13,   "x13",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X13),    dbg_itype_unsigned_long_int},
122     {CV_ARM64_X0 +  14,   "x14",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X14),    dbg_itype_unsigned_long_int},
123     {CV_ARM64_X0 +  15,   "x15",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X15),    dbg_itype_unsigned_long_int},
124     {CV_ARM64_X0 +  16,   "x16",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X16),    dbg_itype_unsigned_long_int},
125     {CV_ARM64_X0 +  17,   "x17",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X17),    dbg_itype_unsigned_long_int},
126     {CV_ARM64_X0 +  18,   "x18",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X18),    dbg_itype_unsigned_long_int},
127     {CV_ARM64_X0 +  19,   "x19",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X19),    dbg_itype_unsigned_long_int},
128     {CV_ARM64_X0 +  20,   "x20",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X20),    dbg_itype_unsigned_long_int},
129     {CV_ARM64_X0 +  21,   "x21",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X21),    dbg_itype_unsigned_long_int},
130     {CV_ARM64_X0 +  22,   "x22",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X22),    dbg_itype_unsigned_long_int},
131     {CV_ARM64_X0 +  23,   "x23",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X23),    dbg_itype_unsigned_long_int},
132     {CV_ARM64_X0 +  24,   "x24",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X24),    dbg_itype_unsigned_long_int},
133     {CV_ARM64_X0 +  25,   "x25",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X25),    dbg_itype_unsigned_long_int},
134     {CV_ARM64_X0 +  26,   "x26",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X26),    dbg_itype_unsigned_long_int},
135     {CV_ARM64_X0 +  27,   "x27",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X27),    dbg_itype_unsigned_long_int},
136     {CV_ARM64_X0 +  28,   "x28",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X28),    dbg_itype_unsigned_long_int},
137     {CV_ARM64_X0 +  29,   "x29",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X29),    dbg_itype_unsigned_long_int},
138     {CV_ARM64_X0 +  30,   "x30",    (DWORD_PTR*)FIELD_OFFSET(CONTEXT, X30),    dbg_itype_unsigned_long_int},
139     {CV_ARM64_SP,         "sp",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, Sp),     dbg_itype_unsigned_long_int},
140     {CV_ARM64_PC,         "pc",     (DWORD_PTR*)FIELD_OFFSET(CONTEXT, Pc),     dbg_itype_unsigned_long_int},
141     {CV_ARM64_PSTATE,     "pstate", (DWORD_PTR*)FIELD_OFFSET(CONTEXT, PState), dbg_itype_unsigned_long_int},
142     {0,                   NULL,     0,                                         dbg_itype_none}
143 };
144
145 static unsigned be_arm64_is_step_over_insn(const void* insn)
146 {
147     dbg_printf("be_arm64_is_step_over_insn: not done\n");
148     return FALSE;
149 }
150
151 static unsigned be_arm64_is_function_return(const void* insn)
152 {
153     dbg_printf("be_arm64_is_function_return: not done\n");
154     return FALSE;
155 }
156
157 static unsigned be_arm64_is_break_insn(const void* insn)
158 {
159     dbg_printf("be_arm64_is_break_insn: not done\n");
160     return FALSE;
161 }
162
163 static unsigned be_arm64_is_func_call(const void* insn, ADDRESS64* callee)
164 {
165     return FALSE;
166 }
167
168 static unsigned be_arm64_is_jump(const void* insn, ADDRESS64* jumpee)
169 {
170     return FALSE;
171 }
172
173 static unsigned be_arm64_insert_Xpoint(HANDLE hProcess, const struct be_process_io* pio,
174                                        CONTEXT* ctx, enum be_xpoint_type type,
175                                        void* addr, unsigned long* val, unsigned size)
176 {
177     SIZE_T              sz;
178
179     switch (type)
180     {
181     case be_xpoint_break:
182         if (!size) return 0;
183         if (!pio->read(hProcess, addr, val, 4, &sz) || sz != 4) return 0;
184     default:
185         dbg_printf("Unknown/unsupported bp type %c\n", type);
186         return 0;
187     }
188     return 1;
189 }
190
191 static unsigned be_arm64_remove_Xpoint(HANDLE hProcess, const struct be_process_io* pio,
192                                        CONTEXT* ctx, enum be_xpoint_type type,
193                                        void* addr, unsigned long val, unsigned size)
194 {
195     SIZE_T              sz;
196
197     switch (type)
198     {
199     case be_xpoint_break:
200         if (!size) return 0;
201         if (!pio->write(hProcess, addr, &val, 4, &sz) || sz == 4) return 0;
202         break;
203     default:
204         dbg_printf("Unknown/unsupported bp type %c\n", type);
205         return 0;
206     }
207     return 1;
208 }
209
210 static unsigned be_arm64_is_watchpoint_set(const CONTEXT* ctx, unsigned idx)
211 {
212     dbg_printf("be_arm64_is_watchpoint_set: not done\n");
213     return FALSE;
214 }
215
216 static void be_arm64_clear_watchpoint(CONTEXT* ctx, unsigned idx)
217 {
218     dbg_printf("be_arm64_clear_watchpoint: not done\n");
219 }
220
221 static int be_arm64_adjust_pc_for_break(CONTEXT* ctx, BOOL way)
222 {
223     if (way)
224     {
225         ctx->Pc -= 4;
226         return -4;
227     }
228     ctx->Pc += 4;
229     return 4;
230 }
231
232 static int be_arm64_fetch_integer(const struct dbg_lvalue* lvalue, unsigned size,
233                                 unsigned ext_sign, LONGLONG* ret)
234 {
235     if (size != 1 && size != 2 && size != 4 && size != 8) return FALSE;
236
237     memset(ret, 0, sizeof(*ret)); /* clear unread bytes */
238     /* FIXME: this assumes that debuggee and debugger use the same
239      * integral representation
240      */
241     if (!memory_read_value(lvalue, size, ret)) return FALSE;
242
243     /* propagate sign information */
244     if (ext_sign && size < 8 && (*ret >> (size * 8 - 1)) != 0)
245     {
246         ULONGLONG neg = -1;
247         *ret |= neg << (size * 8);
248     }
249     return TRUE;
250 }
251
252 static int be_arm64_fetch_float(const struct dbg_lvalue* lvalue, unsigned size,
253                                 long double* ret)
254 {
255     char tmp[sizeof(long double)];
256
257     /* FIXME: this assumes that debuggee and debugger use the same
258      * representation for reals
259      */
260     if (!memory_read_value(lvalue, size, tmp)) return FALSE;
261
262     if (size == sizeof(float)) *ret = *(float*)tmp;
263     else if (size == sizeof(double)) *ret = *(double*)tmp;
264     else if (size == sizeof(long double)) *ret = *(long double*)tmp;
265     else return FALSE;
266
267     return TRUE;
268 }
269
270 static int be_arm64_store_integer(const struct dbg_lvalue* lvalue, unsigned size,
271                                   unsigned is_signed, LONGLONG val)
272 {
273     /* this is simple if we're on a little endian CPU */
274     return memory_write_value(lvalue, size, &val);
275 }
276
277 void be_arm64_disasm_one_insn(ADDRESS64 *addr, int display)
278 {
279     dbg_printf("be_arm64_disasm_one_insn: not done\n");
280 }
281
282 struct backend_cpu be_arm64 =
283 {
284     IMAGE_FILE_MACHINE_ARM64,
285     8,
286     be_cpu_linearize,
287     be_cpu_build_addr,
288     be_arm64_get_addr,
289     be_arm64_get_register_info,
290     be_arm64_single_step,
291     be_arm64_print_context,
292     be_arm64_print_segment_info,
293     be_arm64_ctx,
294     be_arm64_is_step_over_insn,
295     be_arm64_is_function_return,
296     be_arm64_is_break_insn,
297     be_arm64_is_func_call,
298     be_arm64_is_jump,
299     be_arm64_disasm_one_insn,
300     be_arm64_insert_Xpoint,
301     be_arm64_remove_Xpoint,
302     be_arm64_is_watchpoint_set,
303     be_arm64_clear_watchpoint,
304     be_arm64_adjust_pc_for_break,
305     be_arm64_fetch_integer,
306     be_arm64_fetch_float,
307     be_arm64_store_integer,
308 };
309 #endif