debugger/debugger.h

   1 /*
   2  * Debugger definitions
   3  *
   4  * Copyright 1995 Alexandre Julliard
   5  */
   6
   7 #ifndef __WINE_DEBUGGER_H
   8 #define __WINE_DEBUGGER_H
   9
  10 #include <sys/types.h> /* u_long ... */
  11 #include <assert.h>
  12 #include "windef.h"
  13 #include "winbase.h"
  14 #include "wine/exception.h"
  15
  16 #ifdef __i386__
  17 #define STEP_FLAG 0x00000100 /* single step flag */
  18 #define V86_FLAG  0x00020000
  19 #endif
  20
  21 #define SYM_FUNC         0x0
  22 #define SYM_DATA         0x1
  23 #define SYM_WIN32        0x2
  24 #define SYM_WINE         0x4
  25 #define SYM_INVALID      0x8
  26 #define SYM_TRAMPOLINE   0x10
  27 #define SYM_STEP_THROUGH 0x20
  28
  29 enum    debug_type {DT_BASIC, DT_CONST, DT_POINTER, DT_ARRAY, DT_STRUCT, DT_ENUM, DT_TYPEDEF, DT_FUNC, DT_BITFIELD};
  30
  31
  32 /*
  33  * Return values for DEBUG_CheckLinenoStatus.  Used to determine
  34  * what to do when the 'step' command is given.
  35  */
  36 #define FUNC_HAS_NO_LINES       (0)
  37 #define NOT_ON_LINENUMBER       (1)
  38 #define AT_LINENUMBER           (2)
  39 #define FUNC_IS_TRAMPOLINE      (3)
  40
  41 /*
  42  * For constants generated by the parser, we use this datatype
  43  */
  44 extern struct datatype * DEBUG_TypeShortUInt;
  45 extern struct datatype * DEBUG_TypeInt;
  46 extern struct datatype * DEBUG_TypeIntConst;
  47 extern struct datatype * DEBUG_TypeUSInt;
  48 extern struct datatype * DEBUG_TypeString;
  49
  50 typedef struct
  51 {
  52     DWORD               seg;  /* 0xffffffff means current default segment (cs or ds) */
  53     DWORD               off;
  54 } DBG_ADDR;
  55
  56 #define DV_TARGET       0xF00D
  57 #define DV_HOST         0x50DA
  58
  59 typedef struct
  60 {
  61    struct datatype*     type;
  62    int                  cookie; /* DV_??? */
  63    DBG_ADDR             addr;
  64 } DBG_VALUE;
  65
  66 struct list_id
  67 {
  68     char * sourcefile;
  69     int    line;
  70 };
  71
  72 struct  wine_lines {
  73   unsigned long         line_number;
  74   DBG_ADDR              pc_offset;
  75 };
  76
  77 struct symbol_info
  78 {
  79   struct name_hash * sym;
  80   struct list_id     list;
  81 };
  82
  83 typedef struct wine_lines WineLineNo;
  84
  85 /*
  86  * This structure holds information about stack variables, function
  87  * parameters, and register variables, which are all local to this
  88  * function.
  89  */
  90 struct  wine_locals {
  91   unsigned int          regno:8;        /* For register symbols */
  92   signed int            offset:24;      /* offset from esp/ebp to symbol */
  93   unsigned int          pc_start;       /* For RBRAC/LBRAC */
  94   unsigned int          pc_end;         /* For RBRAC/LBRAC */
  95   char                * name;           /* Name of symbol */
  96   struct datatype     * type;           /* Datatype of symbol */
  97 };
  98
  99 typedef struct wine_locals WineLocals;
 100
 101 enum exec_mode
 102 {
 103     EXEC_CONT,                  /* Continuous execution */
 104     EXEC_PASS,                  /* Continue, passing exception to app */
 105     EXEC_STEP_OVER,             /* Stepping over a call to next source line */
 106     EXEC_STEP_INSTR,            /* Step to next source line, stepping in if needed */
 107     EXEC_STEPI_OVER,            /* Stepping over a call */
 108     EXEC_STEPI_INSTR,           /* Single-stepping an instruction */
 109     EXEC_FINISH,                /* Step until we exit current frame */
 110     EXEC_STEP_OVER_TRAMPOLINE,  /* Step over trampoline.  Requires that
 111                                  * we dig the real return value off the stack
 112                                  * and set breakpoint there - not at the
 113                                  * instr just after the call.
 114                                  */
 115     EXEC_KILL                   /* terminate debugging session */
 116 };
 117
 118 #define DBG_BREAK       0
 119 #define DBG_WATCH       1
 120
 121 typedef struct
 122 {
 123     DBG_ADDR      addr;
 124     WORD          enabled : 1,
 125                   type : 1,
 126                   is32 : 1,
 127                   refcount : 13;
 128     WORD          skipcount;
 129     union {
 130        struct {
 131           BYTE          opcode;
 132           BOOL          (*func)(void);
 133        } b;
 134        struct {
 135           BYTE          rw : 1,
 136                         len : 2;
 137           BYTE          reg;
 138           DWORD         oldval;
 139        } w;
 140     } u;
 141     struct expr * condition;
 142 } DBG_BREAKPOINT;
 143
 144 typedef struct tagDBG_THREAD {
 145     struct tagDBG_PROCESS*      process;
 146     HANDLE                      handle;
 147     DWORD                       tid;
 148     LPVOID                      start;
 149     LPVOID                      teb;
 150     int                         wait_for_first_exception;
 151     int                         dbg_mode;
 152     enum exec_mode              dbg_exec_mode;
 153     int                         dbg_exec_count;
 154     DBG_BREAKPOINT              stepOverBP;
 155     struct tagDBG_THREAD*       next;
 156     struct tagDBG_THREAD*       prev;
 157 } DBG_THREAD;
 158
 159 typedef struct tagDBG_PROCESS {
 160     HANDLE                      handle;
 161     DWORD                       pid;
 162     DBG_THREAD*                 threads;
 163     int                         num_threads;
 164     unsigned                    continue_on_first_exception;
 165     struct tagDBG_MODULE*       modules;
 166     unsigned long               dbg_hdr_addr;
 167     /*
 168      * This is an index we use to keep track of the debug information
 169      * when we have multiple sources.  We use the same database to also
 170      * allow us to do an 'info shared' type of deal, and we use the index
 171      * to eliminate duplicates.
 172      */
 173     int                         next_index;
 174     struct tagDBG_PROCESS*      next;
 175     struct tagDBG_PROCESS*      prev;
 176 } DBG_PROCESS;
 177
 178 extern  DBG_PROCESS*    DEBUG_CurrProcess;
 179 extern  DBG_THREAD*     DEBUG_CurrThread;
 180 extern  DWORD           DEBUG_CurrTid;
 181 extern  DWORD           DEBUG_CurrPid;
 182 extern  CONTEXT         DEBUG_context;
 183
 184 #define DEBUG_READ_MEM(addr, buf, len) \
 185       (ReadProcessMemory(DEBUG_CurrProcess->handle, (addr), (buf), (len), NULL))
 186
 187 #define DEBUG_WRITE_MEM(addr, buf, len) \
 188       (WriteProcessMemory(DEBUG_CurrProcess->handle, (addr), (buf), (len), NULL))
 189
 190 #define DEBUG_READ_MEM_VERBOSE(addr, buf, len) \
 191       (DEBUG_READ_MEM((addr), (buf), (len)) || (DEBUG_InvalLinAddr( addr ),0))
 192
 193 #define DEBUG_WRITE_MEM_VERBOSE(addr, buf, len) \
 194       (DEBUG_WRITE_MEM((addr), (buf), (len)) || (DEBUG_InvalLinAddr( addr ),0))
 195
 196 typedef struct tagDBG_MODULE {
 197    struct tagDBG_MODULE*        next;
 198    void*                        load_addr;
 199    char*                        module_name;
 200    char                         status;
 201    char                         type;
 202    short int                    dbg_index;
 203    HMODULE                      handle;
 204    void*                        extra_info;
 205 } DBG_MODULE;
 206
 207 /* status field */
 208 #define DM_STATUS_NEW           0
 209 #define DM_STATUS_LOADED        1
 210 #define DM_STATUS_ERROR         2
 211
 212 /* type field */
 213 #define DM_TYPE_UNKNOWN         0
 214 #define DM_TYPE_ELF             1
 215 #define DM_TYPE_NE              2
 216 #define DM_TYPE_PE              3
 217
 218 typedef struct {
 219    DWORD                val;
 220    const char*          name;
 221    LPDWORD              pval;
 222    struct datatype*     type;
 223 } DBG_INTVAR;
 224
 225 #define OFFSET_OF(__c,__f)              ((int)(((char*)&(((__c*)0)->__f))-((char*)0)))
 226
 227   /* debugger/break.c */
 228 extern void DEBUG_SetBreakpoints( BOOL set );
 229 extern void DEBUG_AddBreakpoint( const DBG_VALUE *addr, BOOL (*func)(void) );
 230 extern void DEBUG_AddWatchpoint( const DBG_VALUE *addr, int is_write );
 231 extern void DEBUG_DelBreakpoint( int num );
 232 extern void DEBUG_EnableBreakpoint( int num, BOOL enable );
 233 extern void DEBUG_InfoBreakpoints(void);
 234 extern BOOL DEBUG_HandleTrap(void);
 235 extern BOOL DEBUG_ShouldContinue( DWORD code, enum exec_mode mode, int * count );
 236 extern void DEBUG_SuspendExecution( void );
 237 extern enum exec_mode DEBUG_RestartExecution( enum exec_mode mode, int count );
 238 extern BOOL DEBUG_IsFctReturn(void);
 239 extern int DEBUG_AddBPCondition(int bpnum, struct expr * exp);
 240
 241   /* debugger/db_disasm.c */
 242 extern void DEBUG_Disasm( DBG_ADDR *addr, int display );
 243
 244   /* debugger/dbg.y */
 245 extern BOOL DEBUG_Main( BOOL is_debug, BOOL force, DWORD code );
 246 extern void DEBUG_Exit( DWORD );
 247
 248   /* debugger/debug.l */
 249 extern void flush_symbols(void);
 250
 251   /* debugger/display.c */
 252 extern int DEBUG_DoDisplay(void);
 253 extern int DEBUG_AddDisplay(struct expr * exp, int count, char format);
 254 extern int DEBUG_DoDisplay(void);
 255 extern int DEBUG_DelDisplay(int displaynum);
 256 extern int DEBUG_InfoDisplay(void);
 257
 258   /* debugger/editline.c */
 259 extern char * readline(const char *);
 260 extern void add_history(char *);
 261
 262   /* debugger/expr.c */
 263 extern void DEBUG_FreeExprMem(void);
 264 struct expr * DEBUG_IntVarExpr(const char* name);
 265 struct expr * DEBUG_SymbolExpr(const char * name);
 266 struct expr * DEBUG_ConstExpr(int val);
 267 struct expr * DEBUG_StringExpr(const char * str);
 268 struct expr * DEBUG_SegAddr(struct expr *, struct expr *);
 269 struct expr * DEBUG_USConstExpr(unsigned int val);
 270 struct expr * DEBUG_BinopExpr(int oper, struct expr *, struct expr *);
 271 struct expr * DEBUG_UnopExpr(int oper, struct expr *);
 272 struct expr * DEBUG_StructPExpr(struct expr *, const char * element);
 273 struct expr * DEBUG_StructExpr(struct expr *, const char * element);
 274 struct expr * DEBUG_ArrayExpr(struct expr *, struct expr * index);
 275 struct expr * DEBUG_CallExpr(const char *, int nargs, ...);
 276 struct expr * DEBUG_TypeCastExpr(struct datatype *, struct expr *);
 277 extern DBG_VALUE DEBUG_EvalExpr(struct expr *);
 278 extern int DEBUG_DelDisplay(int displaynum);
 279 extern struct expr * DEBUG_CloneExpr(const struct expr * exp);
 280 extern int DEBUG_FreeExpr(struct expr * exp);
 281 extern int DEBUG_DisplayExpr(const struct expr * exp);
 282
 283   /* debugger/external.c */
 284 extern void DEBUG_ExternalDebugger(void);
 285
 286   /* debugger/hash.c */
 287 extern struct name_hash * DEBUG_AddSymbol( const char *name,
 288                                            const DBG_VALUE *addr,
 289                                            const char *sourcefile,
 290                                            int flags);
 291 extern BOOL DEBUG_GetSymbolValue( const char * name, const int lineno,
 292                                   DBG_VALUE *addr, int );
 293 extern BOOL DEBUG_SetSymbolValue( const char * name, const DBG_VALUE *addr );
 294 extern const char * DEBUG_FindNearestSymbol( const DBG_ADDR *addr, int flag,
 295                                              struct name_hash ** rtn,
 296                                              unsigned int ebp,
 297                                              struct list_id * source);
 298 extern void DEBUG_ReadSymbolTable( const char * filename );
 299 extern void DEBUG_AddLineNumber( struct name_hash * func, int line_num,
 300                                  unsigned long offset );
 301 extern struct wine_locals *
 302             DEBUG_AddLocal( struct name_hash * func, int regno,
 303                             int offset,
 304                             int pc_start,
 305                             int pc_end,
 306                             char * name);
 307 extern int DEBUG_CheckLinenoStatus(const DBG_ADDR *addr);
 308 extern void DEBUG_GetFuncInfo(struct list_id * ret, const char * file,
 309                               const char * func);
 310 extern int DEBUG_SetSymbolSize(struct name_hash * sym, unsigned int len);
 311 extern int DEBUG_SetSymbolBPOff(struct name_hash * sym, unsigned int len);
 312 extern int DEBUG_GetSymbolAddr(struct name_hash * sym, DBG_ADDR * addr);
 313 extern int DEBUG_cmp_sym(const void * p1, const void * p2);
 314 extern BOOL DEBUG_GetLineNumberAddr( struct name_hash *, const int lineno,
 315                                      DBG_ADDR *addr, int bp_flag );
 316
 317 extern int DEBUG_SetLocalSymbolType(struct wine_locals * sym,
 318                                     struct datatype * type);
 319 extern BOOL DEBUG_Normalize(struct name_hash * nh );
 320
 321   /* debugger/info.c */
 322 extern void DEBUG_PrintBasic( const DBG_VALUE* value, int count, char format );
 323 extern struct symbol_info DEBUG_PrintAddress( const DBG_ADDR *addr,
 324                                               int addrlen, int flag );
 325 extern void DEBUG_Help(void);
 326 extern void DEBUG_HelpInfo(void);
 327 extern struct symbol_info DEBUG_PrintAddressAndArgs( const DBG_ADDR *addr,
 328                                                      int addrlen,
 329                                                      unsigned int ebp,
 330                                                      int flag );
 331 extern void DEBUG_InfoClass(const char* clsName);
 332 extern void DEBUG_WalkClasses(void);
 333 extern void DEBUG_WalkModref(DWORD p);
 334 extern void DEBUG_DumpModule(DWORD mod);
 335 extern void DEBUG_WalkModules(void);
 336 extern void DEBUG_WalkProcess(void);
 337 extern void DEBUG_WalkThreads(void);
 338 extern void DEBUG_DumpQueue(DWORD q);
 339 extern void DEBUG_WalkQueues(void);
 340 extern void DEBUG_InfoSegments(DWORD s, int v);
 341 extern void DEBUG_InfoVirtual(void);
 342 extern void DEBUG_InfoWindow(HWND hWnd);
 343 extern void DEBUG_WalkWindows(HWND hWnd, int indent);
 344
 345   /* debugger/memory.c */
 346 extern int  DEBUG_ReadMemory( const DBG_VALUE* value );
 347 extern void DEBUG_WriteMemory( const DBG_VALUE* val, int value );
 348 extern void DEBUG_ExamineMemory( const DBG_VALUE *addr, int count, char format);
 349 extern void DEBUG_InvalAddr( const DBG_ADDR* addr );
 350 extern void DEBUG_InvalLinAddr( void* addr );
 351 #ifdef __i386__
 352 extern void DEBUG_GetCurrentAddress( DBG_ADDR * );
 353 extern DWORD DEBUG_ToLinear( const DBG_ADDR *address );
 354 extern void DEBUG_FixAddress( DBG_ADDR *address, DWORD def );
 355 extern BOOL DEBUG_FixSegment( DBG_ADDR* addr );
 356 extern int  DEBUG_GetSelectorType( WORD sel );
 357 extern int  DEBUG_IsSelectorSystem( WORD sel );
 358 #endif
 359
 360   /* debugger/module.c */
 361 extern int  DEBUG_LoadEntryPoints( const char * prefix );
 362 extern void DEBUG_LoadModule32( const char* name, HANDLE hFile, DWORD base );
 363 extern DBG_MODULE* DEBUG_AddModule(const char* name, int type,
 364                                    void* mod_addr, HMODULE hmod);
 365 extern DBG_MODULE* DEBUG_FindModuleByName(const char* name, int type);
 366 extern DBG_MODULE* DEBUG_FindModuleByHandle(HANDLE handle, int type);
 367 extern DBG_MODULE* DEBUG_RegisterPEModule(HMODULE, u_long load_addr, const char* name);
 368 extern DBG_MODULE* DEBUG_RegisterELFModule(u_long load_addr, const char* name);
 369 extern void DEBUG_InfoShare(void);
 370
 371   /* debugger/msc.c */
 372 extern int DEBUG_RegisterMSCDebugInfo(DBG_MODULE* module, HANDLE hFile, void* nth, unsigned long nth_ofs);
 373 extern int DEBUG_RegisterStabsDebugInfo(DBG_MODULE* module, HANDLE hFile, void* nth, unsigned long nth_ofs);
 374 extern void DEBUG_InitCVDataTypes(void);
 375
 376   /* debugger/registers.c */
 377 extern void DEBUG_InfoRegisters(void);
 378 extern BOOL DEBUG_ValidateRegisters(void);
 379
 380   /* debugger/stack.c */
 381 extern void DEBUG_InfoStack(void);
 382 extern void DEBUG_BackTrace(BOOL noisy);
 383 extern int  DEBUG_InfoLocals(void);
 384 extern int  DEBUG_SetFrame(int newframe);
 385 extern int  DEBUG_GetCurrentFrame(struct name_hash ** name,
 386                                   unsigned int * eip,
 387                                   unsigned int * ebp);
 388
 389   /* debugger/stabs.c */
 390 extern int DEBUG_ReadExecutableDbgInfo(const char* exe_name);
 391 extern int DEBUG_ProcessElfObject(const char* filename, unsigned int load_offset);
 392 extern int DEBUG_ParseStabs(char * addr, unsigned int load_offset, unsigned int staboff,
 393                             int stablen, unsigned int strtaboff, int strtablen);
 394
 395   /* debugger/types.c */
 396 extern int DEBUG_nchar;
 397 extern void DEBUG_InitTypes(void);
 398 extern struct datatype * DEBUG_NewDataType(enum debug_type xtype,
 399                                            const char * typename);
 400 extern unsigned int DEBUG_TypeDerefPointer(const DBG_VALUE *value, struct datatype ** newtype);
 401 extern int DEBUG_AddStructElement(struct datatype * dt,
 402                                   char * name, struct datatype * type,
 403                                   int offset, int size);
 404 extern int DEBUG_SetStructSize(struct datatype * dt, int size);
 405 extern int DEBUG_SetPointerType(struct datatype * dt, struct datatype * dt2);
 406 extern int DEBUG_SetArrayParams(struct datatype * dt, int min, int max,
 407                                 struct datatype * dt2);
 408 extern void DEBUG_Print( const DBG_VALUE *addr, int count, char format, int level );
 409 extern unsigned int DEBUG_FindStructElement(DBG_VALUE * addr,
 410                                             const char * ele_name, int * tmpbuf);
 411 extern struct datatype * DEBUG_GetPointerType(struct datatype * dt);
 412 extern int DEBUG_GetObjectSize(struct datatype * dt);
 413 extern unsigned int DEBUG_ArrayIndex(const DBG_VALUE * addr, DBG_VALUE * result, int index);
 414 extern struct datatype * DEBUG_FindOrMakePointerType(struct datatype * reftype);
 415 extern long long int DEBUG_GetExprValue(const DBG_VALUE * addr, char ** format);
 416 extern int DEBUG_SetBitfieldParams(struct datatype * dt, int offset,
 417                                    int nbits, struct datatype * dt2);
 418 extern int DEBUG_CopyFieldlist(struct datatype * dt, struct datatype * dt2);
 419 extern enum debug_type DEBUG_GetType(struct datatype * dt);
 420 extern struct datatype * DEBUG_TypeCast(enum debug_type, const char *);
 421 extern int DEBUG_PrintTypeCast(const struct datatype *);
 422 extern int DEBUG_PrintType( const DBG_VALUE* addr );
 423
 424   /* debugger/source.c */
 425 extern void DEBUG_ShowDir(void);
 426 extern void DEBUG_AddPath(const char * path);
 427 extern void DEBUG_List(struct list_id * line1, struct list_id * line2,
 428                        int delta);
 429 extern void DEBUG_NukePath(void);
 430 extern void DEBUG_Disassemble( const DBG_VALUE *, const DBG_VALUE*, int offset );
 431
 432   /* debugger/winedbg.c */
 433 #define DBG_CHN_MESG    1
 434 #define DBG_CHN_ERR     2
 435 #define DBG_CHN_WARN    4
 436 #define DBG_CHN_FIXME   8
 437 #define DBG_CHN_TRACE   16
 438 extern void     DEBUG_Output(int chn, const char* buffer, int len);
 439 #ifdef __GNUC__
 440 extern int      DEBUG_Printf(int chn, const char* format, ...) __attribute__((format (printf,2,3)));
 441 #else
 442 extern int      DEBUG_Printf(int chn, const char* format, ...);
 443 #endif
 444 extern DBG_INTVAR*      DEBUG_GetIntVar(const char*);
 445
 446   /* Choose your allocator! */
 447 #if 1
 448 /* this one is libc's fast one */
 449 extern void*    DEBUG_XMalloc(size_t size);
 450 extern void*    DEBUG_XReAlloc(void *ptr, size_t size);
 451 extern char*    DEBUG_XStrDup(const char *str);
 452
 453 #define DBG_alloc(x)            DEBUG_XMalloc(x)
 454 #define DBG_realloc(x,y)        DEBUG_XReAlloc(x,y)
 455 #define DBG_free(x)             free(x)
 456 #define DBG_strdup(x)           DEBUG_XStrDup(x)
 457 #else
 458 /* this one is slow (takes 5 minutes to load the debugger on my machine),
 459    but is pretty crash-proof (can step through malloc() without problems,
 460    malloc() arena (and other heaps) can be totally wasted and it'll still
 461    work, etc... if someone could make optimized routines so it wouldn't
 462    take so long to load, it could be made default) */
 463 #include "heap.h"
 464 #define DBG_alloc(x) HeapAlloc(dbg_heap,0,x)
 465 #define DBG_realloc(x,y) HeapRealloc(dbg_heap,0,x,y)
 466 #define DBG_free(x) HeapFree(dbg_heap,0,x)
 467 #define DBG_strdup(x) HEAP_strdupA(dbg_heap,0,x)
 468 #define DBG_need_heap
 469 extern HANDLE dbg_heap;
 470 #endif
 471
 472 #define DEBUG_STATUS_OFFSET             0x80003000
 473 #define DEBUG_STATUS_INTERNAL_ERROR     (DEBUG_STATUS_OFFSET+0)
 474 #define DEBUG_STATUS_NO_SYMBOL          (DEBUG_STATUS_OFFSET+1)
 475 #define DEBUG_STATUS_DIV_BY_ZERO        (DEBUG_STATUS_OFFSET+2)
 476 #define DEBUG_STATUS_BAD_TYPE           (DEBUG_STATUS_OFFSET+3)
 477
 478 extern DBG_INTVAR               DEBUG_IntVars[];
 479
 480 #define  DBG_IVARNAME(_var)     DEBUG_IV_##_var
 481 #define  DBG_IVARSTRUCT(_var)   DEBUG_IntVars[DBG_IVARNAME(_var)]
 482 #define  DBG_IVAR(_var)         (*(DBG_IVARSTRUCT(_var).pval))
 483 #define  INTERNAL_VAR(_var,_val,_ref,_typ) DBG_IVARNAME(_var),
 484 enum debug_int_var {
 485 #include "intvar.h"
 486    DBG_IV_LAST
 487 };
 488 #undef   INTERNAL_VAR
 489
 490 #endif  /* __WINE_DEBUGGER_H */