Release 1.2-rc6.
[wine/gsoc-2012-control.git] / programs / winedbg / debugger.h
blobae949f26c7e5381fd6d11fc7bde48beca1c413d4
1 /*
2 * Debugger definitions
4 * Copyright 1995 Alexandre Julliard
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.
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.
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
21 #ifndef __WINE_DEBUGGER_H
22 #define __WINE_DEBUGGER_H
24 #include <assert.h>
25 #include <stdarg.h>
27 #define NONAMELESSUNION
28 #define NONAMELESSSTRUCT
29 #include "ntstatus.h"
30 #define WIN32_NO_STATUS
31 #define WIN32_LEAN_AND_MEAN
32 #include "windef.h"
33 #include "winbase.h"
34 #include "winver.h"
35 #include "winternl.h"
36 #include "dbghelp.h"
37 #include "cvconst.h"
38 #include "objbase.h"
39 #include "oaidl.h"
40 #include <wine/list.h>
42 #define ADDRSIZE (be_cpu->pointer_size)
43 #define ADDRWIDTH (ADDRSIZE * 2)
45 /* the debugger uses these exceptions for it's internal use */
46 #define DEBUG_STATUS_OFFSET 0x80003000
47 #define DEBUG_STATUS_INTERNAL_ERROR (DEBUG_STATUS_OFFSET+0) /* something went wrong */
48 #define DEBUG_STATUS_NO_SYMBOL (DEBUG_STATUS_OFFSET+1) /* no symbol found in lookup */
49 #define DEBUG_STATUS_DIV_BY_ZERO (DEBUG_STATUS_OFFSET+2)
50 #define DEBUG_STATUS_BAD_TYPE (DEBUG_STATUS_OFFSET+3) /* no type found, when type was expected */
51 #define DEBUG_STATUS_NO_FIELD (DEBUG_STATUS_OFFSET+4) /* when dereferencing a struct, the field was not found */
52 #define DEBUG_STATUS_ABORT (DEBUG_STATUS_OFFSET+5) /* user aborted on going action */
53 #define DEBUG_STATUS_CANT_DEREF (DEBUG_STATUS_OFFSET+6) /* either not deref:able, or index out of bounds */
54 #define DEBUG_STATUS_NOT_AN_INTEGER (DEBUG_STATUS_OFFSET+7) /* requiring an integral value */
57 * Return values for symbol_get_function_line_status. Used to determine
58 * what to do when the 'step' command is given.
60 enum dbg_line_status
62 dbg_no_line_info,
63 dbg_not_on_a_line_number,
64 dbg_on_a_line_number,
65 dbg_in_a_thunk,
68 enum dbg_internal_types
70 dbg_itype_first = 0xffffff00,
71 dbg_itype_unsigned_int,
72 dbg_itype_signed_int,
73 dbg_itype_signed_char_int,
74 dbg_itype_unsigned_char_int,
75 dbg_itype_unsigned_short_int,
76 dbg_itype_signed_short_int,
77 dbg_itype_unsigned_long_int,
78 dbg_itype_signed_long_int,
79 dbg_itype_unsigned_longlong_int,
80 dbg_itype_signed_longlong_int,
81 dbg_itype_char,
82 dbg_itype_wchar,
83 dbg_itype_short_real, /* aka float */
84 dbg_itype_real, /* aka double */
85 dbg_itype_long_real, /* aka long double */
86 dbg_itype_astring,
87 dbg_itype_ustring,
88 dbg_itype_segptr, /* hack for segmented pointers */
89 dbg_itype_none = 0xffffffff
92 /* type description (in the following order):
93 * - if 'id' is dbg_itype_none (whatever 'module' value), the type isn't known
94 * - if 'module' is 0, it's an internal type (id is one of dbg_itype...)
95 * - if 'module' is non 0, then 'id' is a type ID referring to module (loaded in
96 * dbghelp) which (linear) contains address 'module'.
98 struct dbg_type
100 unsigned long id;
101 DWORD_PTR module;
104 struct dbg_lvalue /* structure to hold left-values... */
106 int cookie; /* DLV_??? */
107 /* DLV_TARGET references an address in debuggee's address space, whereas DLV_HOST
108 * references the winedbg's address space
110 # define DLV_TARGET 0xF00D
111 # define DLV_HOST 0x50DA
112 ADDRESS64 addr;
113 struct dbg_type type;
116 enum dbg_exec_mode
118 dbg_exec_cont, /* Continue execution */
119 dbg_exec_step_over_line, /* Stepping over a call to next source line */
120 dbg_exec_step_into_line, /* Step to next source line, stepping in if needed */
121 dbg_exec_step_over_insn, /* Stepping over a call */
122 dbg_exec_step_into_insn, /* Single-stepping an instruction */
123 dbg_exec_finish, /* Single-step until we exit current frame */
124 #if 0
125 EXEC_STEP_OVER_TRAMPOLINE, /* Step over trampoline. Requires that we dig the real
126 * return value off the stack and set breakpoint there -
127 * not at the instr just after the call.
129 #endif
132 struct dbg_breakpoint
134 ADDRESS64 addr;
135 unsigned long enabled : 1,
136 xpoint_type : 2,
137 refcount : 13,
138 skipcount : 16;
139 unsigned long info;
140 struct /* only used for watchpoints */
142 BYTE len : 2;
143 DWORD64 oldval;
144 } w;
145 struct expr* condition;
148 /* used for C++ exceptions in msvcrt
149 * parameters:
150 * [0] CXX_FRAME_MAGIC
151 * [1] pointer to exception object
152 * [2] pointer to type
154 #define CXX_EXCEPTION 0xe06d7363
155 #define CXX_FRAME_MAGIC 0x19930520
157 /* Wine extension; Windows doesn't have a name for this code. This is an
158 undocumented exception understood by MS VC debugger, allowing the program
159 to name a particular thread. Search google.com or deja.com for "0x406d1388"
160 for more info. */
161 #define EXCEPTION_NAME_THREAD 0x406D1388
163 /* Helper structure */
164 typedef struct tagTHREADNAME_INFO
166 DWORD dwType; /* Must be 0x1000 */
167 LPCSTR szName; /* Pointer to name - limited to 9 bytes (8 characters + terminator) */
168 DWORD dwThreadID; /* Thread ID (-1 = caller thread) */
169 DWORD dwFlags; /* Reserved for future use. Must be zero. */
170 } THREADNAME_INFO;
172 struct dbg_thread
174 struct list entry;
175 struct dbg_process* process;
176 HANDLE handle;
177 DWORD tid;
178 void* teb;
179 enum dbg_exec_mode exec_mode; /* mode the thread is run (step/run...) */
180 int exec_count; /* count of mode operations */
181 ADDRESS_MODE addr_mode; /* mode */
182 int stopped_xpoint; /* xpoint on which the thread has stopped (-1 if none) */
183 struct dbg_breakpoint step_over_bp;
184 char name[9];
185 BOOL in_exception; /* TRUE if thread stopped with an exception */
186 EXCEPTION_RECORD excpt_record; /* only valid when in_exception is TRUE */
187 struct
189 ADDRESS64 addr_pc;
190 ADDRESS64 addr_frame;
191 ADDRESS64 addr_stack;
192 DWORD_PTR linear_pc;
193 DWORD_PTR linear_frame;
194 DWORD_PTR linear_stack;
195 CONTEXT context; /* context we got out of stackwalk for this frame */
196 BOOL is_ctx_valid; /* is the context above valid */
197 }* frames;
198 int num_frames;
199 int curr_frame;
202 struct dbg_delayed_bp
204 BOOL is_symbol;
205 BOOL software_bp;
206 union
208 struct
210 int lineno;
211 char* name;
212 } symbol;
213 ADDRESS64 addr;
214 } u;
217 #define MAX_BREAKPOINTS 100
218 struct dbg_process
220 struct list entry;
221 HANDLE handle;
222 DWORD pid;
223 const struct be_process_io* process_io;
224 void* pio_data;
225 const WCHAR* imageName;
226 struct list threads;
227 unsigned continue_on_first_exception : 1,
228 active_debuggee : 1;
229 struct dbg_breakpoint bp[MAX_BREAKPOINTS];
230 unsigned next_bp;
231 struct dbg_delayed_bp* delayed_bp;
232 int num_delayed_bp;
233 struct open_file_list* source_ofiles;
234 char* search_path;
235 char source_current_file[MAX_PATH];
236 int source_start_line;
237 int source_end_line;
240 /* describes the way the debugger interacts with a given process */
241 struct be_process_io
243 BOOL (*close_process)(struct dbg_process*, BOOL);
244 BOOL (*read)(HANDLE, const void*, void*, SIZE_T, SIZE_T*);
245 BOOL (*write)(HANDLE, void*, const void*, SIZE_T, SIZE_T*);
246 BOOL (*get_selector)(HANDLE, DWORD, LDT_ENTRY*);
249 extern struct dbg_process* dbg_curr_process;
250 extern DWORD_PTR dbg_curr_pid;
251 extern struct dbg_thread* dbg_curr_thread;
252 extern DWORD_PTR dbg_curr_tid;
253 extern CONTEXT dbg_context;
254 extern BOOL dbg_interactiveP;
256 struct dbg_internal_var
258 DWORD_PTR val;
259 const char* name;
260 DWORD_PTR *pval;
261 unsigned long typeid; /* always internal type */
264 enum sym_get_lval {sglv_found, sglv_unknown, sglv_aborted};
266 enum type_expr_e
268 type_expr_type_id,
269 type_expr_udt_class,
270 type_expr_udt_struct,
271 type_expr_udt_union,
272 type_expr_enumeration
275 struct type_expr_t
277 enum type_expr_e type;
278 unsigned deref_count;
279 union
281 struct dbg_type type;
282 const char* name;
283 } u;
286 enum dbg_start {start_ok, start_error_parse, start_error_init};
288 /* break.c */
289 extern void break_set_xpoints(BOOL set);
290 extern BOOL break_add_break(const ADDRESS64* addr, BOOL verbose, BOOL swbp);
291 extern BOOL break_add_break_from_lvalue(const struct dbg_lvalue* value, BOOL swbp);
292 extern void break_add_break_from_id(const char* name, int lineno, BOOL swbp);
293 extern void break_add_break_from_lineno(int lineno, BOOL swbp);
294 extern void break_add_watch_from_lvalue(const struct dbg_lvalue* lvalue);
295 extern void break_add_watch_from_id(const char* name);
296 extern void break_check_delayed_bp(void);
297 extern void break_delete_xpoint(int num);
298 extern void break_delete_xpoints_from_module(DWORD64 base);
299 extern void break_enable_xpoint(int num, BOOL enable);
300 extern void break_info(void);
301 extern void break_adjust_pc(ADDRESS64* addr, DWORD code, BOOL first_chance, BOOL* is_break);
302 extern BOOL break_should_continue(ADDRESS64* addr, DWORD code);
303 extern void break_suspend_execution(void);
304 extern void break_restart_execution(int count);
305 extern int break_add_condition(int bpnum, struct expr* exp);
307 /* crashdlg.c */
308 extern BOOL display_crash_dialog(void);
309 extern int msgbox_res_id(HWND hwnd, UINT textId, UINT captionId, UINT uType);
311 /* dbg.y */
312 extern void parser_handle(HANDLE);
313 extern int input_read_line(const char* pfx, char* buffer, int size);
314 extern int input_fetch_entire_line(const char* pfx, char** line);
315 extern HANDLE parser_generate_command_file(const char*, ...);
317 /* debug.l */
318 extern void lexeme_flush(void);
319 extern char* lexeme_alloc_size(int);
321 /* display.c */
322 extern int display_print(void);
323 extern int display_add(struct expr* exp, int count, char format);
324 extern int display_delete(int displaynum);
325 extern int display_info(void);
326 extern int display_enable(int displaynum, int enable);
328 /* expr.c */
329 extern void expr_free_all(void);
330 extern struct expr* expr_alloc_internal_var(const char* name);
331 extern struct expr* expr_alloc_symbol(const char* name);
332 extern struct expr* expr_alloc_sconstant(long int val);
333 extern struct expr* expr_alloc_uconstant(long unsigned val);
334 extern struct expr* expr_alloc_string(const char* str);
335 extern struct expr* expr_alloc_binary_op(int oper, struct expr*, struct expr*);
336 extern struct expr* expr_alloc_unary_op(int oper, struct expr*);
337 extern struct expr* expr_alloc_pstruct(struct expr*, const char* element);
338 extern struct expr* expr_alloc_struct(struct expr*, const char* element);
339 extern struct expr* expr_alloc_func_call(const char*, int nargs, ...);
340 extern struct expr* expr_alloc_typecast(struct type_expr_t*, struct expr*);
341 extern struct dbg_lvalue expr_eval(struct expr*);
342 extern struct expr* expr_clone(const struct expr* exp, BOOL *local_binding);
343 extern int expr_free(struct expr* exp);
344 extern int expr_print(const struct expr* exp);
346 /* info.c */
347 extern void print_help(void);
348 extern void info_help(void);
349 extern void info_win32_module(DWORD64 mod);
350 extern void info_win32_class(HWND hWnd, const char* clsName);
351 extern void info_win32_window(HWND hWnd, BOOL detailed);
352 extern void info_win32_processes(void);
353 extern void info_win32_threads(void);
354 extern void info_win32_exceptions(DWORD tid);
355 extern void info_win32_virtual(DWORD pid);
356 extern void info_win32_segments(DWORD start, int length);
357 extern void info_wine_dbg_channel(BOOL add, const char* chnl, const char* name);
359 /* memory.c */
360 extern BOOL memory_read_value(const struct dbg_lvalue* lvalue, DWORD size, void* result);
361 extern BOOL memory_write_value(const struct dbg_lvalue* val, DWORD size, void* value);
362 extern void memory_examine(const struct dbg_lvalue *lvalue, int count, char format);
363 extern void* memory_to_linear_addr(const ADDRESS64* address);
364 extern BOOL memory_get_current_pc(ADDRESS64* address);
365 extern BOOL memory_get_current_stack(ADDRESS64* address);
366 extern BOOL memory_get_current_frame(ADDRESS64* address);
367 extern BOOL memory_get_string(struct dbg_process* pcs, void* addr, BOOL in_debuggee, BOOL unicode, char* buffer, int size);
368 extern BOOL memory_get_string_indirect(struct dbg_process* pcs, void* addr, BOOL unicode, WCHAR* buffer, int size);
369 extern BOOL memory_get_register(DWORD regno, DWORD_PTR** value, char* buffer, int len);
370 extern void memory_disassemble(const struct dbg_lvalue*, const struct dbg_lvalue*, int instruction_count);
371 extern BOOL memory_disasm_one_insn(ADDRESS64* addr);
372 #define MAX_OFFSET_TO_STR_LEN 19
373 extern char* memory_offset_to_string(char *str, DWORD64 offset, unsigned mode);
374 extern void print_bare_address(const ADDRESS64* addr);
375 extern void print_address(const ADDRESS64* addr, BOOLEAN with_line);
376 extern void print_basic(const struct dbg_lvalue* value, char format);
378 /* source.c */
379 extern void source_list(IMAGEHLP_LINE64* src1, IMAGEHLP_LINE64* src2, int delta);
380 extern void source_list_from_addr(const ADDRESS64* addr, int nlines);
381 extern void source_show_path(void);
382 extern void source_add_path(const char* path);
383 extern void source_nuke_path(struct dbg_process* p);
384 extern void source_free_files(struct dbg_process* p);
386 /* stack.c */
387 extern void stack_info(int len);
388 extern void stack_backtrace(DWORD threadID);
389 extern BOOL stack_set_frame(int newframe);
390 extern BOOL stack_get_current_frame(IMAGEHLP_STACK_FRAME* ihsf);
391 extern BOOL stack_get_register_frame(const struct dbg_internal_var* div, DWORD_PTR** pval);
392 extern unsigned stack_fetch_frames(const CONTEXT* ctx);
393 extern BOOL stack_get_current_symbol(SYMBOL_INFO* sym);
395 /* symbol.c */
396 extern enum sym_get_lval symbol_get_lvalue(const char* name, const int lineno, struct dbg_lvalue* addr, BOOL bp_disp);
397 extern void symbol_read_symtable(const char* filename, unsigned long offset);
398 extern enum dbg_line_status symbol_get_function_line_status(const ADDRESS64* addr);
399 extern BOOL symbol_get_line(const char* filename, const char* func, IMAGEHLP_LINE64* ret);
400 extern void symbol_info(const char* str);
401 extern void symbol_print_local(const SYMBOL_INFO* sym, DWORD_PTR base, BOOL detailed);
402 extern int symbol_info_locals(void);
403 extern BOOL symbol_is_local(const char* name);
404 struct sgv_data;
405 typedef enum sym_get_lval (*symbol_picker_t)(const char* name, const struct sgv_data* sgv,
406 struct dbg_lvalue* rtn);
407 extern symbol_picker_t symbol_current_picker;
408 extern enum sym_get_lval symbol_picker_interactive(const char* name, const struct sgv_data* sgv,
409 struct dbg_lvalue* rtn);
410 extern enum sym_get_lval symbol_picker_scoped(const char* name, const struct sgv_data* sgv,
411 struct dbg_lvalue* rtn);
413 /* tgt_active.c */
414 extern void dbg_run_debuggee(const char* args);
415 extern void dbg_wait_next_exception(DWORD cont, int count, int mode);
416 extern enum dbg_start dbg_active_attach(int argc, char* argv[]);
417 extern enum dbg_start dbg_active_launch(int argc, char* argv[]);
418 extern enum dbg_start dbg_active_auto(int argc, char* argv[]);
419 extern void dbg_active_wait_for_first_exception(void);
420 extern BOOL dbg_attach_debuggee(DWORD pid, BOOL cofe);
422 /* tgt_minidump.c */
423 extern void minidump_write(const char*, const EXCEPTION_RECORD*);
424 extern enum dbg_start minidump_reload(int argc, char* argv[]);
426 /* tgt_module.c */
427 extern enum dbg_start tgt_module_load(const char* name, BOOL keep);
429 /* types.c */
430 extern void print_value(const struct dbg_lvalue* addr, char format, int level);
431 extern int types_print_type(const struct dbg_type*, BOOL details);
432 extern int print_types(void);
433 extern long int types_extract_as_integer(const struct dbg_lvalue*);
434 extern LONGLONG types_extract_as_longlong(const struct dbg_lvalue*, unsigned* psize);
435 extern void types_extract_as_address(const struct dbg_lvalue*, ADDRESS64*);
436 extern BOOL types_udt_find_element(struct dbg_lvalue* value, const char* name, long int* tmpbuf);
437 extern BOOL types_array_index(const struct dbg_lvalue* value, int index, struct dbg_lvalue* result);
438 extern BOOL types_get_info(const struct dbg_type*, IMAGEHLP_SYMBOL_TYPE_INFO, void*);
439 extern BOOL types_get_real_type(struct dbg_type* type, DWORD* tag);
440 extern struct dbg_type types_find_pointer(const struct dbg_type* type);
441 extern struct dbg_type types_find_type(unsigned long linear, const char* name, enum SymTagEnum tag);
443 /* winedbg.c */
444 extern void dbg_outputW(const WCHAR* buffer, int len);
445 extern const char* dbg_W2A(const WCHAR* buffer, unsigned len);
446 #ifdef __GNUC__
447 extern int dbg_printf(const char* format, ...) __attribute__((format (printf,1,2)));
448 #else
449 extern int dbg_printf(const char* format, ...);
450 #endif
451 extern const struct dbg_internal_var* dbg_get_internal_var(const char*);
452 extern BOOL dbg_interrupt_debuggee(void);
453 extern unsigned dbg_num_processes(void);
454 extern struct dbg_process* dbg_add_process(const struct be_process_io* pio, DWORD pid, HANDLE h);
455 extern void dbg_set_process_name(struct dbg_process* p, const WCHAR* name);
456 extern struct dbg_process* dbg_get_process(DWORD pid);
457 extern struct dbg_process* dbg_get_process_h(HANDLE handle);
458 extern void dbg_del_process(struct dbg_process* p);
459 struct dbg_thread* dbg_add_thread(struct dbg_process* p, DWORD tid, HANDLE h, void* teb);
460 extern struct dbg_thread* dbg_get_thread(struct dbg_process* p, DWORD tid);
461 extern void dbg_del_thread(struct dbg_thread* t);
462 extern BOOL dbg_init(HANDLE hProc, const WCHAR* in, BOOL invade);
463 extern BOOL dbg_load_module(HANDLE hProc, HANDLE hFile, const WCHAR* name, DWORD_PTR base, DWORD size);
464 extern BOOL dbg_get_debuggee_info(HANDLE hProcess, IMAGEHLP_MODULE64* imh_mod);
465 extern void dbg_set_option(const char*, const char*);
466 extern void dbg_start_interactive(HANDLE hFile);
467 extern void dbg_init_console(void);
469 /* gdbproxy.c */
470 extern int gdb_main(int argc, char* argv[]);
472 static inline BOOL dbg_read_memory(const void* addr, void* buffer, size_t len)
474 SIZE_T rlen;
475 return dbg_curr_process->process_io->read(dbg_curr_process->handle, addr, buffer, len, &rlen) && len == rlen;
478 static inline BOOL dbg_write_memory(void* addr, const void* buffer, size_t len)
480 SIZE_T wlen;
481 return dbg_curr_process->process_io->write(dbg_curr_process->handle, addr, buffer, len, &wlen) && len == wlen;
484 static inline void* dbg_heap_realloc(void* buffer, size_t size)
486 return (buffer) ? HeapReAlloc(GetProcessHeap(), 0, buffer, size) :
487 HeapAlloc(GetProcessHeap(), 0, size);
490 extern struct dbg_internal_var dbg_internal_vars[];
492 #define DBG_IVARNAME(_var) dbg_internal_var_##_var
493 #define DBG_IVARSTRUCT(_var) dbg_internal_vars[DBG_IVARNAME(_var)]
494 #define DBG_IVAR(_var) (*(DBG_IVARSTRUCT(_var).pval))
495 #define INTERNAL_VAR(_var,_val,_ref,itype) DBG_IVARNAME(_var),
496 enum debug_int_var
498 #include "intvar.h"
499 DBG_IV_LAST
501 #undef INTERNAL_VAR
503 /* include CPU dependent bits */
504 #include "be_cpu.h"
506 #endif /* __WINE_DEBUGGER_H */