4 * Copyright 1995 Alexandre Julliard
7 #ifndef __WINE_DEBUGGER_H
8 #define __WINE_DEBUGGER_H
10 #include <sys/types.h> /* u_long ... */
14 #include "wine/exception.h"
17 #define STEP_FLAG 0x00000100 /* single step flag */
18 #define V86_FLAG 0x00020000
25 #define SYM_INVALID 0x8
26 #define SYM_TRAMPOLINE 0x10
27 #define SYM_STEP_THROUGH 0x20
29 enum debug_type {DT_BASIC, DT_POINTER, DT_ARRAY, DT_STRUCT, DT_ENUM,
30 DT_FUNC, DT_BITFIELD};
34 * Return values for DEBUG_CheckLinenoStatus. Used to determine
35 * what to do when the 'step' command is given.
37 #define FUNC_HAS_NO_LINES (0)
38 #define NOT_ON_LINENUMBER (1)
39 #define AT_LINENUMBER (2)
40 #define FUNC_IS_TRAMPOLINE (3)
43 * For constants generated by the parser, we use this datatype
45 extern struct datatype * DEBUG_TypeShortUInt;
46 extern struct datatype * DEBUG_TypeInt;
47 extern struct datatype * DEBUG_TypeIntConst;
48 extern struct datatype * DEBUG_TypeUSInt;
49 extern struct datatype * DEBUG_TypeString;
53 DWORD seg; /* 0xffffffff means current default segment (cs or ds) */
59 struct datatype* type;
60 int cookie; /* DV_??? */
61 /* DV_TARGET references an address in debugger's address space, whereas DV_HOST
62 * references the debuggee address space
64 # define DV_TARGET 0xF00D
65 # define DV_HOST 0x50DA
66 # define DV_INVALID 0x0000
78 unsigned long line_number;
84 struct name_hash * sym;
88 typedef struct wine_lines WineLineNo;
91 * This structure holds information about stack variables, function
92 * parameters, and register variables, which are all local to this
96 unsigned int regno:8; /* For register symbols */
97 signed int offset:24; /* offset from esp/ebp to symbol */
98 unsigned int pc_start; /* For RBRAC/LBRAC */
99 unsigned int pc_end; /* For RBRAC/LBRAC */
100 char * name; /* Name of symbol */
101 struct datatype * type; /* Datatype of symbol */
104 typedef struct wine_locals WineLocals;
108 EXEC_CONT, /* Continuous execution */
109 EXEC_PASS, /* Continue, passing exception to app */
110 EXEC_STEP_OVER, /* Stepping over a call to next source line */
111 EXEC_STEP_INSTR, /* Step to next source line, stepping in if needed */
112 EXEC_STEPI_OVER, /* Stepping over a call */
113 EXEC_STEPI_INSTR, /* Single-stepping an instruction */
114 EXEC_FINISH, /* Step until we exit current frame */
115 EXEC_STEP_OVER_TRAMPOLINE, /* Step over trampoline. Requires that
116 * we dig the real return value off the stack
117 * and set breakpoint there - not at the
118 * instr just after the call.
145 struct expr * condition;
150 MODE_INVALID, MODE_16, MODE_32, MODE_VM86
155 /* Wine extension; Windows doesn't have a name for this code. This is an
156 undocumented exception understood by MS VC debugger, allowing the program
157 to name a particular thread. Search google.com or deja.com for "0x406d1388"
159 #define EXCEPTION_NAME_THREAD 0x406D1388
161 /* Helper structure */
162 typedef struct tagTHREADNAME_INFO
164 DWORD dwType; /* Must be 0x1000 */
165 LPCTSTR szName; /* Pointer to name - limited to 9 bytes (8 characters + terminator) */
166 DWORD dwThreadID; /* Thread ID (-1 = caller thread) */
167 DWORD dwFlags; /* Reserved for future use. Must be zero. */
170 typedef struct tagDBG_THREAD {
171 struct tagDBG_PROCESS* process;
176 int wait_for_first_exception;
177 enum dbg_mode dbg_mode;
178 enum exec_mode dbg_exec_mode;
180 DBG_BREAKPOINT stepOverBP;
182 struct tagDBG_THREAD* next;
183 struct tagDBG_THREAD* prev;
186 typedef struct tagDBG_DELAYED_BP {
191 typedef struct tagDBG_PROCESS {
194 const char* imageName;
197 unsigned continue_on_first_exception;
198 struct tagDBG_MODULE** modules;
200 unsigned long dbg_hdr_addr;
201 DBG_DELAYED_BP* delayed_bp;
204 * This is an index we use to keep track of the debug information
205 * when we have multiple sources. We use the same database to also
206 * allow us to do an 'info shared' type of deal, and we use the index
207 * to eliminate duplicates.
210 struct tagDBG_PROCESS* next;
211 struct tagDBG_PROCESS* prev;
214 extern DBG_PROCESS* DEBUG_CurrProcess;
215 extern DBG_THREAD* DEBUG_CurrThread;
216 extern DWORD DEBUG_CurrTid;
217 extern DWORD DEBUG_CurrPid;
218 extern CONTEXT DEBUG_context;
219 extern BOOL DEBUG_interactiveP;
221 #define DEBUG_READ_MEM(addr, buf, len) \
222 (ReadProcessMemory(DEBUG_CurrProcess->handle, (addr), (buf), (len), NULL))
224 #define DEBUG_WRITE_MEM(addr, buf, len) \
225 (WriteProcessMemory(DEBUG_CurrProcess->handle, (addr), (buf), (len), NULL))
227 #define DEBUG_READ_MEM_VERBOSE(addr, buf, len) \
228 (DEBUG_READ_MEM((addr), (buf), (len)) || (DEBUG_InvalLinAddr( addr ),0))
230 #define DEBUG_WRITE_MEM_VERBOSE(addr, buf, len) \
231 (DEBUG_WRITE_MEM((addr), (buf), (len)) || (DEBUG_InvalLinAddr( addr ),0))
233 enum DbgInfoLoad {DIL_DEFERRED, DIL_LOADED, DIL_NOINFO, DIL_ERROR};
234 enum DbgModuleType {DMT_UNKNOWN, DMT_ELF, DMT_NE, DMT_PE};
236 typedef struct tagDBG_MODULE {
240 enum DbgInfoLoad dil;
241 enum DbgModuleType type;
242 unsigned short main : 1;
245 struct tagMSC_DBG_INFO* msc_info;
246 struct tagELF_DBG_INFO* elf_info;
253 struct datatype* type;
256 #define OFFSET_OF(__c,__f) ((int)(((char*)&(((__c*)0)->__f))-((char*)0)))
258 /* from winelib.so */
259 extern void DEBUG_ExternalDebugger(void);
261 /* debugger/break.c */
262 extern void DEBUG_SetBreakpoints( BOOL set );
263 extern void DEBUG_AddBreakpoint( const DBG_VALUE *addr, BOOL (*func)(void) );
264 extern void DEBUG_AddBreakpointFromId( const char *name, int lineno );
265 extern void DEBUG_AddBreakpointFromLineno( int lineno );
266 extern void DEBUG_AddWatchpoint( const DBG_VALUE *addr, int is_write );
267 extern void DEBUG_AddWatchpointFromId( const char *name );
268 extern void DEBUG_CheckDelayedBP( void );
269 extern void DEBUG_DelBreakpoint( int num );
270 extern void DEBUG_EnableBreakpoint( int num, BOOL enable );
271 extern void DEBUG_InfoBreakpoints(void);
272 extern BOOL DEBUG_HandleTrap(void);
273 extern BOOL DEBUG_ShouldContinue( DBG_ADDR *addr, DWORD code, enum exec_mode mode,
275 extern void DEBUG_SuspendExecution( void );
276 extern enum exec_mode DEBUG_RestartExecution( enum exec_mode mode, int count );
277 extern BOOL DEBUG_IsFctReturn(void);
278 extern int DEBUG_AddBPCondition(int bpnum, struct expr * exp);
280 /* debugger/db_disasm.c */
281 extern void DEBUG_Disasm( DBG_ADDR *addr, int display );
284 extern BOOL DEBUG_Parser(void);
285 extern void DEBUG_Exit( DWORD );
287 /* debugger/debug.l */
288 extern void DEBUG_FlushSymbols(void);
290 /* debugger/display.c */
291 extern int DEBUG_DoDisplay(void);
292 extern int DEBUG_AddDisplay(struct expr * exp, int count, char format);
293 extern int DEBUG_DoDisplay(void);
294 extern int DEBUG_DelDisplay(int displaynum);
295 extern int DEBUG_InfoDisplay(void);
297 /* debugger/editline.c */
298 extern char * readline(const char *);
299 extern void add_history(char *);
301 /* debugger/expr.c */
302 extern void DEBUG_FreeExprMem(void);
303 struct expr * DEBUG_IntVarExpr(const char* name);
304 struct expr * DEBUG_SymbolExpr(const char * name);
305 struct expr * DEBUG_ConstExpr(int val);
306 struct expr * DEBUG_StringExpr(const char * str);
307 struct expr * DEBUG_SegAddr(struct expr *, struct expr *);
308 struct expr * DEBUG_USConstExpr(unsigned int val);
309 struct expr * DEBUG_BinopExpr(int oper, struct expr *, struct expr *);
310 struct expr * DEBUG_UnopExpr(int oper, struct expr *);
311 struct expr * DEBUG_StructPExpr(struct expr *, const char * element);
312 struct expr * DEBUG_StructExpr(struct expr *, const char * element);
313 struct expr * DEBUG_ArrayExpr(struct expr *, struct expr * index);
314 struct expr * DEBUG_CallExpr(const char *, int nargs, ...);
315 struct expr * DEBUG_TypeCastExpr(struct datatype *, struct expr *);
316 extern DBG_VALUE DEBUG_EvalExpr(struct expr *);
317 extern int DEBUG_DelDisplay(int displaynum);
318 extern struct expr * DEBUG_CloneExpr(const struct expr * exp);
319 extern int DEBUG_FreeExpr(struct expr * exp);
320 extern int DEBUG_DisplayExpr(const struct expr * exp);
322 /* debugger/hash.c */
323 extern struct name_hash * DEBUG_AddSymbol( const char *name,
324 const DBG_VALUE *addr,
325 const char *sourcefile,
327 extern int DEBUG_GetSymbolValue( const char * name, const int lineno,
328 DBG_VALUE *addr, int );
329 extern BOOL DEBUG_SetSymbolValue( const char * name, const DBG_VALUE *addr );
330 extern const char * DEBUG_FindNearestSymbol( const DBG_ADDR *addr, int flag,
331 struct name_hash ** rtn,
333 struct list_id * source);
334 extern void DEBUG_ReadSymbolTable( const char * filename );
335 extern void DEBUG_AddLineNumber( struct name_hash * func, int line_num,
336 unsigned long offset );
337 extern struct wine_locals *
338 DEBUG_AddLocal( struct name_hash * func, int regno,
343 extern int DEBUG_CheckLinenoStatus(const DBG_ADDR *addr);
344 extern void DEBUG_GetFuncInfo(struct list_id * ret, const char * file,
346 extern int DEBUG_SetSymbolSize(struct name_hash * sym, unsigned int len);
347 extern int DEBUG_SetSymbolBPOff(struct name_hash * sym, unsigned int len);
348 extern int DEBUG_GetSymbolAddr(struct name_hash * sym, DBG_ADDR * addr);
349 extern int DEBUG_cmp_sym(const void * p1, const void * p2);
350 extern BOOL DEBUG_GetLineNumberAddr( const struct name_hash *, const int lineno,
351 DBG_ADDR *addr, int bp_flag );
353 extern int DEBUG_SetLocalSymbolType(struct wine_locals * sym,
354 struct datatype * type);
355 extern BOOL DEBUG_Normalize(struct name_hash * nh );
357 /* debugger/info.c */
358 extern void DEBUG_PrintBasic( const DBG_VALUE* value, int count, char format );
359 extern struct symbol_info DEBUG_PrintAddress( const DBG_ADDR *addr,
360 enum dbg_mode mode, int flag );
361 extern void DEBUG_Help(void);
362 extern void DEBUG_HelpInfo(void);
363 extern struct symbol_info DEBUG_PrintAddressAndArgs( const DBG_ADDR *addr,
367 extern void DEBUG_InfoClass(const char* clsName);
368 extern void DEBUG_WalkClasses(void);
369 extern void DEBUG_WalkModref(DWORD p);
370 extern void DEBUG_DumpModule(DWORD mod);
371 extern void DEBUG_WalkModules(void);
372 extern void DEBUG_WalkProcess(void);
373 extern void DEBUG_WalkThreads(void);
374 extern void DEBUG_DumpQueue(DWORD q);
375 extern void DEBUG_WalkQueues(void);
376 extern void DEBUG_InfoSegments(DWORD s, int v);
377 extern void DEBUG_InfoVirtual(void);
378 extern void DEBUG_InfoWindow(HWND hWnd);
379 extern void DEBUG_WalkWindows(HWND hWnd, int indent);
381 /* debugger/memory.c */
382 extern int DEBUG_ReadMemory( const DBG_VALUE* value );
383 extern void DEBUG_WriteMemory( const DBG_VALUE* val, int value );
384 extern void DEBUG_ExamineMemory( const DBG_VALUE *addr, int count, char format);
385 extern void DEBUG_InvalAddr( const DBG_ADDR* addr );
386 extern void DEBUG_InvalLinAddr( void* addr );
387 extern DWORD DEBUG_ToLinear( const DBG_ADDR *address );
388 extern void DEBUG_GetCurrentAddress( DBG_ADDR * );
389 extern BOOL DEBUG_GrabAddress( DBG_VALUE* value, BOOL fromCode );
390 extern enum dbg_mode DEBUG_GetSelectorType( WORD sel );
392 extern void DEBUG_FixAddress( DBG_ADDR *address, DWORD def );
393 extern int DEBUG_IsSelectorSystem( WORD sel );
396 /* debugger/module.c */
397 extern int DEBUG_LoadEntryPoints( const char * prefix );
398 extern void DEBUG_LoadModule32( const char* name, HANDLE hFile, DWORD base );
399 extern DBG_MODULE* DEBUG_AddModule(const char* name, enum DbgModuleType type,
400 void* mod_addr, u_long size, HMODULE hmod);
401 extern DBG_MODULE* DEBUG_FindModuleByName(const char* name, enum DbgModuleType type);
402 extern DBG_MODULE* DEBUG_FindModuleByHandle(HANDLE handle, enum DbgModuleType type);
403 extern DBG_MODULE* DEBUG_FindModuleByAddr(void* addr, enum DbgModuleType type);
404 extern DBG_MODULE* DEBUG_GetProcessMainModule(DBG_PROCESS* process);
405 extern DBG_MODULE* DEBUG_RegisterPEModule(HMODULE, u_long load_addr, u_long size,
407 extern DBG_MODULE* DEBUG_RegisterELFModule(u_long load_addr, u_long size,
409 extern enum DbgInfoLoad DEBUG_RegisterPEDebugInfo(DBG_MODULE* wmod, HANDLE hFile,
410 void* _nth, unsigned long nth_ofs);
411 extern void DEBUG_ReportDIL(enum DbgInfoLoad dil, const char* pfx,
412 const char* filename, DWORD load_addr);
413 extern void DEBUG_InfoShare(void);
416 extern enum DbgInfoLoad DEBUG_RegisterMSCDebugInfo(DBG_MODULE* module, HANDLE hFile,
417 void* nth, unsigned long nth_ofs);
418 extern enum DbgInfoLoad DEBUG_RegisterStabsDebugInfo(DBG_MODULE* module,
419 HANDLE hFile, void* nth,
420 unsigned long nth_ofs);
421 extern void DEBUG_InitCVDataTypes(void);
423 /* debugger/registers.c */
424 extern void DEBUG_InfoRegisters(void);
425 extern BOOL DEBUG_ValidateRegisters(void);
427 /* debugger/source.c */
428 extern void DEBUG_ShowDir(void);
429 extern void DEBUG_AddPath(const char * path);
430 extern void DEBUG_List(struct list_id * line1, struct list_id * line2,
432 extern void DEBUG_NukePath(void);
433 extern void DEBUG_Disassemble(const DBG_VALUE *, const DBG_VALUE*, int offset);
434 extern BOOL DEBUG_DisassembleInstruction(DBG_ADDR *addr);
436 /* debugger/stack.c */
437 extern void DEBUG_InfoStack(void);
438 extern void DEBUG_BackTrace(DWORD threadID, BOOL noisy);
439 extern int DEBUG_InfoLocals(void);
440 extern int DEBUG_SetFrame(int newframe);
441 extern int DEBUG_GetCurrentFrame(struct name_hash ** name,
445 /* debugger/stabs.c */
446 extern enum DbgInfoLoad DEBUG_ReadExecutableDbgInfo(const char* exe_name);
447 extern enum DbgInfoLoad DEBUG_ParseStabs(char * addr, unsigned int load_offset,
448 unsigned int staboff, int stablen,
449 unsigned int strtaboff, int strtablen);
451 /* debugger/types.c */
452 extern int DEBUG_nchar;
453 extern void DEBUG_InitTypes(void);
454 extern struct datatype * DEBUG_NewDataType(enum debug_type xtype,
455 const char * typename);
456 extern unsigned int DEBUG_TypeDerefPointer(const DBG_VALUE *value,
457 struct datatype ** newtype);
458 extern int DEBUG_AddStructElement(struct datatype * dt,
459 char * name, struct datatype * type,
460 int offset, int size);
461 extern int DEBUG_SetStructSize(struct datatype * dt, int size);
462 extern int DEBUG_SetPointerType(struct datatype * dt, struct datatype * dt2);
463 extern int DEBUG_SetArrayParams(struct datatype * dt, int min, int max,
464 struct datatype * dt2);
465 extern void DEBUG_Print( const DBG_VALUE *addr, int count, char format, int level );
466 extern unsigned int DEBUG_FindStructElement(DBG_VALUE * addr,
467 const char * ele_name, int * tmpbuf);
468 extern struct datatype * DEBUG_GetPointerType(struct datatype * dt);
469 extern int DEBUG_GetObjectSize(struct datatype * dt);
470 extern unsigned int DEBUG_ArrayIndex(const DBG_VALUE * addr, DBG_VALUE * result,
472 extern struct datatype * DEBUG_FindOrMakePointerType(struct datatype * reftype);
473 extern long long int DEBUG_GetExprValue(const DBG_VALUE * addr, char ** format);
474 extern int DEBUG_SetBitfieldParams(struct datatype * dt, int offset,
475 int nbits, struct datatype * dt2);
476 extern int DEBUG_CopyFieldlist(struct datatype * dt, struct datatype * dt2);
477 extern enum debug_type DEBUG_GetType(struct datatype * dt);
478 extern struct datatype * DEBUG_TypeCast(enum debug_type, const char *);
479 extern int DEBUG_PrintTypeCast(const struct datatype *);
480 extern int DEBUG_PrintType( const DBG_VALUE* addr );
482 /* debugger/winedbg.c */
483 #define DBG_CHN_MESG 1
484 #define DBG_CHN_ERR 2
485 #define DBG_CHN_WARN 4
486 #define DBG_CHN_FIXME 8
487 #define DBG_CHN_TRACE 16
488 extern void DEBUG_Output(int chn, const char* buffer, int len);
490 extern int DEBUG_Printf(int chn, const char* format, ...) __attribute__((format (printf,2,3)));
492 extern int DEBUG_Printf(int chn, const char* format, ...);
494 extern DBG_INTVAR* DEBUG_GetIntVar(const char*);
495 extern BOOL DEBUG_Attach(DWORD pid, BOOL cofe);
496 extern void DEBUG_Run(const char* args);
497 extern DBG_PROCESS* DEBUG_GetProcess(DWORD pid);
498 extern DBG_THREAD* DEBUG_GetThread(DBG_PROCESS* p, DWORD tid);
499 extern int curr_frame;
501 /* Choose your allocator! */
503 /* this one is libc's fast one */
504 extern void* DEBUG_XMalloc(size_t size);
505 extern void* DEBUG_XReAlloc(void *ptr, size_t size);
506 extern char* DEBUG_XStrDup(const char *str);
508 #define DBG_alloc(x) DEBUG_XMalloc(x)
509 #define DBG_realloc(x,y) DEBUG_XReAlloc(x,y)
510 #define DBG_free(x) free(x)
511 #define DBG_strdup(x) DEBUG_XStrDup(x)
513 /* this one is slow (takes 5 minutes to load the debugger on my machine),
514 but is pretty crash-proof (can step through malloc() without problems,
515 malloc() arena (and other heaps) can be totally wasted and it'll still
516 work, etc... if someone could make optimized routines so it wouldn't
517 take so long to load, it could be made default) */
518 #define DBG_alloc(x) HeapAlloc(dbg_heap,0,x)
519 #define DBG_realloc(x,y) HeapRealloc(dbg_heap,0,x,y)
520 #define DBG_free(x) HeapFree(dbg_heap,0,x)
521 inline static LPSTR DBG_strdup( LPCSTR str )
523 INT len = strlen(str) + 1;
524 LPSTR p = DBG_alloc( len );
525 if (p) memcpy( p, str, len );
528 #define DBG_need_heap
529 extern HANDLE dbg_heap;
532 #define DEBUG_STATUS_OFFSET 0x80003000
533 #define DEBUG_STATUS_INTERNAL_ERROR (DEBUG_STATUS_OFFSET+0)
534 #define DEBUG_STATUS_NO_SYMBOL (DEBUG_STATUS_OFFSET+1)
535 #define DEBUG_STATUS_DIV_BY_ZERO (DEBUG_STATUS_OFFSET+2)
536 #define DEBUG_STATUS_BAD_TYPE (DEBUG_STATUS_OFFSET+3)
538 extern DBG_INTVAR DEBUG_IntVars[];
540 #define DBG_IVARNAME(_var) DEBUG_IV_##_var
541 #define DBG_IVARSTRUCT(_var) DEBUG_IntVars[DBG_IVARNAME(_var)]
542 #define DBG_IVAR(_var) (*(DBG_IVARSTRUCT(_var).pval))
543 #define INTERNAL_VAR(_var,_val,_ref,_typ) DBG_IVARNAME(_var),
550 #endif /* __WINE_DEBUGGER_H */