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
28 #define WIN32_NO_STATUS
29 #define WIN32_LEAN_AND_MEAN
38 #include <wine/list.h>
40 #define ADDRSIZE (be_cpu->pointer_size)
41 #define ADDRWIDTH (ADDRSIZE * 2)
43 /* the debugger uses these exceptions for its internal use */
44 #define DEBUG_STATUS_OFFSET 0x80003000
45 #define DEBUG_STATUS_INTERNAL_ERROR (DEBUG_STATUS_OFFSET+0) /* something went wrong */
46 #define DEBUG_STATUS_NO_SYMBOL (DEBUG_STATUS_OFFSET+1) /* no symbol found in lookup */
47 #define DEBUG_STATUS_DIV_BY_ZERO (DEBUG_STATUS_OFFSET+2)
48 #define DEBUG_STATUS_BAD_TYPE (DEBUG_STATUS_OFFSET+3) /* no type found, when type was expected */
49 #define DEBUG_STATUS_NO_FIELD (DEBUG_STATUS_OFFSET+4) /* when dereferencing a struct, the field was not found */
50 #define DEBUG_STATUS_ABORT (DEBUG_STATUS_OFFSET+5) /* user aborted on going action */
51 #define DEBUG_STATUS_CANT_DEREF (DEBUG_STATUS_OFFSET+6) /* either not deref:able, or index out of bounds */
52 #define DEBUG_STATUS_NOT_AN_INTEGER (DEBUG_STATUS_OFFSET+7) /* requiring an integral value */
55 * Return values for symbol_get_function_line_status. Used to determine
56 * what to do when the 'step' command is given.
61 dbg_not_on_a_line_number
,
66 enum dbg_internal_types
68 dbg_itype_first
= 0xffffff00,
69 dbg_itype_unsigned_int
,
71 dbg_itype_signed_char_int
,
72 dbg_itype_unsigned_char_int
,
73 dbg_itype_unsigned_short_int
,
74 dbg_itype_signed_short_int
,
75 dbg_itype_unsigned_long_int
,
76 dbg_itype_signed_long_int
,
77 dbg_itype_unsigned_longlong_int
,
78 dbg_itype_signed_longlong_int
,
81 dbg_itype_short_real
, /* aka float */
82 dbg_itype_real
, /* aka double */
83 dbg_itype_long_real
, /* aka long double */
86 dbg_itype_segptr
, /* hack for segmented pointers */
87 dbg_itype_m128a
, /* 128-bit (XMM) registers */
88 dbg_itype_none
= 0xffffffff
91 /* type description (in the following order):
92 * - if 'id' is dbg_itype_none (whatever 'module' value), the type isn't known
93 * - if 'module' is 0, it's an internal type (id is one of dbg_itype...)
94 * - if 'module' is non 0, then 'id' is a type ID referring to module (loaded in
95 * dbghelp) which (linear) contains address 'module'.
103 struct dbg_lvalue
/* structure to hold left-values... */
105 int cookie
; /* DLV_??? */
106 /* DLV_TARGET references an address in debuggee's address space, whereas DLV_HOST
107 * references the winedbg's address space
109 # define DLV_TARGET 0xF00D
110 # define DLV_HOST 0x50DA
112 struct dbg_type type
;
117 dbg_exec_cont
, /* Continue execution */
118 dbg_exec_step_over_line
, /* Stepping over a call to next source line */
119 dbg_exec_step_into_line
, /* Step to next source line, stepping in if needed */
120 dbg_exec_step_over_insn
, /* Stepping over a call */
121 dbg_exec_step_into_insn
, /* Single-stepping an instruction */
122 dbg_exec_finish
, /* Single-step until we exit current frame */
124 EXEC_STEP_OVER_TRAMPOLINE
, /* Step over trampoline. Requires that we dig the real
125 * return value off the stack and set breakpoint there -
126 * not at the instr just after the call.
131 struct dbg_breakpoint
134 unsigned long enabled
: 1,
139 struct /* only used for watchpoints */
144 struct expr
* condition
;
147 /* used for C++ exceptions in msvcrt
149 * [0] CXX_FRAME_MAGIC
150 * [1] pointer to exception object
151 * [2] pointer to type
153 #define CXX_EXCEPTION 0xe06d7363
154 #define CXX_FRAME_MAGIC 0x19930520
156 /* Wine extension; Windows doesn't have a name for this code. This is an
157 undocumented exception understood by MS VC debugger, allowing the program
158 to name a particular thread. Search google.com or deja.com for "0x406d1388"
160 #define EXCEPTION_NAME_THREAD 0x406D1388
162 /* Helper structure */
163 typedef struct tagTHREADNAME_INFO
165 DWORD dwType
; /* Must be 0x1000 */
166 LPCSTR szName
; /* Pointer to name - limited to 9 bytes (8 characters + terminator) */
167 DWORD dwThreadID
; /* Thread ID (-1 = caller thread) */
168 DWORD dwFlags
; /* Reserved for future use. Must be zero. */
174 struct dbg_process
* process
;
178 enum dbg_exec_mode exec_mode
; /* mode the thread is run (step/run...) */
179 int exec_count
; /* count of mode operations */
180 ADDRESS_MODE addr_mode
; /* mode */
181 int stopped_xpoint
; /* xpoint on which the thread has stopped (-1 if none) */
182 struct dbg_breakpoint step_over_bp
;
184 BOOL in_exception
; /* TRUE if thread stopped with an exception */
185 BOOL first_chance
; /* TRUE if thread stopped with a first chance exception
186 * - only valid when in_exception is TRUE
188 EXCEPTION_RECORD excpt_record
; /* only valid when in_exception is TRUE */
192 ADDRESS64 addr_frame
;
193 ADDRESS64 addr_stack
;
195 DWORD_PTR linear_frame
;
196 DWORD_PTR linear_stack
;
197 CONTEXT context
; /* context we got out of stackwalk for this frame */
198 BOOL is_ctx_valid
; /* is the context above valid */
204 struct dbg_delayed_bp
219 #define MAX_BREAKPOINTS 100
225 const struct be_process_io
* process_io
;
227 const WCHAR
* imageName
;
229 BOOL continue_on_first_exception
: 1,
231 struct dbg_breakpoint bp
[MAX_BREAKPOINTS
];
233 struct dbg_delayed_bp
* delayed_bp
;
235 struct open_file_list
* source_ofiles
;
237 char source_current_file
[MAX_PATH
];
238 int source_start_line
;
242 /* describes the way the debugger interacts with a given process */
245 BOOL (*close_process
)(struct dbg_process
*, BOOL
);
246 BOOL (*read
)(HANDLE
, const void*, void*, SIZE_T
, SIZE_T
*);
247 BOOL (*write
)(HANDLE
, void*, const void*, SIZE_T
, SIZE_T
*);
248 BOOL (*get_selector
)(HANDLE
, DWORD
, LDT_ENTRY
*);
251 extern struct dbg_process
* dbg_curr_process
;
252 extern DWORD_PTR dbg_curr_pid
;
253 extern struct dbg_thread
* dbg_curr_thread
;
254 extern DWORD_PTR dbg_curr_tid
;
255 extern CONTEXT dbg_context
;
256 extern BOOL dbg_interactiveP
;
257 extern HANDLE dbg_houtput
;
259 struct dbg_internal_var
264 unsigned long typeid; /* always internal type */
267 enum sym_get_lval
{sglv_found
, sglv_unknown
, sglv_aborted
};
273 type_expr_udt_struct
,
275 type_expr_enumeration
280 enum type_expr_e type
;
281 unsigned deref_count
;
284 struct dbg_type type
;
289 enum dbg_start
{start_ok
, start_error_parse
, start_error_init
};
292 extern void break_set_xpoints(BOOL set
);
293 extern BOOL
break_add_break(const ADDRESS64
* addr
, BOOL verbose
, BOOL swbp
);
294 extern BOOL
break_add_break_from_lvalue(const struct dbg_lvalue
* value
, BOOL swbp
);
295 extern void break_add_break_from_id(const char* name
, int lineno
, BOOL swbp
);
296 extern void break_add_break_from_lineno(const char *filename
, int lineno
, BOOL swbp
);
297 extern void break_add_watch_from_lvalue(const struct dbg_lvalue
* lvalue
, BOOL is_write
);
298 extern void break_add_watch_from_id(const char* name
, BOOL is_write
);
299 extern void break_check_delayed_bp(void);
300 extern void break_delete_xpoint(int num
);
301 extern void break_delete_xpoints_from_module(DWORD64 base
);
302 extern void break_enable_xpoint(int num
, BOOL enable
);
303 extern void break_info(void);
304 extern void break_adjust_pc(ADDRESS64
* addr
, DWORD code
, BOOL first_chance
, BOOL
* is_break
);
305 extern BOOL
break_should_continue(ADDRESS64
* addr
, DWORD code
);
306 extern void break_suspend_execution(void);
307 extern void break_restart_execution(int count
);
308 extern int break_add_condition(int bpnum
, struct expr
* exp
);
311 extern int display_crash_dialog(void);
312 extern HANDLE
display_crash_details(HANDLE event
);
313 extern int msgbox_res_id(HWND hwnd
, UINT textId
, UINT captionId
, UINT uType
);
316 extern void parser_handle(HANDLE
);
317 extern int input_read_line(const char* pfx
, char* buffer
, int size
);
318 extern int input_fetch_entire_line(const char* pfx
, char** line
);
319 extern HANDLE
parser_generate_command_file(const char*, ...);
322 extern void lexeme_flush(void);
323 extern char* lexeme_alloc_size(int);
326 extern BOOL
display_print(void);
327 extern BOOL
display_add(struct expr
* exp
, int count
, char format
);
328 extern BOOL
display_delete(int displaynum
);
329 extern BOOL
display_info(void);
330 extern BOOL
display_enable(int displaynum
, int enable
);
333 extern void expr_free_all(void);
334 extern struct expr
* expr_alloc_internal_var(const char* name
);
335 extern struct expr
* expr_alloc_symbol(const char* name
);
336 extern struct expr
* expr_alloc_sconstant(long int val
);
337 extern struct expr
* expr_alloc_uconstant(long unsigned val
);
338 extern struct expr
* expr_alloc_string(const char* str
);
339 extern struct expr
* expr_alloc_binary_op(int oper
, struct expr
*, struct expr
*);
340 extern struct expr
* expr_alloc_unary_op(int oper
, struct expr
*);
341 extern struct expr
* expr_alloc_pstruct(struct expr
*, const char* element
);
342 extern struct expr
* expr_alloc_struct(struct expr
*, const char* element
);
343 extern struct expr
* expr_alloc_func_call(const char*, int nargs
, ...);
344 extern struct expr
* expr_alloc_typecast(struct type_expr_t
*, struct expr
*);
345 extern struct dbg_lvalue
expr_eval(struct expr
*);
346 extern struct expr
* expr_clone(const struct expr
* exp
, BOOL
*local_binding
);
347 extern BOOL
expr_free(struct expr
* exp
);
348 extern BOOL
expr_print(const struct expr
* exp
);
351 extern void print_help(void);
352 extern void info_help(void);
353 extern void info_win32_module(DWORD64 mod
);
354 extern void info_win32_class(HWND hWnd
, const char* clsName
);
355 extern void info_win32_window(HWND hWnd
, BOOL detailed
);
356 extern void info_win32_processes(void);
357 extern void info_win32_threads(void);
358 extern void info_win32_frame_exceptions(DWORD tid
);
359 extern void info_win32_virtual(DWORD pid
);
360 extern void info_win32_segments(DWORD start
, int length
);
361 extern void info_win32_exception(void);
362 extern void info_wine_dbg_channel(BOOL add
, const char* chnl
, const char* name
);
365 extern BOOL
memory_read_value(const struct dbg_lvalue
* lvalue
, DWORD size
, void* result
);
366 extern BOOL
memory_write_value(const struct dbg_lvalue
* val
, DWORD size
, void* value
);
367 extern void memory_examine(const struct dbg_lvalue
*lvalue
, int count
, char format
);
368 extern void* memory_to_linear_addr(const ADDRESS64
* address
);
369 extern BOOL
memory_get_current_pc(ADDRESS64
* address
);
370 extern BOOL
memory_get_current_stack(ADDRESS64
* address
);
371 extern BOOL
memory_get_string(struct dbg_process
* pcs
, void* addr
, BOOL in_debuggee
, BOOL unicode
, char* buffer
, int size
);
372 extern BOOL
memory_get_string_indirect(struct dbg_process
* pcs
, void* addr
, BOOL unicode
, WCHAR
* buffer
, int size
);
373 extern BOOL
memory_get_register(DWORD regno
, DWORD_PTR
** value
, char* buffer
, int len
);
374 extern void memory_disassemble(const struct dbg_lvalue
*, const struct dbg_lvalue
*, int instruction_count
);
375 extern BOOL
memory_disasm_one_insn(ADDRESS64
* addr
);
376 #define MAX_OFFSET_TO_STR_LEN 19
377 extern char* memory_offset_to_string(char *str
, DWORD64 offset
, unsigned mode
);
378 extern void print_bare_address(const ADDRESS64
* addr
);
379 extern void print_address(const ADDRESS64
* addr
, BOOLEAN with_line
);
380 extern void print_basic(const struct dbg_lvalue
* value
, char format
);
383 extern void source_list(IMAGEHLP_LINE64
* src1
, IMAGEHLP_LINE64
* src2
, int delta
);
384 extern void source_list_from_addr(const ADDRESS64
* addr
, int nlines
);
385 extern void source_show_path(void);
386 extern void source_add_path(const char* path
);
387 extern void source_nuke_path(struct dbg_process
* p
);
388 extern void source_free_files(struct dbg_process
* p
);
391 extern void stack_info(int len
);
392 extern void stack_backtrace(DWORD threadID
);
393 extern BOOL
stack_set_frame(int newframe
);
394 extern BOOL
stack_get_current_frame(IMAGEHLP_STACK_FRAME
* ihsf
);
395 extern BOOL
stack_get_register_frame(const struct dbg_internal_var
* div
, DWORD_PTR
** pval
);
396 extern unsigned stack_fetch_frames(const CONTEXT
* ctx
);
397 extern BOOL
stack_get_current_symbol(SYMBOL_INFO
* sym
);
400 extern enum sym_get_lval
symbol_get_lvalue(const char* name
, const int lineno
, struct dbg_lvalue
* addr
, BOOL bp_disp
);
401 extern void symbol_read_symtable(const char* filename
, unsigned long offset
);
402 extern enum dbg_line_status
symbol_get_function_line_status(const ADDRESS64
* addr
);
403 extern BOOL
symbol_get_line(const char* filename
, const char* func
, IMAGEHLP_LINE64
* ret
);
404 extern void symbol_info(const char* str
);
405 extern void symbol_print_local(const SYMBOL_INFO
* sym
, DWORD_PTR base
, BOOL detailed
);
406 extern BOOL
symbol_info_locals(void);
407 extern BOOL
symbol_is_local(const char* name
);
409 typedef enum sym_get_lval (*symbol_picker_t
)(const char* name
, const struct sgv_data
* sgv
,
410 struct dbg_lvalue
* rtn
);
411 extern symbol_picker_t symbol_current_picker
;
412 extern enum sym_get_lval
symbol_picker_interactive(const char* name
, const struct sgv_data
* sgv
,
413 struct dbg_lvalue
* rtn
);
414 extern enum sym_get_lval
symbol_picker_scoped(const char* name
, const struct sgv_data
* sgv
,
415 struct dbg_lvalue
* rtn
);
418 extern void dbg_run_debuggee(const char* args
);
419 extern void dbg_wait_next_exception(DWORD cont
, int count
, int mode
);
420 extern enum dbg_start
dbg_active_attach(int argc
, char* argv
[]);
421 extern enum dbg_start
dbg_active_launch(int argc
, char* argv
[]);
422 extern enum dbg_start
dbg_active_auto(int argc
, char* argv
[]);
423 extern enum dbg_start
dbg_active_minidump(int argc
, char* argv
[]);
424 extern void dbg_active_wait_for_first_exception(void);
425 extern BOOL
dbg_attach_debuggee(DWORD pid
, BOOL cofe
);
428 extern void minidump_write(const char*, const EXCEPTION_RECORD
*);
429 extern enum dbg_start
minidump_reload(int argc
, char* argv
[]);
432 extern enum dbg_start
tgt_module_load(const char* name
, BOOL keep
);
435 extern void print_value(const struct dbg_lvalue
* addr
, char format
, int level
);
436 extern BOOL
types_print_type(const struct dbg_type
*, BOOL details
);
437 extern BOOL
print_types(void);
438 extern long int types_extract_as_integer(const struct dbg_lvalue
*);
439 extern LONGLONG
types_extract_as_longlong(const struct dbg_lvalue
*, unsigned* psize
, BOOL
*pissigned
);
440 extern void types_extract_as_address(const struct dbg_lvalue
*, ADDRESS64
*);
441 extern BOOL
types_store_value(struct dbg_lvalue
* lvalue_to
, const struct dbg_lvalue
* lvalue_from
);
442 extern BOOL
types_udt_find_element(struct dbg_lvalue
* value
, const char* name
, long int* tmpbuf
);
443 extern BOOL
types_array_index(const struct dbg_lvalue
* value
, int index
, struct dbg_lvalue
* result
);
444 extern BOOL
types_get_info(const struct dbg_type
*, IMAGEHLP_SYMBOL_TYPE_INFO
, void*);
445 extern BOOL
types_get_real_type(struct dbg_type
* type
, DWORD
* tag
);
446 extern struct dbg_type
types_find_pointer(const struct dbg_type
* type
);
447 extern struct dbg_type
types_find_type(unsigned long linear
, const char* name
, enum SymTagEnum tag
);
450 extern void dbg_outputW(const WCHAR
* buffer
, int len
);
451 extern const char* dbg_W2A(const WCHAR
* buffer
, unsigned len
);
453 extern int dbg_printf(const char* format
, ...) __attribute__((format (printf
,1,2)));
455 extern int dbg_printf(const char* format
, ...);
457 extern const struct dbg_internal_var
* dbg_get_internal_var(const char*);
458 extern BOOL
dbg_interrupt_debuggee(void);
459 extern unsigned dbg_num_processes(void);
460 extern struct dbg_process
* dbg_add_process(const struct be_process_io
* pio
, DWORD pid
, HANDLE h
);
461 extern void dbg_set_process_name(struct dbg_process
* p
, const WCHAR
* name
);
462 extern struct dbg_process
* dbg_get_process(DWORD pid
);
463 extern struct dbg_process
* dbg_get_process_h(HANDLE handle
);
464 extern void dbg_del_process(struct dbg_process
* p
);
465 struct dbg_thread
* dbg_add_thread(struct dbg_process
* p
, DWORD tid
, HANDLE h
, void* teb
);
466 extern struct dbg_thread
* dbg_get_thread(struct dbg_process
* p
, DWORD tid
);
467 extern void dbg_del_thread(struct dbg_thread
* t
);
468 extern BOOL
dbg_init(HANDLE hProc
, const WCHAR
* in
, BOOL invade
);
469 extern BOOL
dbg_load_module(HANDLE hProc
, HANDLE hFile
, const WCHAR
* name
, DWORD_PTR base
, DWORD size
);
470 extern BOOL
dbg_get_debuggee_info(HANDLE hProcess
, IMAGEHLP_MODULE64
* imh_mod
);
471 extern void dbg_set_option(const char*, const char*);
472 extern void dbg_start_interactive(HANDLE hFile
);
473 extern void dbg_init_console(void);
476 extern int gdb_main(int argc
, char* argv
[]);
478 static inline BOOL
dbg_read_memory(const void* addr
, void* buffer
, size_t len
)
481 return dbg_curr_process
->process_io
->read(dbg_curr_process
->handle
, addr
, buffer
, len
, &rlen
) && len
== rlen
;
484 static inline BOOL
dbg_write_memory(void* addr
, const void* buffer
, size_t len
)
487 return dbg_curr_process
->process_io
->write(dbg_curr_process
->handle
, addr
, buffer
, len
, &wlen
) && len
== wlen
;
490 static inline void* dbg_heap_realloc(void* buffer
, size_t size
)
492 return (buffer
) ? HeapReAlloc(GetProcessHeap(), 0, buffer
, size
) :
493 HeapAlloc(GetProcessHeap(), 0, size
);
496 extern struct dbg_internal_var dbg_internal_vars
[];
498 #define DBG_IVARNAME(_var) dbg_internal_var_##_var
499 #define DBG_IVARSTRUCT(_var) dbg_internal_vars[DBG_IVARNAME(_var)]
500 #define DBG_IVAR(_var) (*(DBG_IVARSTRUCT(_var).pval))
501 #define INTERNAL_VAR(_var,_val,_ref,itype) DBG_IVARNAME(_var),
509 /* include CPU dependent bits */
512 #endif /* __WINE_DEBUGGER_H */