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