include/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 "windef.h"
  12 #include "miscemu.h"
  13
  14 #define STEP_FLAG 0x100 /* single step flag */
  15
  16 #define SYM_FUNC         0x0
  17 #define SYM_DATA         0x1
  18 #define SYM_WIN32        0x2
  19 #define SYM_WINE         0x4
  20 #define SYM_INVALID      0x8
  21 #define SYM_TRAMPOLINE   0x10
  22 #define SYM_STEP_THROUGH 0x20
  23
  24 enum    debug_type {DT_BASIC, DT_CONST, DT_POINTER, DT_ARRAY, DT_STRUCT, DT_ENUM, DT_TYPEDEF, DT_FUNC, DT_BITFIELD};
  25
  26
  27 /*
  28  * Return values for DEBUG_CheckLinenoStatus.  Used to determine
  29  * what to do when the 'step' command is given.
  30  */
  31 #define FUNC_HAS_NO_LINES       (0)
  32 #define NOT_ON_LINENUMBER       (1)
  33 #define AT_LINENUMBER           (2)
  34 #define FUNC_IS_TRAMPOLINE      (3)
  35
  36 /*
  37  * For constants generated by the parser, we use this datatype
  38  */
  39 extern struct datatype * DEBUG_TypeInt;
  40 extern struct datatype * DEBUG_TypeIntConst;
  41 extern struct datatype * DEBUG_TypeUSInt;
  42 extern struct datatype * DEBUG_TypeString;
  43
  44 typedef struct
  45 {
  46     struct datatype * type;
  47     DWORD seg;  /* 0xffffffff means current default segment (cs or ds) */
  48     DWORD off;
  49 } DBG_ADDR;
  50
  51 struct list_id
  52 {
  53     char * sourcefile;
  54     int    line;
  55 };
  56
  57 struct  wine_lines {
  58   unsigned long         line_number;
  59   DBG_ADDR              pc_offset;
  60 };
  61
  62 struct symbol_info
  63 {
  64   struct name_hash * sym;
  65   struct list_id     list;
  66 };
  67
  68 typedef struct wine_lines WineLineNo;
  69
  70 /*
  71  * This structure holds information about stack variables, function
  72  * parameters, and register variables, which are all local to this
  73  * function.
  74  */
  75 struct  wine_locals {
  76   unsigned int          regno:8;        /* For register symbols */
  77   signed int            offset:24;      /* offset from esp/ebp to symbol */
  78   unsigned int          pc_start;       /* For RBRAC/LBRAC */
  79   unsigned int          pc_end;         /* For RBRAC/LBRAC */
  80   char                * name;           /* Name of symbol */
  81   struct datatype     * type;           /* Datatype of symbol */
  82 };
  83
  84 typedef struct wine_locals WineLocals;
  85
  86
  87 #define DBG_V86_MODULE(seg) ((seg)>>16)
  88 #define IS_SELECTOR_V86(seg) DBG_V86_MODULE(seg)
  89
  90 #define DBG_FIX_ADDR_SEG(addr,default) { \
  91       if ((addr)->seg == 0xffffffff) (addr)->seg = (default); \
  92       if (!IS_SELECTOR_V86((addr)->seg)) \
  93       if (IS_SELECTOR_SYSTEM((addr)->seg)) (addr)->seg = 0; }
  94
  95 #define DBG_ADDR_TO_LIN(addr) \
  96     (IS_SELECTOR_V86((addr)->seg) \
  97       ? (char*)(DOSMEM_MemoryBase(DBG_V86_MODULE((addr)->seg)) + \
  98          ((((addr)->seg)&0xFFFF)<<4)+(addr)->off) : \
  99     (IS_SELECTOR_SYSTEM((addr)->seg) ? (char *)(addr)->off \
 100       : (char *)PTR_SEG_OFF_TO_LIN((addr)->seg,(addr)->off)))
 101
 102 #define DBG_CHECK_READ_PTR(addr,len) \
 103     (!DEBUG_IsBadReadPtr((addr),(len)) || \
 104      (fprintf(stderr,"*** Invalid address "), \
 105       DEBUG_PrintAddress((addr),dbg_mode, FALSE), \
 106       fprintf(stderr,"\n"),0))
 107
 108 #define DBG_CHECK_WRITE_PTR(addr,len) \
 109     (!DEBUG_IsBadWritePtr((addr),(len)) || \
 110      (fprintf(stderr,"*** Invalid address "), \
 111       DEBUG_PrintAddress(addr,dbg_mode, FALSE), \
 112       fprintf(stderr,"\n"),0))
 113
 114 #ifdef REG_SP  /* Some Sun includes define this */
 115 #undef REG_SP
 116 #endif
 117
 118 enum debug_regs
 119 {
 120     REG_EAX, REG_EBX, REG_ECX, REG_EDX, REG_ESI,
 121     REG_EDI, REG_EBP, REG_EFL, REG_EIP, REG_ESP,
 122     REG_AX, REG_BX, REG_CX, REG_DX, REG_SI,
 123     REG_DI, REG_BP, REG_FL, REG_IP, REG_SP,
 124     REG_CS, REG_DS, REG_ES, REG_SS, REG_FS, REG_GS
 125 };
 126
 127
 128 enum exec_mode
 129 {
 130     EXEC_CONT,       /* Continuous execution */
 131     EXEC_PASS,       /* Continue, passing exception to app */
 132     EXEC_STEP_OVER,  /* Stepping over a call to next source line */
 133     EXEC_STEP_INSTR,  /* Step to next source line, stepping in if needed */
 134     EXEC_STEPI_OVER,  /* Stepping over a call */
 135     EXEC_STEPI_INSTR,  /* Single-stepping an instruction */
 136     EXEC_FINISH,                /* Step until we exit current frame */
 137     EXEC_STEP_OVER_TRAMPOLINE  /* Step over trampoline.  Requires that
 138                                 * we dig the real return value off the stack
 139                                 * and set breakpoint there - not at the
 140                                 * instr just after the call.
 141                                 */
 142 };
 143
 144 extern CONTEXT DEBUG_context;  /* debugger/registers.c */
 145 extern unsigned int dbg_mode;
 146 extern HANDLE dbg_heap;
 147
 148   /* debugger/break.c */
 149 extern void DEBUG_SetBreakpoints( BOOL set );
 150 extern int DEBUG_FindBreakpoint( const DBG_ADDR *addr );
 151 extern void DEBUG_AddBreakpoint( const DBG_ADDR *addr );
 152 extern void DEBUG_DelBreakpoint( int num );
 153 extern void DEBUG_EnableBreakpoint( int num, BOOL enable );
 154 extern void DEBUG_InfoBreakpoints(void);
 155 extern void DEBUG_AddTaskEntryBreakpoint( HTASK16 hTask );
 156 extern BOOL DEBUG_HandleTrap(void);
 157 extern BOOL DEBUG_ShouldContinue( enum exec_mode mode, int * count );
 158 extern enum exec_mode DEBUG_RestartExecution( enum exec_mode mode, int count );
 159 extern BOOL DEBUG_IsFctReturn(void);
 160
 161   /* debugger/db_disasm.c */
 162 extern void DEBUG_Disasm( DBG_ADDR *addr, int display );
 163
 164   /* debugger/expr.c */
 165 extern void DEBUG_FreeExprMem(void);
 166 struct expr * DEBUG_RegisterExpr(enum debug_regs);
 167 struct expr * DEBUG_SymbolExpr(const char * name);
 168 struct expr * DEBUG_ConstExpr(int val);
 169 struct expr * DEBUG_StringExpr(const char * str);
 170 struct expr * DEBUG_SegAddr(struct expr *, struct expr *);
 171 struct expr * DEBUG_USConstExpr(unsigned int val);
 172 struct expr * DEBUG_BinopExpr(int oper, struct expr *, struct expr *);
 173 struct expr * DEBUG_UnopExpr(int oper, struct expr *);
 174 struct expr * DEBUG_StructPExpr(struct expr *, const char * element);
 175 struct expr * DEBUG_StructExpr(struct expr *, const char * element);
 176 struct expr * DEBUG_ArrayExpr(struct expr *, struct expr * index);
 177 struct expr * DEBUG_CallExpr(const char *, int nargs, ...);
 178 struct expr * DEBUG_TypeCastExpr(struct datatype *, struct expr *);
 179 extern   int  DEBUG_ExprValue(DBG_ADDR *, unsigned int *);
 180 DBG_ADDR DEBUG_EvalExpr(struct expr *);
 181 extern int DEBUG_DelDisplay(int displaynum);
 182 extern struct expr * DEBUG_CloneExpr(struct expr * exp);
 183 extern int DEBUG_FreeExpr(struct expr * exp);
 184 extern int DEBUG_DisplayExpr(struct expr * exp);
 185
 186   /* more debugger/break.c */
 187 extern int DEBUG_AddBPCondition(int bpnum, struct expr * exp);
 188
 189   /* debugger/display.c */
 190 extern int DEBUG_DoDisplay(void);
 191 extern int DEBUG_AddDisplay(struct expr * exp, int count, char format);
 192 extern int DEBUG_DoDisplay(void);
 193 extern int DEBUG_DelDisplay(int displaynum);
 194 extern int DEBUG_InfoDisplay(void);
 195
 196   /* debugger/hash.c */
 197 extern struct name_hash * DEBUG_AddSymbol( const char *name,
 198                                            const DBG_ADDR *addr,
 199                                            const char * sourcefile,
 200                                            int flags);
 201 extern struct name_hash * DEBUG_AddInvSymbol( const char *name,
 202                                            const DBG_ADDR *addr,
 203                                            const char * sourcefile);
 204 extern BOOL DEBUG_GetSymbolValue( const char * name, const int lineno,
 205                                     DBG_ADDR *addr, int );
 206 extern BOOL DEBUG_SetSymbolValue( const char * name, const DBG_ADDR *addr );
 207 extern const char * DEBUG_FindNearestSymbol( const DBG_ADDR *addr, int flag,
 208                                              struct name_hash ** rtn,
 209                                              unsigned int ebp,
 210                                              struct list_id * source);
 211 extern void DEBUG_ReadSymbolTable( const char * filename );
 212 extern int  DEBUG_LoadEntryPoints( const char * prefix );
 213 extern void DEBUG_AddLineNumber( struct name_hash * func, int line_num,
 214                      unsigned long offset );
 215 extern struct wine_locals *
 216             DEBUG_AddLocal( struct name_hash * func, int regno,
 217                             int offset,
 218                             int pc_start,
 219                             int pc_end,
 220                             char * name);
 221 extern int DEBUG_CheckLinenoStatus(const DBG_ADDR *addr);
 222 extern void DEBUG_GetFuncInfo(struct list_id * ret, const char * file,
 223                               const char * func);
 224 extern int DEBUG_SetSymbolSize(struct name_hash * sym, unsigned int len);
 225 extern int DEBUG_SetSymbolBPOff(struct name_hash * sym, unsigned int len);
 226 extern int DEBUG_GetSymbolAddr(struct name_hash * sym, DBG_ADDR * addr);
 227 extern int DEBUG_cmp_sym(const void * p1, const void * p2);
 228 extern BOOL DEBUG_GetLineNumberAddr( struct name_hash *, const int lineno,
 229                                 DBG_ADDR *addr, int bp_flag );
 230
 231 extern int DEBUG_SetLocalSymbolType(struct wine_locals * sym,
 232                                     struct datatype * type);
 233 BOOL DEBUG_Normalize(struct name_hash * nh );
 234
 235   /* debugger/info.c */
 236 extern void DEBUG_PrintBasic( const DBG_ADDR *addr, int count, char format );
 237 extern struct symbol_info DEBUG_PrintAddress( const DBG_ADDR *addr,
 238                                               int addrlen, int flag );
 239 extern void DEBUG_Help(void);
 240 extern void DEBUG_HelpInfo(void);
 241 extern struct symbol_info DEBUG_PrintAddressAndArgs( const DBG_ADDR *addr,
 242                                                      int addrlen,
 243                                                      unsigned int ebp,
 244                                                      int flag );
 245
 246   /* debugger/memory.c */
 247 extern BOOL DEBUG_IsBadReadPtr( const DBG_ADDR *address, int size );
 248 extern BOOL DEBUG_IsBadWritePtr( const DBG_ADDR *address, int size );
 249 extern int DEBUG_ReadMemory( const DBG_ADDR *address );
 250 extern void DEBUG_WriteMemory( const DBG_ADDR *address, int value );
 251 extern void DEBUG_ExamineMemory( const DBG_ADDR *addr, int count, char format);
 252
 253   /* debugger/registers.c */
 254 extern void DEBUG_SetRegister( enum debug_regs reg, int val );
 255 extern int DEBUG_GetRegister( enum debug_regs reg );
 256 extern void DEBUG_InfoRegisters(void);
 257 extern BOOL DEBUG_ValidateRegisters(void);
 258 extern int DEBUG_PrintRegister(enum debug_regs reg);
 259
 260   /* debugger/stack.c */
 261 extern void DEBUG_InfoStack(void);
 262 extern void DEBUG_BackTrace(void);
 263 extern void DEBUG_SilentBackTrace(void);
 264 extern int  DEBUG_InfoLocals(void);
 265 extern int  DEBUG_SetFrame(int newframe);
 266 extern int  DEBUG_GetCurrentFrame(struct name_hash ** name,
 267                                   unsigned int * eip,
 268                                   unsigned int * ebp);
 269
 270   /* debugger/stabs.c */
 271 extern int DEBUG_ReadExecutableDbgInfo(void);
 272 extern int DEBUG_ParseStabs(char * addr, unsigned int load_offset, unsigned int staboff, int stablen, unsigned int strtaboff, int strtablen);
 273
 274   /* debugger/msc.c */
 275 extern int DEBUG_RegisterDebugInfo( HMODULE, const char *);
 276 extern int DEBUG_ProcessDeferredDebug(void);
 277 extern int DEBUG_RegisterELFDebugInfo(int load_addr, u_long size, char * name);
 278 extern void DEBUG_InfoShare(void);
 279 extern void DEBUG_InitCVDataTypes(void);
 280
 281   /* debugger/types.c */
 282 extern int DEBUG_nchar;
 283 extern void DEBUG_InitTypes(void);
 284 extern struct datatype * DEBUG_NewDataType(enum debug_type xtype,
 285                                            const char * typename);
 286 extern unsigned int
 287 DEBUG_TypeDerefPointer(DBG_ADDR * addr, struct datatype ** newtype);
 288 extern int DEBUG_AddStructElement(struct datatype * dt,
 289                                   char * name, struct datatype * type,
 290                                   int offset, int size);
 291 extern int DEBUG_SetStructSize(struct datatype * dt, int size);
 292 extern int DEBUG_SetPointerType(struct datatype * dt, struct datatype * dt2);
 293 extern int DEBUG_SetArrayParams(struct datatype * dt, int min, int max,
 294                                 struct datatype * dt2);
 295 extern void DEBUG_Print( const DBG_ADDR *addr, int count, char format, int level );
 296 extern unsigned int DEBUG_FindStructElement(DBG_ADDR * addr,
 297                                             const char * ele_name, int * tmpbuf);
 298 extern struct datatype * DEBUG_GetPointerType(struct datatype * dt);
 299 extern int DEBUG_GetObjectSize(struct datatype * dt);
 300 extern unsigned int DEBUG_ArrayIndex(DBG_ADDR * addr, DBG_ADDR * result, int index);
 301 extern struct datatype * DEBUG_FindOrMakePointerType(struct datatype * reftype);
 302 extern long long int DEBUG_GetExprValue(DBG_ADDR * addr, char ** format);
 303 extern int DEBUG_SetBitfieldParams(struct datatype * dt, int offset,
 304                                    int nbits, struct datatype * dt2);
 305 extern int DEBUG_CopyFieldlist(struct datatype * dt, struct datatype * dt2);
 306 extern enum debug_type DEBUG_GetType(struct datatype * dt);
 307 extern struct datatype * DEBUG_TypeCast(enum debug_type, const char *);
 308 extern int DEBUG_PrintTypeCast(struct datatype *);
 309
 310   /* debugger/source.c */
 311 extern void DEBUG_ShowDir(void);
 312 extern void DEBUG_AddPath(const char * path);
 313 extern void DEBUG_List(struct list_id * line1, struct list_id * line2,
 314                        int delta);
 315 extern void DEBUG_NukePath(void);
 316 extern void DEBUG_Disassemble( const DBG_ADDR *, const DBG_ADDR*, int offset );
 317
 318   /* debugger/dbg.y */
 319 extern DWORD wine_debugger( EXCEPTION_RECORD *rec, CONTEXT *context, BOOL first_chance );
 320 extern void DEBUG_Exit( DWORD exit_code );
 321
 322   /* Choose your allocator! */
 323 #if 1
 324 /* this one is libc's fast one */
 325 #include "xmalloc.h"
 326 #define DBG_alloc(x) xmalloc(x)
 327 #define DBG_realloc(x,y) xrealloc(x,y)
 328 #define DBG_free(x) free(x)
 329 #define DBG_strdup(x) xstrdup(x)
 330 #else
 331 /* this one is slow (takes 5 minutes to load the debugger on my machine),
 332    but is pretty crash-proof (can step through malloc() without problems,
 333    malloc() arena (and other heaps) can be totally wasted and it'll still
 334    work, etc... if someone could make optimized routines so it wouldn't
 335    take so long to load, it could be made default) */
 336 #include "heap.h"
 337 #define DBG_alloc(x) HEAP_xalloc(dbg_heap,0,x)
 338 #define DBG_realloc(x,y) HEAP_xrealloc(dbg_heap,0,x,y)
 339 #define DBG_free(x) HeapFree(dbg_heap,0,x)
 340 #define DBG_strdup(x) HEAP_strdupA(dbg_heap,0,x)
 341 #define DBG_need_heap
 342 #endif
 343
 344 #endif  /* __WINE_DEBUGGER_H */