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
27 #define NONAMELESSUNION
28 #define NONAMELESSSTRUCT
30 #define WIN32_NO_STATUS
31 #define WIN32_LEAN_AND_MEAN
40 #include <wine/list.h>
42 #define ADDRSIZE (dbg_curr_process ? dbg_curr_process->be_cpu->pointer_size : (int)sizeof(void*))
43 #define ADDRWIDTH (ADDRSIZE * 2)
45 /* the debugger uses these exceptions for its 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.
63 dbg_not_on_a_line_number
,
68 enum dbg_internal_types
70 dbg_itype_first
= 0xffffff00,
71 dbg_itype_unsigned_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
,
82 /* they represent the dbg_lg(u)int_t types */
88 dbg_itype_short_real
, /* aka float */
89 dbg_itype_real
, /* aka double */
90 dbg_itype_long_real
, /* aka long double */
93 dbg_itype_segptr
, /* hack for segmented pointers */
94 dbg_itype_m128a
, /* 128-bit (XMM) registers */
95 dbg_itype_none
= 0xffffffff
98 /* Largest integers the debugger's compiler can support.
99 * It's large enough to store a pointer (in debuggee or debugger's address space).
100 * It can be smaller than the largest integer(s) of the debuggee.
101 * (eg. 64 bit on PE build of debugger, vs 128 int in ELF build of a library)
103 typedef LONG64 dbg_lgint_t
;
104 typedef ULONG64 dbg_lguint_t
;
106 /* type description (in the following order):
107 * - if 'id' is dbg_itype_none (whatever 'module' value), the type isn't known
108 * - if 'module' is 0, it's an internal type (id is one of dbg_itype...)
109 * - if 'module' is non 0, then 'id' is a type ID referring to module (loaded in
110 * dbghelp) which (linear) contains address 'module'.
118 struct dbg_lvalue
/* structure to hold left-values... */
120 unsigned in_debuggee
: 1, /* 1 = debuggee address space, 0 = debugger address space */
121 bitstart
: 8, /* in fact, 7 should be sufficient for underlying 128bit integers */
124 struct dbg_type type
;
127 static inline void init_lvalue(struct dbg_lvalue
* lv
, BOOL in_debuggee
, void* addr
)
129 lv
->in_debuggee
= !!in_debuggee
;
132 lv
->addr
.Mode
= AddrModeFlat
;
133 lv
->addr
.Offset
= (DWORD_PTR
)addr
;
135 lv
->type
.id
= dbg_itype_none
;
138 static inline void init_lvalue_in_debugger(struct dbg_lvalue
* lv
, enum dbg_internal_types it
, void* addr
)
143 lv
->addr
.Mode
= AddrModeFlat
;
144 lv
->addr
.Offset
= (DWORD_PTR
)addr
;
151 dbg_exec_cont
, /* Continue execution */
152 dbg_exec_step_over_line
, /* Stepping over a call to next source line */
153 dbg_exec_step_into_line
, /* Step to next source line, stepping in if needed */
154 dbg_exec_step_over_insn
, /* Stepping over a call */
155 dbg_exec_step_into_insn
, /* Single-stepping an instruction */
156 dbg_exec_finish
, /* Single-step until we exit current frame */
158 EXEC_STEP_OVER_TRAMPOLINE
, /* Step over trampoline. Requires that we dig the real
159 * return value off the stack and set breakpoint there -
160 * not at the instr just after the call.
165 struct dbg_breakpoint
168 unsigned int enabled
: 1,
173 struct /* only used for watchpoints */
178 struct expr
* condition
;
181 /* Helper structure */
182 typedef struct tagTHREADNAME_INFO
184 DWORD dwType
; /* Must be 0x1000 */
185 LPCSTR szName
; /* Pointer to name - limited to 9 bytes (8 characters + terminator) */
186 DWORD dwThreadID
; /* Thread ID (-1 = caller thread) */
187 DWORD dwFlags
; /* Reserved for future use. Must be zero. */
190 typedef union dbg_ctx
199 struct dbg_process
* process
;
203 enum dbg_exec_mode exec_mode
; /* mode the thread is run (step/run...) */
204 int exec_count
; /* count of mode operations */
205 ADDRESS_MODE addr_mode
; /* mode */
206 int stopped_xpoint
; /* xpoint on which the thread has stopped (-1 if none) */
207 struct dbg_breakpoint step_over_bp
;
209 BOOL in_exception
; /* TRUE if thread stopped with an exception */
210 BOOL first_chance
; /* TRUE if thread stopped with a first chance exception
211 * - only valid when in_exception is TRUE
213 EXCEPTION_RECORD excpt_record
; /* only valid when in_exception is TRUE */
217 ADDRESS64 addr_frame
;
218 ADDRESS64 addr_stack
;
220 DWORD_PTR linear_frame
;
221 DWORD_PTR linear_stack
;
222 dbg_ctx_t context
; /* context we got out of stackwalk for this frame */
224 BOOL is_ctx_valid
; /* is the context above valid */
231 struct dbg_delayed_bp
246 #define MAX_BREAKPOINTS 100
252 const struct be_process_io
* process_io
;
254 const WCHAR
* imageName
;
256 struct backend_cpu
* be_cpu
;
257 HANDLE event_on_first_exception
;
258 BOOL active_debuggee
;
259 struct dbg_breakpoint bp
[MAX_BREAKPOINTS
];
261 struct dbg_delayed_bp
* delayed_bp
;
263 struct open_file_list
* source_ofiles
;
265 char source_current_file
[MAX_PATH
];
266 int source_start_line
;
270 /* describes the way the debugger interacts with a given process */
273 BOOL (*close_process
)(struct dbg_process
*, BOOL
);
274 BOOL (*read
)(HANDLE
, const void*, void*, SIZE_T
, SIZE_T
*);
275 BOOL (*write
)(HANDLE
, void*, const void*, SIZE_T
, SIZE_T
*);
276 BOOL (*get_selector
)(HANDLE
, DWORD
, LDT_ENTRY
*);
279 extern struct dbg_process
* dbg_curr_process
;
280 extern DWORD dbg_curr_pid
;
281 extern struct dbg_thread
* dbg_curr_thread
;
282 extern DWORD dbg_curr_tid
;
283 extern dbg_ctx_t dbg_context
;
284 extern BOOL dbg_interactiveP
;
285 extern HANDLE dbg_houtput
;
287 struct dbg_internal_var
292 ULONG
typeid; /* always internal type */
295 enum sym_get_lval
{sglv_found
, sglv_unknown
, sglv_aborted
};
301 type_expr_udt_struct
,
303 type_expr_enumeration
308 enum type_expr_e type
;
309 unsigned deref_count
;
312 struct dbg_type type
;
317 enum dbg_start
{start_ok
, start_error_parse
, start_error_init
};
320 extern void break_set_xpoints(BOOL set
);
321 extern BOOL
break_add_break(const ADDRESS64
* addr
, BOOL verbose
, BOOL swbp
);
322 extern BOOL
break_add_break_from_lvalue(const struct dbg_lvalue
* value
, BOOL swbp
);
323 extern void break_add_break_from_id(const char* name
, int lineno
, BOOL swbp
);
324 extern void break_add_break_from_lineno(const char *filename
, int lineno
, BOOL swbp
);
325 extern void break_add_watch_from_lvalue(const struct dbg_lvalue
* lvalue
, BOOL is_write
);
326 extern void break_add_watch_from_id(const char* name
, BOOL is_write
);
327 extern void break_check_delayed_bp(void);
328 extern void break_delete_xpoint(int num
);
329 extern void break_delete_xpoints_from_module(DWORD64 base
);
330 extern void break_enable_xpoint(int num
, BOOL enable
);
331 extern void break_info(void);
332 extern void break_adjust_pc(ADDRESS64
* addr
, DWORD code
, BOOL first_chance
, BOOL
* is_break
);
333 extern BOOL
break_should_continue(ADDRESS64
* addr
, DWORD code
);
334 extern void break_suspend_execution(void);
335 extern void break_restart_execution(int count
);
336 extern int break_add_condition(int bpnum
, struct expr
* exp
);
339 extern int display_crash_dialog(void);
340 extern HANDLE
display_crash_details(HANDLE event
);
341 extern int msgbox_res_id(HWND hwnd
, UINT textId
, UINT captionId
, UINT uType
);
344 extern void parser_handle(const char*, HANDLE
);
345 extern int input_read_line(const char* pfx
, char* buffer
, int size
);
346 extern size_t input_lex_read_buffer(char* pfx
, int size
);
347 extern HANDLE WINAPIV
parser_generate_command_file(const char*, ...);
350 extern void lexeme_flush(void);
351 extern char* lexeme_alloc_size(int);
354 extern BOOL
display_print(void);
355 extern BOOL
display_add(struct expr
* exp
, int count
, char format
);
356 extern BOOL
display_delete(int displaynum
);
357 extern BOOL
display_info(void);
358 extern BOOL
display_enable(int displaynum
, int enable
);
361 extern void expr_free_all(void);
362 extern struct expr
* expr_alloc_internal_var(const char* name
);
363 extern struct expr
* expr_alloc_symbol(const char* name
);
364 extern struct expr
* expr_alloc_sconstant(dbg_lgint_t val
);
365 extern struct expr
* expr_alloc_uconstant(dbg_lguint_t val
);
366 extern struct expr
* expr_alloc_string(const char* str
);
367 extern struct expr
* expr_alloc_binary_op(int oper
, struct expr
*, struct expr
*);
368 extern struct expr
* expr_alloc_unary_op(int oper
, struct expr
*);
369 extern struct expr
* expr_alloc_pstruct(struct expr
*, const char* element
);
370 extern struct expr
* expr_alloc_struct(struct expr
*, const char* element
);
371 extern struct expr
* WINAPIV
expr_alloc_func_call(const char*, int nargs
, ...);
372 extern struct expr
* expr_alloc_typecast(struct type_expr_t
*, struct expr
*);
373 extern struct dbg_lvalue
expr_eval(struct expr
*);
374 extern struct expr
* expr_clone(const struct expr
* exp
, BOOL
*local_binding
);
375 extern BOOL
expr_free(struct expr
* exp
);
376 extern BOOL
expr_print(const struct expr
* exp
);
379 extern void print_help(void);
380 extern void info_help(void);
381 extern void info_win32_module(DWORD64 mod
);
382 extern void info_win32_class(HWND hWnd
, const char* clsName
);
383 extern void info_win32_window(HWND hWnd
, BOOL detailed
);
384 extern void info_win32_processes(void);
385 extern void info_win32_threads(void);
386 extern void info_win32_frame_exceptions(DWORD tid
);
387 extern void info_win32_virtual(DWORD pid
);
388 extern void info_win32_segments(DWORD start
, int length
);
389 extern void info_win32_exception(void);
390 extern void info_wine_dbg_channel(BOOL add
, const char* chnl
, const char* name
);
393 extern BOOL
memory_read_value(const struct dbg_lvalue
* lvalue
, DWORD size
, void* result
);
394 extern BOOL
memory_write_value(const struct dbg_lvalue
* val
, DWORD size
, void* value
);
395 extern BOOL
memory_fetch_integer(const struct dbg_lvalue
* lvalue
, unsigned size
,
396 BOOL is_signed
, dbg_lgint_t
* ret
);
397 extern BOOL
memory_store_integer(const struct dbg_lvalue
* lvalue
, dbg_lgint_t val
);
398 extern void memory_examine(const struct dbg_lvalue
*lvalue
, int count
, char format
);
399 extern void* memory_to_linear_addr(const ADDRESS64
* address
);
400 extern BOOL
memory_get_current_pc(ADDRESS64
* address
);
401 extern BOOL
memory_get_current_stack(ADDRESS64
* address
);
402 extern BOOL
memory_get_string(struct dbg_process
* pcs
, void* addr
, BOOL in_debuggee
, BOOL unicode
, char* buffer
, int size
);
403 extern BOOL
memory_get_string_indirect(struct dbg_process
* pcs
, void* addr
, BOOL unicode
, WCHAR
* buffer
, int size
);
404 extern BOOL
memory_get_register(DWORD regno
, DWORD_PTR
** value
, char* buffer
, int len
);
405 extern void memory_disassemble(const struct dbg_lvalue
*, const struct dbg_lvalue
*, int instruction_count
);
406 extern BOOL
memory_disasm_one_insn(ADDRESS64
* addr
);
407 #define MAX_OFFSET_TO_STR_LEN 19
408 extern char* memory_offset_to_string(char *str
, DWORD64 offset
, unsigned mode
);
409 extern void print_bare_address(const ADDRESS64
* addr
);
410 extern void print_address(const ADDRESS64
* addr
, BOOLEAN with_line
);
411 extern void print_basic(const struct dbg_lvalue
* value
, char format
);
414 extern void source_list(IMAGEHLP_LINE64
* src1
, IMAGEHLP_LINE64
* src2
, int delta
);
415 extern void source_list_from_addr(const ADDRESS64
* addr
, int nlines
);
416 extern void source_show_path(void);
417 extern void source_add_path(const char* path
);
418 extern void source_nuke_path(struct dbg_process
* p
);
419 extern void source_free_files(struct dbg_process
* p
);
422 extern void stack_info(int len
);
423 extern void stack_backtrace(DWORD threadID
);
424 extern BOOL
stack_set_frame(int newframe
);
425 extern BOOL
stack_get_register_frame(const struct dbg_internal_var
* div
, DWORD_PTR
** pval
);
426 extern unsigned stack_fetch_frames(const dbg_ctx_t
*ctx
);
427 extern BOOL
stack_get_current_symbol(SYMBOL_INFO
* sym
);
428 static inline struct dbg_frame
*
429 stack_get_thread_frame(struct dbg_thread
* thd
, unsigned nf
)
431 if (!thd
->frames
|| nf
>= thd
->num_frames
) return NULL
;
432 return &thd
->frames
[nf
];
434 static inline struct dbg_frame
*
435 stack_get_curr_frame(void)
437 return stack_get_thread_frame(dbg_curr_thread
, dbg_curr_thread
->curr_frame
);
441 extern enum sym_get_lval
symbol_get_lvalue(const char* name
, const int lineno
, struct dbg_lvalue
* addr
, BOOL bp_disp
);
442 extern void symbol_read_symtable(const char* filename
, ULONG_PTR offset
);
443 extern enum dbg_line_status
symbol_get_function_line_status(const ADDRESS64
* addr
);
444 extern BOOL
symbol_get_line(const char* filename
, const char* func
, IMAGEHLP_LINE64
* ret
);
445 extern void symbol_info(const char* str
);
446 extern void symbol_print_local(const SYMBOL_INFO
* sym
, DWORD_PTR base
, BOOL detailed
);
447 extern BOOL
symbol_info_locals(void);
448 extern BOOL
symbol_is_local(const char* name
);
450 typedef enum sym_get_lval (*symbol_picker_t
)(const char* name
, const struct sgv_data
* sgv
,
451 struct dbg_lvalue
* rtn
);
452 extern symbol_picker_t symbol_current_picker
;
453 extern enum sym_get_lval
symbol_picker_interactive(const char* name
, const struct sgv_data
* sgv
,
454 struct dbg_lvalue
* rtn
);
455 extern enum sym_get_lval
symbol_picker_scoped(const char* name
, const struct sgv_data
* sgv
,
456 struct dbg_lvalue
* rtn
);
462 struct list_string
* next
;
464 extern void dbg_run_debuggee(struct list_string
* ls
);
465 extern void dbg_wait_next_exception(DWORD cont
, int count
, int mode
);
466 extern enum dbg_start
dbg_active_attach(int argc
, char* argv
[]);
467 extern BOOL
dbg_set_curr_thread(DWORD tid
);
468 extern enum dbg_start
dbg_active_launch(int argc
, char* argv
[]);
469 extern enum dbg_start
dbg_active_auto(int argc
, char* argv
[]);
470 extern enum dbg_start
dbg_active_minidump(int argc
, char* argv
[]);
471 extern void dbg_active_wait_for_first_exception(void);
472 extern BOOL
dbg_attach_debuggee(DWORD pid
);
473 extern void fetch_module_name(void* name_addr
, void* mod_addr
, WCHAR
* buffer
, size_t bufsz
);
476 extern void minidump_write(const char*, const EXCEPTION_RECORD
*);
477 extern enum dbg_start
minidump_reload(int argc
, char* argv
[]);
480 extern enum dbg_start
tgt_module_load(const char* name
, BOOL keep
);
483 extern void print_value(const struct dbg_lvalue
* addr
, char format
, int level
);
484 extern BOOL
types_print_type(const struct dbg_type
*, BOOL details
);
485 extern BOOL
print_types(void);
486 extern dbg_lgint_t
types_extract_as_integer(const struct dbg_lvalue
*);
487 extern dbg_lgint_t
types_extract_as_lgint(const struct dbg_lvalue
*, unsigned* psize
, BOOL
*pissigned
);
488 extern void types_extract_as_address(const struct dbg_lvalue
*, ADDRESS64
*);
489 extern BOOL
types_store_value(struct dbg_lvalue
* lvalue_to
, const struct dbg_lvalue
* lvalue_from
);
490 extern BOOL
types_udt_find_element(struct dbg_lvalue
* value
, const char* name
, ULONG
*tmpbuf
);
491 extern BOOL
types_array_index(const struct dbg_lvalue
* value
, int index
, struct dbg_lvalue
* result
);
492 extern BOOL
types_get_info(const struct dbg_type
*, IMAGEHLP_SYMBOL_TYPE_INFO
, void*);
493 extern BOOL
types_get_real_type(struct dbg_type
* type
, DWORD
* tag
);
494 extern struct dbg_type
types_find_pointer(const struct dbg_type
* type
);
495 extern struct dbg_type
types_find_type(DWORD64 linear
, const char* name
, enum SymTagEnum tag
);
498 extern void dbg_outputW(const WCHAR
* buffer
, int len
);
499 extern const char* dbg_W2A(const WCHAR
* buffer
, unsigned len
);
501 extern int WINAPIV
dbg_printf(const char* format
, ...) __attribute__((format (printf
,1,2)));
503 extern int WINAPIV
dbg_printf(const char* format
, ...);
505 extern const struct dbg_internal_var
* dbg_get_internal_var(const char*);
506 extern BOOL
dbg_interrupt_debuggee(void);
507 extern unsigned dbg_num_processes(void);
508 extern struct dbg_process
* dbg_add_process(const struct be_process_io
* pio
, DWORD pid
, HANDLE h
);
509 extern void dbg_set_process_name(struct dbg_process
* p
, const WCHAR
* name
);
510 extern struct dbg_process
* dbg_get_process(DWORD pid
);
511 extern struct dbg_process
* dbg_get_process_h(HANDLE handle
);
512 extern void dbg_del_process(struct dbg_process
* p
);
513 struct dbg_thread
* dbg_add_thread(struct dbg_process
* p
, DWORD tid
, HANDLE h
, void* teb
);
514 extern struct dbg_thread
* dbg_get_thread(struct dbg_process
* p
, DWORD tid
);
515 extern void dbg_del_thread(struct dbg_thread
* t
);
516 extern BOOL
dbg_init(HANDLE hProc
, const WCHAR
* in
, BOOL invade
);
517 extern BOOL
dbg_load_module(HANDLE hProc
, HANDLE hFile
, const WCHAR
* name
, DWORD_PTR base
, DWORD size
);
518 extern void dbg_set_option(const char*, const char*);
519 extern void dbg_start_interactive(const char*, HANDLE hFile
);
520 extern void dbg_init_console(void);
523 extern int gdb_main(int argc
, char* argv
[]);
525 static inline BOOL
dbg_read_memory(const void* addr
, void* buffer
, size_t len
)
528 return dbg_curr_process
->process_io
->read(dbg_curr_process
->handle
, addr
, buffer
, len
, &rlen
) && len
== rlen
;
531 static inline BOOL
dbg_write_memory(void* addr
, const void* buffer
, size_t len
)
534 return dbg_curr_process
->process_io
->write(dbg_curr_process
->handle
, addr
, buffer
, len
, &wlen
) && len
== wlen
;
537 static inline void* dbg_heap_realloc(void* buffer
, size_t size
)
539 return (buffer
) ? HeapReAlloc(GetProcessHeap(), 0, buffer
, size
) :
540 HeapAlloc(GetProcessHeap(), 0, size
);
543 extern struct dbg_internal_var dbg_internal_vars
[];
545 #define DBG_IVARNAME(_var) dbg_internal_var_##_var
546 #define DBG_IVARSTRUCT(_var) dbg_internal_vars[DBG_IVARNAME(_var)]
547 #define DBG_IVAR(_var) (DBG_IVARSTRUCT(_var).val)
548 #define INTERNAL_VAR(_var,_val,_ref,itype) DBG_IVARNAME(_var),
556 /* include CPU dependent bits */
559 #endif /* __WINE_DEBUGGER_H */