winedbg: Fix a typo in the comment.
[wine] / programs / winedbg / be_x86_64.c
1 /*
2  * Debugger x86_64 specific functions
3  *
4  * Copyright 2004 Vincent BĂ©ron
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(__x86_64__)
24
25 static unsigned be_x86_64_get_addr(HANDLE hThread, const CONTEXT* ctx, 
26                                  enum be_cpu_addr bca, ADDRESS64* addr)
27 {
28     addr->Mode = AddrModeFlat;
29     switch (bca)
30     {
31     case be_cpu_addr_pc:
32         addr->Segment = ctx->SegCs;
33         addr->Offset = ctx->Rip;
34         return TRUE;
35     case be_cpu_addr_stack:
36         addr->Segment = ctx->SegSs;
37         addr->Offset = ctx->Rsp;
38         return TRUE;
39     case be_cpu_addr_frame:
40         addr->Segment = ctx->SegSs;
41         addr->Offset = ctx->Rbp;
42         return TRUE;
43     default:
44         addr->Mode = -1;
45         return FALSE;
46     }
47 }
48
49 static unsigned be_x86_64_get_register_info(int regno, enum be_cpu_addr* kind)
50 {
51     /* this is true when running in 32bit mode... and wrong in 64 :-/ */
52     switch (regno)
53     {
54     case CV_AMD64_RIP: *kind = be_cpu_addr_pc; return TRUE;
55     case CV_AMD64_EBP: *kind = be_cpu_addr_frame; return TRUE;
56     case CV_AMD64_ESP: *kind = be_cpu_addr_stack; return TRUE;
57     }
58     return FALSE;
59 }
60
61 static void be_x86_64_single_step(CONTEXT* ctx, unsigned enable)
62 {
63     dbg_printf("not done single_step\n");
64 }
65
66 static void be_x86_64_print_context(HANDLE hThread, const CONTEXT* ctx,
67                                     int all_regs)
68 {
69     char *pt, buf[33];
70
71     dbg_printf("Register dump:\n");
72     strcpy(buf, "   - 00      - - - ");
73     pt = buf + strlen(buf) - 1;
74     if (ctx->EFlags & 0x00000001) *pt-- = 'C'; /* Carry Flag */
75     if (ctx->EFlags & 0x00000002) *pt-- = '1';
76     if (ctx->EFlags & 0x00000004) *pt-- = 'P'; /* Parity Flag */
77     if (ctx->EFlags & 0x00000008) *pt-- = '-';
78     if (ctx->EFlags & 0x00000010) *pt-- = 'A'; /* Auxiliary Carry Flag */
79     if (ctx->EFlags & 0x00000020) *pt-- = '-';
80     if (ctx->EFlags & 0x00000040) *pt-- = 'Z'; /* Zero Flag */
81     if (ctx->EFlags & 0x00000080) *pt-- = 'S'; /* Sign Flag */
82     if (ctx->EFlags & 0x00000100) *pt-- = 'T'; /* Trap/Trace Flag */
83     if (ctx->EFlags & 0x00000200) *pt-- = 'I'; /* Interrupt Enable Flag */
84     if (ctx->EFlags & 0x00000400) *pt-- = 'D'; /* Direction Indicator */
85     if (ctx->EFlags & 0x00000800) *pt-- = 'O'; /* Overflow flags */
86     if (ctx->EFlags & 0x00001000) *pt-- = '1'; /* I/O Privilege Level */
87     if (ctx->EFlags & 0x00002000) *pt-- = '1'; /* I/O Privilege Level */
88     if (ctx->EFlags & 0x00004000) *pt-- = 'N'; /* Nested Task Flag */
89     if (ctx->EFlags & 0x00008000) *pt-- = '-';
90     if (ctx->EFlags & 0x00010000) *pt-- = 'R'; /* Resume Flag */
91     if (ctx->EFlags & 0x00020000) *pt-- = 'V'; /* Virtual Mode Flag */
92     if (ctx->EFlags & 0x00040000) *pt-- = 'a'; /* Alignment Check Flag */
93
94     dbg_printf(" rip:%016lx rsp:%016lx rbp:%016lx eflags:%08x (%s)\n",
95                ctx->Rip, ctx->Rsp, ctx->Rbp, ctx->EFlags, buf);
96     dbg_printf(" rax:%016lx rbx:%016lx rcx:%016lx rdx:%016lx\n",
97                ctx->Rax, ctx->Rbx, ctx->Rcx, ctx->Rdx);
98     dbg_printf(" rsi:%016lx rdi:%016lx  r8:%016lx  r9:%016lx r10:%016lx\n",
99                ctx->Rsi, ctx->Rdi, ctx->R8, ctx->R9, ctx->R10 );
100     dbg_printf(" r11:%016lx r12:%016lx r13:%016lx r14:%016lx r15:%016lx\n",
101                ctx->R11, ctx->R12, ctx->R13, ctx->R14, ctx->R15 );
102
103     if (all_regs) dbg_printf( "Floating point x86_64 dump not implemented\n" );
104 }
105
106 static void be_x86_64_print_segment_info(HANDLE hThread, const CONTEXT* ctx)
107 {
108 }
109
110 static struct dbg_internal_var be_x86_64_ctx[] =
111 {
112     {CV_AMD64_AL,       "AL",           (DWORD*)FIELD_OFFSET(CONTEXT, Rax),     dbg_itype_unsigned_char_int},
113     {CV_AMD64_BL,       "BL",           (DWORD*)FIELD_OFFSET(CONTEXT, Rbx),     dbg_itype_unsigned_char_int},
114     {CV_AMD64_CL,       "CL",           (DWORD*)FIELD_OFFSET(CONTEXT, Rcx),     dbg_itype_unsigned_char_int},
115     {CV_AMD64_DL,       "DL",           (DWORD*)FIELD_OFFSET(CONTEXT, Rdx),     dbg_itype_unsigned_char_int},
116     {CV_AMD64_AH,       "AH",           (DWORD*)(FIELD_OFFSET(CONTEXT, Rax)+1), dbg_itype_unsigned_char_int},
117     {CV_AMD64_BH,       "BH",           (DWORD*)(FIELD_OFFSET(CONTEXT, Rbx)+1), dbg_itype_unsigned_char_int},
118     {CV_AMD64_CH,       "CH",           (DWORD*)(FIELD_OFFSET(CONTEXT, Rcx)+1), dbg_itype_unsigned_char_int},
119     {CV_AMD64_DH,       "DH",           (DWORD*)(FIELD_OFFSET(CONTEXT, Rdx)+1), dbg_itype_unsigned_char_int},
120     {CV_AMD64_AX,       "AX",           (DWORD*)FIELD_OFFSET(CONTEXT, Rax),     dbg_itype_unsigned_short_int},
121     {CV_AMD64_BX,       "BX",           (DWORD*)FIELD_OFFSET(CONTEXT, Rbx),     dbg_itype_unsigned_short_int},
122     {CV_AMD64_CX,       "CX",           (DWORD*)FIELD_OFFSET(CONTEXT, Rcx),     dbg_itype_unsigned_short_int},
123     {CV_AMD64_DX,       "DX",           (DWORD*)FIELD_OFFSET(CONTEXT, Rdx),     dbg_itype_unsigned_short_int},
124     {CV_AMD64_SP,       "SP",           (DWORD*)FIELD_OFFSET(CONTEXT, Rsp),     dbg_itype_unsigned_short_int},
125     {CV_AMD64_BP,       "BP",           (DWORD*)FIELD_OFFSET(CONTEXT, Rbp),     dbg_itype_unsigned_short_int},
126     {CV_AMD64_SI,       "SI",           (DWORD*)FIELD_OFFSET(CONTEXT, Rsi),     dbg_itype_unsigned_short_int},
127     {CV_AMD64_DI,       "DI",           (DWORD*)FIELD_OFFSET(CONTEXT, Rdi),     dbg_itype_unsigned_short_int},
128     {CV_AMD64_EAX,      "EAX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rax),     dbg_itype_unsigned_int},
129     {CV_AMD64_EBX,      "EBX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rbx),     dbg_itype_unsigned_int},
130     {CV_AMD64_ECX,      "ECX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rcx),     dbg_itype_unsigned_int},
131     {CV_AMD64_EDX,      "EDX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rdx),     dbg_itype_unsigned_int},
132     {CV_AMD64_ESP,      "ESP",          (DWORD*)FIELD_OFFSET(CONTEXT, Rsp),     dbg_itype_unsigned_int},
133     {CV_AMD64_EBP,      "EBP",          (DWORD*)FIELD_OFFSET(CONTEXT, Rbp),     dbg_itype_unsigned_int},
134     {CV_AMD64_ESI,      "ESI",          (DWORD*)FIELD_OFFSET(CONTEXT, Rsi),     dbg_itype_unsigned_int},
135     {CV_AMD64_EDI,      "EDI",          (DWORD*)FIELD_OFFSET(CONTEXT, Rdi),     dbg_itype_unsigned_int},
136     {CV_AMD64_ES,       "ES",           (DWORD*)FIELD_OFFSET(CONTEXT, SegEs),   dbg_itype_unsigned_short_int},
137     {CV_AMD64_CS,       "CS",           (DWORD*)FIELD_OFFSET(CONTEXT, SegCs),   dbg_itype_unsigned_short_int},
138     {CV_AMD64_SS,       "SS",           (DWORD*)FIELD_OFFSET(CONTEXT, SegSs),   dbg_itype_unsigned_short_int},
139     {CV_AMD64_DS,       "DS",           (DWORD*)FIELD_OFFSET(CONTEXT, SegDs),   dbg_itype_unsigned_short_int},
140     {CV_AMD64_FS,       "FS",           (DWORD*)FIELD_OFFSET(CONTEXT, SegFs),   dbg_itype_unsigned_short_int},
141     {CV_AMD64_GS,       "GS",           (DWORD*)FIELD_OFFSET(CONTEXT, SegGs),   dbg_itype_unsigned_short_int},
142     {CV_AMD64_FLAGS,    "FLAGS",        (DWORD*)FIELD_OFFSET(CONTEXT, EFlags),  dbg_itype_unsigned_short_int},
143     {CV_AMD64_EFLAGS,   "EFLAGS",       (DWORD*)FIELD_OFFSET(CONTEXT, EFlags),  dbg_itype_unsigned_int},
144     {CV_AMD64_RIP,      "RIP",          (DWORD*)FIELD_OFFSET(CONTEXT, Rip),     dbg_itype_unsigned_int},
145     {CV_AMD64_RAX,      "RAX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rax),     dbg_itype_unsigned_long_int},
146     {CV_AMD64_RBX,      "RBX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rbx),     dbg_itype_unsigned_long_int},
147     {CV_AMD64_RCX,      "RCX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rcx),     dbg_itype_unsigned_long_int},
148     {CV_AMD64_RDX,      "RDX",          (DWORD*)FIELD_OFFSET(CONTEXT, Rdx),     dbg_itype_unsigned_long_int},
149     {CV_AMD64_RSP,      "RSP",          (DWORD*)FIELD_OFFSET(CONTEXT, Rsp),     dbg_itype_unsigned_long_int},
150     {CV_AMD64_RBP,      "RBP",          (DWORD*)FIELD_OFFSET(CONTEXT, Rbp),     dbg_itype_unsigned_long_int},
151     {CV_AMD64_RSI,      "RSI",          (DWORD*)FIELD_OFFSET(CONTEXT, Rsi),     dbg_itype_unsigned_long_int},
152     {CV_AMD64_RDI,      "RDI",          (DWORD*)FIELD_OFFSET(CONTEXT, Rdi),     dbg_itype_unsigned_long_int},
153     {CV_AMD64_R8,       "R8",           (DWORD*)FIELD_OFFSET(CONTEXT, R8),      dbg_itype_unsigned_long_int},
154     {CV_AMD64_R9,       "R9",           (DWORD*)FIELD_OFFSET(CONTEXT, R9),      dbg_itype_unsigned_long_int},
155     {CV_AMD64_R10,      "R10",          (DWORD*)FIELD_OFFSET(CONTEXT, R10),     dbg_itype_unsigned_long_int},
156     {CV_AMD64_R11,      "R11",          (DWORD*)FIELD_OFFSET(CONTEXT, R11),     dbg_itype_unsigned_long_int},
157     {CV_AMD64_R12,      "R12",          (DWORD*)FIELD_OFFSET(CONTEXT, R12),     dbg_itype_unsigned_long_int},
158     {CV_AMD64_R13,      "R13",          (DWORD*)FIELD_OFFSET(CONTEXT, R13),     dbg_itype_unsigned_long_int},
159     {CV_AMD64_R14,      "R14",          (DWORD*)FIELD_OFFSET(CONTEXT, R14),     dbg_itype_unsigned_long_int},
160     {CV_AMD64_R15,      "R15",          (DWORD*)FIELD_OFFSET(CONTEXT, R15),     dbg_itype_unsigned_long_int},
161     {0,                 NULL,           0,                                      dbg_itype_none}
162 };
163
164 static const struct dbg_internal_var* be_x86_64_init_registers(CONTEXT* ctx)
165 {
166     struct dbg_internal_var*    div;
167
168     for (div = be_x86_64_ctx; div->name; div++)
169         div->pval = (DWORD*)((char*)ctx + (DWORD_PTR)div->pval);
170     return be_x86_64_ctx;
171 }
172
173 static unsigned be_x86_64_is_step_over_insn(const void* insn)
174 {
175     dbg_printf("not done step_over_insn\n");
176     return FALSE;
177 }
178
179 static unsigned be_x86_64_is_function_return(const void* insn)
180 {
181     dbg_printf("not done is_function_return\n");
182     return FALSE;
183 }
184
185 static unsigned be_x86_64_is_break_insn(const void* insn)
186 {
187     dbg_printf("not done is_break_insn\n");
188     return FALSE;
189 }
190
191 static unsigned be_x86_64_is_func_call(const void* insn, ADDRESS64* callee)
192 {
193     dbg_printf("not done is_func_call\n");
194     return FALSE;
195 }
196
197 static void be_x86_64_disasm_one_insn(ADDRESS64* addr, int display)
198 {
199     dbg_printf("Disasm NIY\n");
200 }
201
202 static unsigned be_x86_64_insert_Xpoint(HANDLE hProcess, const struct be_process_io* pio,
203                                        CONTEXT* ctx, enum be_xpoint_type type,
204                                        void* addr, unsigned long* val, unsigned size)
205 {
206     dbg_printf("not done insert_Xpoint\n");
207     return 0;
208 }
209
210 static unsigned be_x86_64_remove_Xpoint(HANDLE hProcess, const struct be_process_io* pio,
211                                        CONTEXT* ctx, enum be_xpoint_type type, 
212                                        void* addr, unsigned long val, unsigned size)
213 {
214     dbg_printf("not done remove_Xpoint\n");
215     return FALSE;
216 }
217
218 static unsigned be_x86_64_is_watchpoint_set(const CONTEXT* ctx, unsigned idx)
219 {
220     dbg_printf("not done is_watchpoint_set\n");
221     return FALSE;
222 }
223
224 static void be_x86_64_clear_watchpoint(CONTEXT* ctx, unsigned idx)
225 {
226     dbg_printf("not done clear_watchpoint\n");
227 }
228
229 static int be_x86_64_adjust_pc_for_break(CONTEXT* ctx, BOOL way)
230 {
231     if (way)
232     {
233         ctx->Rip--;
234         return -1;
235     }
236     ctx->Rip++;
237     return 1;
238 }
239
240 static int be_x86_64_fetch_integer(const struct dbg_lvalue* lvalue, unsigned size,
241                                   unsigned ext_sign, LONGLONG* ret)
242 {
243     dbg_printf("not done fetch_integer\n");
244     return FALSE;
245 }
246
247 static int be_x86_64_fetch_float(const struct dbg_lvalue* lvalue, unsigned size, 
248                                 long double* ret)
249 {
250     dbg_printf("not done fetch_float\n");
251     return FALSE;
252 }
253
254 struct backend_cpu be_x86_64 =
255 {
256     be_cpu_linearize,
257     be_cpu_build_addr,
258     be_x86_64_get_addr,
259     be_x86_64_get_register_info,
260     be_x86_64_single_step,
261     be_x86_64_print_context,
262     be_x86_64_print_segment_info,
263     be_x86_64_init_registers,
264     be_x86_64_is_step_over_insn,
265     be_x86_64_is_function_return,
266     be_x86_64_is_break_insn,
267     be_x86_64_is_func_call,
268     be_x86_64_disasm_one_insn,
269     be_x86_64_insert_Xpoint,
270     be_x86_64_remove_Xpoint,
271     be_x86_64_is_watchpoint_set,
272     be_x86_64_clear_watchpoint,
273     be_x86_64_adjust_pc_for_break,
274     be_x86_64_fetch_integer,
275     be_x86_64_fetch_float,
276 };
277 #endif