programs/winedbg/debugger.h

   1 /*
   2  * Debugger definitions
   3  *
   4  * Copyright 1995 Alexandre Julliard
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_DEBUGGER_H
  22 #define __WINE_DEBUGGER_H
  23
  24 #include <assert.h>
  25 #include <stdarg.h>
  26
  27 #define NONAMELESSUNION
  28 #define NONAMELESSSTRUCT
  29 #define WIN32_LEAN_AND_MEAN
  30 #include "windef.h"
  31 #include "winbase.h"
  32 #include "ntstatus.h"
  33 #include "winver.h"
  34 #include "dbghelp.h"
  35 #include "cvconst.h"
  36 #include "oaidl.h"
  37
  38 /* the debugger uses these exceptions for it's internal use */
  39 #define DEBUG_STATUS_OFFSET             0x80003000
  40 #define DEBUG_STATUS_INTERNAL_ERROR     (DEBUG_STATUS_OFFSET+0) /* something went wrong */
  41 #define DEBUG_STATUS_NO_SYMBOL          (DEBUG_STATUS_OFFSET+1) /* no symbol found in lookup */
  42 #define DEBUG_STATUS_DIV_BY_ZERO        (DEBUG_STATUS_OFFSET+2)
  43 #define DEBUG_STATUS_BAD_TYPE           (DEBUG_STATUS_OFFSET+3) /* no type found, when type was expected */
  44 #define DEBUG_STATUS_NO_FIELD           (DEBUG_STATUS_OFFSET+4) /* when dereferencing a struct, the field was not found */
  45 #define DEBUG_STATUS_ABORT              (DEBUG_STATUS_OFFSET+5) /* user aborted on going action */
  46 #define DEBUG_STATUS_CANT_DEREF         (DEBUG_STATUS_OFFSET+6) /* either not deref:able, or index out of bounds */
  47 #define DEBUG_STATUS_NOT_AN_INTEGER     (DEBUG_STATUS_OFFSET+7) /* requiring an integral value */
  48
  49 /*
  50  * Return values for symbol_get_function_line_status.  Used to determine
  51  * what to do when the 'step' command is given.
  52  */
  53 enum dbg_line_status
  54 {
  55     dbg_no_line_info,
  56     dbg_not_on_a_line_number,
  57     dbg_on_a_line_number,
  58     dbg_in_a_thunk,
  59 };
  60
  61 enum dbg_internal_types
  62 {
  63     dbg_itype_first             = 0xffffff00,
  64     dbg_itype_unsigned_int,
  65     dbg_itype_signed_int,
  66     dbg_itype_signed_char_int,
  67     dbg_itype_unsigned_char_int,
  68     dbg_itype_unsigned_short_int,
  69     dbg_itype_signed_short_int,
  70     dbg_itype_unsigned_long_int,
  71     dbg_itype_signed_long_int,
  72     dbg_itype_unsigned_longlong_int,
  73     dbg_itype_signed_longlong_int,
  74     dbg_itype_char,
  75     dbg_itype_wchar,
  76     dbg_itype_short_real, /* aka float */
  77     dbg_itype_real,       /* aka double */
  78     dbg_itype_long_real,  /* aka long double */
  79     dbg_itype_astring,
  80     dbg_itype_ustring,
  81     dbg_itype_none              = 0xffffffff
  82 };
  83
  84 struct dbg_lvalue       /* structure to hold left-values... */
  85 {
  86     int                 cookie; /* DLV_??? */
  87 /* DLV_TARGET references an address in debuggee's address space, whereas DLV_HOST
  88  * references the winedbg's address space
  89  */
  90 #       define  DLV_TARGET      0xF00D
  91 #       define  DLV_HOST        0x50DA
  92     ADDRESS             addr;
  93     unsigned long       typeid;
  94 };
  95
  96 enum dbg_exec_mode
  97 {
  98     dbg_exec_cont,                      /* Continue execution */
  99     dbg_exec_step_over_line,            /* Stepping over a call to next source line */
 100     dbg_exec_step_into_line,            /* Step to next source line, stepping in if needed */
 101     dbg_exec_step_over_insn,            /* Stepping over a call */
 102     dbg_exec_step_into_insn,            /* Single-stepping an instruction */
 103     dbg_exec_finish,                    /* Single-step until we exit current frame */
 104 #if 0
 105     EXEC_STEP_OVER_TRAMPOLINE,  /* Step over trampoline.  Requires that we dig the real
 106                                  * return value off the stack and set breakpoint there -
 107                                  * not at the instr just after the call.
 108                                  */
 109 #endif
 110 };
 111
 112 struct dbg_breakpoint
 113 {
 114     ADDRESS             addr;
 115     unsigned long       enabled : 1,
 116                         xpoint_type : 2,
 117                         refcount : 13,
 118                         skipcount : 16;
 119     DWORD               info;
 120     struct              /* only used for watchpoints */
 121     {
 122         BYTE            len : 2;
 123         DWORD           oldval;
 124     } w;
 125     struct expr*        condition;
 126 };
 127
 128 /* Wine extension; Windows doesn't have a name for this code.  This is an
 129    undocumented exception understood by MS VC debugger, allowing the program
 130    to name a particular thread.  Search google.com or deja.com for "0x406d1388"
 131    for more info. */
 132 #define EXCEPTION_NAME_THREAD               0x406D1388
 133
 134 /* Helper structure */
 135 typedef struct tagTHREADNAME_INFO
 136 {
 137    DWORD   dwType;     /* Must be 0x1000 */
 138    LPCTSTR szName;     /* Pointer to name - limited to 9 bytes (8 characters + terminator) */
 139    DWORD   dwThreadID; /* Thread ID (-1 = caller thread) */
 140    DWORD   dwFlags;    /* Reserved for future use.  Must be zero. */
 141 } THREADNAME_INFO;
 142
 143 struct dbg_thread
 144 {
 145     struct dbg_process*         process;
 146     HANDLE                      handle;
 147     DWORD                       tid;
 148     void*                       teb;
 149     int                         wait_for_first_exception;
 150     enum dbg_exec_mode          exec_mode;      /* mode the thread is run (step/run...) */
 151     int                         exec_count;     /* count of mode operations */
 152     ADDRESS_MODE                addr_mode;      /* mode */
 153     struct dbg_breakpoint       step_over_bp;
 154     char                        name[9];
 155     struct dbg_thread*          next;
 156     struct dbg_thread*          prev;
 157 };
 158
 159 struct dbg_delayed_bp
 160 {
 161     BOOL                        is_symbol;
 162     union
 163     {
 164         struct
 165         {
 166             int                         lineno;
 167             char*                       name;
 168         } symbol;
 169         ADDRESS                 addr;
 170     } u;
 171 };
 172
 173 #define MAX_BREAKPOINTS 100
 174 struct dbg_process
 175 {
 176     HANDLE                      handle;
 177     DWORD                       pid;
 178     const char*                 imageName;
 179     struct dbg_thread*          threads;
 180     unsigned                    continue_on_first_exception;
 181     struct dbg_breakpoint       bp[MAX_BREAKPOINTS];
 182     unsigned                    next_bp;
 183     struct dbg_delayed_bp*      delayed_bp;
 184     int                         num_delayed_bp;
 185     struct dbg_process*         next;
 186     struct dbg_process*         prev;
 187 };
 188
 189 extern  struct dbg_process*     dbg_curr_process;
 190 extern  DWORD                   dbg_curr_pid;
 191 extern  struct dbg_thread*      dbg_curr_thread;
 192 extern  DWORD                   dbg_curr_tid;
 193 extern  CONTEXT                 dbg_context;
 194 extern  BOOL                    dbg_interactiveP;
 195 extern  int                     dbg_curr_frame;
 196
 197 struct dbg_internal_var
 198 {
 199     DWORD                       val;
 200     const char*                 name;
 201     LPDWORD                     pval;
 202     unsigned long               typeid;
 203 };
 204
 205 enum sym_get_lval {sglv_found, sglv_unknown, sglv_aborted};
 206
 207 enum type_expr_e
 208 {
 209     type_expr_type_id,
 210     type_expr_udt_class,
 211     type_expr_udt_struct,
 212     type_expr_udt_union,
 213     type_expr_enumeration
 214 };
 215
 216 struct type_expr_t
 217 {
 218     enum type_expr_e    type;
 219     unsigned            deref_count;
 220     union
 221     {
 222         unsigned long   typeid;
 223         const char*     name;
 224     } u;
 225 };
 226
 227   /* break.c */
 228 extern void             break_set_xpoints(BOOL set);
 229 extern BOOL             break_add_break(const ADDRESS* addr, BOOL verbose);
 230 extern BOOL             break_add_break_from_lvalue(const struct dbg_lvalue* value);
 231 extern void             break_add_break_from_id(const char* name, int lineno);
 232 extern void             break_add_break_from_lineno(int lineno);
 233 extern void             break_add_watch(const struct dbg_lvalue* lvalue, int is_write);
 234 extern void             break_add_watch_from_id(const char* name);
 235 extern void             break_check_delayed_bp(void);
 236 extern void             break_delete_xpoint(int num);
 237 extern void             break_delete_xpoints_from_module(unsigned long base);
 238 extern void             break_enable_xpoint(int num, BOOL enable);
 239 extern void             break_info(void);
 240 extern BOOL             break_should_continue(ADDRESS* addr, DWORD code, int* count);
 241 extern void             break_suspend_execution(void);
 242 extern void             break_restart_execution(int count);
 243 extern int              break_add_condition(int bpnum, struct expr* exp);
 244
 245   /* dbg.y */
 246 extern void             parser(const char*);
 247 extern int              input_read_line(const char* pfx, char* buffer, int size);
 248 extern int              input_fetch_entire_line(const char* pfx, char** line, size_t* alloc, BOOL check_nl);
 249
 250   /* debug.l */
 251 extern void             lexeme_flush(void);
 252 extern char*            lexeme_alloc(const char*);
 253
 254   /* display.c */
 255 extern int              display_print(void);
 256 extern int              display_add(struct expr* exp, int count, char format, int local_frame);
 257 extern int              display_delete(int displaynum);
 258 extern int              display_info(void);
 259 extern int              display_enable(int displaynum, int enable);
 260
 261   /* expr.c */
 262 extern void             expr_free_all(void);
 263 extern struct expr*     expr_alloc_internal_var(const char* name);
 264 extern struct expr*     expr_alloc_symbol(const char* name);
 265 extern struct expr*     expr_alloc_sconstant(int val);
 266 extern struct expr*     expr_alloc_uconstant(unsigned val);
 267 extern struct expr*     expr_alloc_string(const char* str);
 268 extern struct expr*     expr_alloc_binary_op(int oper, struct expr*, struct expr*);
 269 extern struct expr*     expr_alloc_unary_op(int oper, struct expr*);
 270 extern struct expr*     expr_alloc_pstruct(struct expr*, const char* element);
 271 extern struct expr*     expr_alloc_struct(struct expr*, const char* element);
 272 extern struct expr*     expr_alloc_func_call(const char*, int nargs, ...);
 273 extern struct expr*     expr_alloc_typecast(struct type_expr_t*, struct expr*);
 274 extern struct dbg_lvalue expr_eval(struct expr*);
 275 extern struct expr*     expr_clone(const struct expr* exp);
 276 extern int              expr_free(struct expr* exp);
 277 extern int              expr_print(const struct expr* exp);
 278
 279   /* info.c */
 280 extern void             print_help(void);
 281 extern void             info_help(void);
 282 extern void             info_win32_module(DWORD mod);
 283 extern void             info_win32_class(HWND hWnd, const char* clsName);
 284 extern void             info_win32_window(HWND hWnd, BOOL detailed);
 285 extern void             info_win32_processes(void);
 286 extern void             info_win32_threads(void);
 287 extern void             info_win32_exceptions(DWORD tid);
 288 extern void             info_win32_virtual(DWORD pid);
 289 extern void             info_win32_segments(DWORD start, int length);
 290 extern void             info_wine_dbg_channel(BOOL add, const char* chnl, const char* name);
 291
 292   /* memory.c */
 293 extern BOOL             memory_read_value(const struct dbg_lvalue* val, DWORD size, void* result);
 294 extern BOOL             memory_write_value(const struct dbg_lvalue* val, DWORD size, void* value);
 295 extern void             memory_examine(const struct dbg_lvalue* addr, int count, char format);
 296 extern void             memory_report_invalid_addr(const void* addr);
 297 extern void*            memory_to_linear_addr(const ADDRESS* address);
 298 extern BOOL             memory_get_current_pc(ADDRESS* address);
 299 extern BOOL             memory_get_current_stack(ADDRESS* address);
 300 extern BOOL             memory_get_current_frame(ADDRESS* address);
 301 extern BOOL             memory_get_string(HANDLE hp, void* addr, unsigned cookie, BOOL unicode, char* buffer, int size);
 302 extern BOOL             memory_get_string_indirect(HANDLE hp, void* addr, BOOL unicode, char* buffer, int size);
 303 extern void             memory_disassemble(const struct dbg_lvalue*, const struct dbg_lvalue*, int offset);
 304 extern BOOL             memory_disasm_one_insn(ADDRESS* addr);
 305 extern void             print_bare_address(const ADDRESS* addr);
 306 extern void             print_address(const ADDRESS* addr, BOOLEAN with_line);
 307 extern void             print_addr_and_args(const ADDRESS* pc, const ADDRESS* frame);
 308 extern void             print_basic(const struct dbg_lvalue* value, int count, char format);
 309
 310   /* source.c */
 311 extern void             source_list(IMAGEHLP_LINE* src1, IMAGEHLP_LINE* src2, int delta);
 312 extern void             source_list_from_addr(const ADDRESS* addr, int nlines);
 313 extern void             source_show_path(void);
 314 extern void             source_add_path(const char* path);
 315 extern void             source_nuke_path(void);
 316
 317   /* stack.c */
 318 extern void             stack_info(void);
 319 extern void             stack_backtrace(DWORD threadID, BOOL noisy);
 320 extern int              stack_set_frame(int newframe);
 321 extern int              stack_get_frame(SYMBOL_INFO* sym, IMAGEHLP_STACK_FRAME* ihsf);
 322
 323   /* symbol.c */
 324 extern enum sym_get_lval symbol_get_lvalue(const char* name, const int lineno, struct dbg_lvalue* addr, BOOL bp_disp);
 325 extern void             symbol_read_symtable(const char* filename, unsigned long offset);
 326 extern enum dbg_line_status symbol_get_function_line_status(const ADDRESS* addr);
 327 extern BOOL             symbol_get_line(const char* filename, const char* func, IMAGEHLP_LINE* ret);
 328 extern void             symbol_info(const char* str);
 329 extern int              symbol_info_locals(void);
 330
 331   /* types.c */
 332 extern void             print_value(const struct dbg_lvalue* addr, char format, int level);
 333 extern int              types_print_type(DWORD linear, DWORD typeid, BOOL details);
 334 extern int              print_types(void);
 335 extern long int         types_extract_as_integer(const struct dbg_lvalue*);
 336 extern BOOL             types_deref(const struct dbg_lvalue* value, struct dbg_lvalue* result);
 337 extern BOOL             types_udt_find_element(struct dbg_lvalue* value, const char* name, long int* tmpbuf);
 338 extern BOOL             types_array_index(const struct dbg_lvalue* value, int index, struct dbg_lvalue* result);
 339 extern BOOL             types_get_info(unsigned long, unsigned long,
 340                                        IMAGEHLP_SYMBOL_TYPE_INFO, void*);
 341 extern unsigned long    types_find_pointer(unsigned long linear, unsigned long typeid);
 342 extern unsigned long    types_find_type(unsigned long linear, const char* name, enum SymTagEnum tag);
 343
 344   /* winedbg.c */
 345 extern void             dbg_outputA(const char* buffer, int len);
 346 extern void             dbg_outputW(const WCHAR* buffer, int len);
 347 #ifdef __GNUC__
 348 extern int              dbg_printf(const char* format, ...) __attribute__((format (printf,1,2)));
 349 #else
 350 extern int              dbg_printf(const char* format, ...);
 351 #endif
 352 extern const struct dbg_internal_var* dbg_get_internal_var(const char*);
 353 extern BOOL             dbg_attach_debuggee(DWORD pid, BOOL cofe, BOOL wfe);
 354 extern BOOL             dbg_detach_debuggee(void);
 355 extern BOOL             dbg_interrupt_debuggee(void);
 356 extern void             dbg_run_debuggee(const char* args);
 357 extern struct dbg_process* dbg_add_process(DWORD pid, HANDLE h, const char* imageName);
 358 extern struct dbg_process* dbg_get_process(DWORD pid);
 359 extern void             dbg_del_process(struct dbg_process* p);
 360 struct dbg_thread*      dbg_add_thread(struct dbg_process* p, DWORD tid, HANDLE h, void* teb);
 361 extern struct dbg_thread* dbg_get_thread(struct dbg_process* p, DWORD tid);
 362 extern void             dbg_del_thread(struct dbg_thread* t);
 363 extern void             dbg_wait_next_exception(DWORD cont, int count, int mode);
 364 extern BOOL             dbg_get_debuggee_info(HANDLE hProcess, IMAGEHLP_MODULE* imh_mod);
 365
 366 /* gdbproxy.c */
 367 extern BOOL             gdb_remote(unsigned int);
 368
 369 static inline BOOL dbg_read_memory(const void* addr, void* buffer, size_t len)
 370 {
 371     DWORD rlen;
 372     return ReadProcessMemory(dbg_curr_process->handle, addr, buffer, len, &rlen) && len == rlen;
 373 }
 374
 375 static inline BOOL dbg_write_memory(void* addr, const void* buffer, size_t len)
 376 {
 377     DWORD wlen;
 378     return WriteProcessMemory(dbg_curr_process->handle, addr, buffer, len, &wlen) && len == wlen;
 379 }
 380
 381 static inline BOOL dbg_read_memory_verbose(const void* addr, void* buffer, size_t len)
 382 {
 383     if (dbg_read_memory(addr, buffer, len)) return TRUE;
 384     memory_report_invalid_addr(addr);
 385     return FALSE;
 386 }
 387
 388 static inline BOOL dbg_write_memory_verbose(void* addr, const void* buffer, size_t len)
 389 {
 390     if (dbg_write_memory(addr, buffer, len)) return TRUE;
 391     memory_report_invalid_addr(addr);
 392     return FALSE;
 393 }
 394
 395 static inline void* dbg_heap_realloc(void* buffer, size_t size)
 396 {
 397     return (buffer) ? HeapReAlloc(GetProcessHeap(), 0, buffer, size) :
 398         HeapAlloc(GetProcessHeap(), 0, size);
 399 }
 400
 401 extern struct dbg_internal_var          dbg_internal_vars[];
 402 extern const struct dbg_internal_var*   dbg_context_vars;
 403
 404 #define  DBG_IVARNAME(_var)     dbg_internal_var_##_var
 405 #define  DBG_IVARSTRUCT(_var)   dbg_internal_vars[DBG_IVARNAME(_var)]
 406 #define  DBG_IVAR(_var)         (*(DBG_IVARSTRUCT(_var).pval))
 407 #define  INTERNAL_VAR(_var,_val,_ref,itype) DBG_IVARNAME(_var),
 408 enum debug_int_var
 409 {
 410 #include "intvar.h"
 411    DBG_IV_LAST
 412 };
 413 #undef   INTERNAL_VAR
 414
 415 /* include CPU dependent bits */
 416 #include "be_cpu.h"
 417
 418 #endif  /* __WINE_DEBUGGER_H */