GetDeviceCaps: make sure the devCaps field is not NULL before
[wine.git] / debugger / debugger.h
blob9516d201b9ada27b0cc922116d73f092db05c8df
1 /*
2 * Debugger definitions
4 * Copyright 1995 Alexandre Julliard
5 */
7 #ifndef __WINE_DEBUGGER_H
8 #define __WINE_DEBUGGER_H
10 #include <sys/types.h> /* u_long ... */
11 #include <assert.h>
12 #include "windef.h"
13 #include "winbase.h"
14 #include "wine/exception.h"
16 #ifdef __i386__
17 #define STEP_FLAG 0x00000100 /* single step flag */
18 #define V86_FLAG 0x00020000
19 #endif
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
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;
51 typedef struct
53 DWORD seg; /* 0xffffffff means current default segment (cs or ds) */
54 DWORD off;
55 } DBG_ADDR;
57 typedef struct
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
68 DBG_ADDR addr;
69 } DBG_VALUE;
71 struct list_id
73 char * sourcefile;
74 int line;
77 struct wine_lines {
78 unsigned long line_number;
79 DBG_ADDR pc_offset;
82 struct symbol_info
84 struct name_hash * sym;
85 struct list_id list;
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
93 * function.
95 struct wine_locals {
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;
106 enum exec_mode
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.
122 #define DBG_BREAK 0
123 #define DBG_WATCH 1
125 typedef struct
127 DBG_ADDR addr;
128 WORD enabled : 1,
129 type : 1,
130 is32 : 1,
131 refcount : 13;
132 WORD skipcount;
133 union {
134 struct {
135 BYTE opcode;
136 BOOL (*func)(void);
137 } b;
138 struct {
139 BYTE rw : 1,
140 len : 2;
141 BYTE reg;
142 DWORD oldval;
143 } w;
144 } u;
145 struct expr * condition;
146 } DBG_BREAKPOINT;
148 enum dbg_mode
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"
158 for more info. */
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. */
168 } THREADNAME_INFO;
170 typedef struct tagDBG_THREAD {
171 struct tagDBG_PROCESS* process;
172 HANDLE handle;
173 DWORD tid;
174 LPVOID start;
175 LPVOID teb;
176 int wait_for_first_exception;
177 enum dbg_mode dbg_mode;
178 enum exec_mode dbg_exec_mode;
179 int dbg_exec_count;
180 DBG_BREAKPOINT stepOverBP;
181 char name[9];
182 struct tagDBG_THREAD* next;
183 struct tagDBG_THREAD* prev;
184 } DBG_THREAD;
186 typedef struct tagDBG_PROCESS {
187 HANDLE handle;
188 DWORD pid;
189 DBG_THREAD* threads;
190 int num_threads;
191 unsigned continue_on_first_exception;
192 struct tagDBG_MODULE** modules;
193 int num_modules;
194 unsigned long dbg_hdr_addr;
196 * This is an index we use to keep track of the debug information
197 * when we have multiple sources. We use the same database to also
198 * allow us to do an 'info shared' type of deal, and we use the index
199 * to eliminate duplicates.
201 int next_index;
202 struct tagDBG_PROCESS* next;
203 struct tagDBG_PROCESS* prev;
204 } DBG_PROCESS;
206 extern DBG_PROCESS* DEBUG_CurrProcess;
207 extern DBG_THREAD* DEBUG_CurrThread;
208 extern DWORD DEBUG_CurrTid;
209 extern DWORD DEBUG_CurrPid;
210 extern CONTEXT DEBUG_context;
212 #define DEBUG_READ_MEM(addr, buf, len) \
213 (ReadProcessMemory(DEBUG_CurrProcess->handle, (addr), (buf), (len), NULL))
215 #define DEBUG_WRITE_MEM(addr, buf, len) \
216 (WriteProcessMemory(DEBUG_CurrProcess->handle, (addr), (buf), (len), NULL))
218 #define DEBUG_READ_MEM_VERBOSE(addr, buf, len) \
219 (DEBUG_READ_MEM((addr), (buf), (len)) || (DEBUG_InvalLinAddr( addr ),0))
221 #define DEBUG_WRITE_MEM_VERBOSE(addr, buf, len) \
222 (DEBUG_WRITE_MEM((addr), (buf), (len)) || (DEBUG_InvalLinAddr( addr ),0))
224 enum DbgInfoLoad {DIL_DEFERRED, DIL_LOADED, DIL_NOINFO, DIL_ERROR};
225 enum DbgModuleType {DMT_UNKNOWN, DMT_ELF, DMT_NE, DMT_PE};
227 typedef struct tagDBG_MODULE {
228 void* load_addr;
229 unsigned long size;
230 char* module_name;
231 enum DbgInfoLoad dil;
232 enum DbgModuleType type;
233 unsigned char main;
234 short int dbg_index;
235 HMODULE handle;
236 struct tagMSC_DBG_INFO* msc_info;
237 struct tagELF_DBG_INFO* elf_info;
238 } DBG_MODULE;
240 typedef struct {
241 DWORD val;
242 const char* name;
243 LPDWORD pval;
244 struct datatype* type;
245 } DBG_INTVAR;
247 #define OFFSET_OF(__c,__f) ((int)(((char*)&(((__c*)0)->__f))-((char*)0)))
249 /* from winelib.so */
250 extern void DEBUG_ExternalDebugger(void);
252 /* debugger/break.c */
253 extern void DEBUG_SetBreakpoints( BOOL set );
254 extern void DEBUG_AddBreakpoint( const DBG_VALUE *addr, BOOL (*func)(void) );
255 extern void DEBUG_AddBreakpointFromId( const char *name, int lineno );
256 extern void DEBUG_AddBreakpointFromLineno( int lineno );
257 extern void DEBUG_AddWatchpoint( const DBG_VALUE *addr, int is_write );
258 extern void DEBUG_AddWatchpointFromId( const char *name, int lineno );
259 extern void DEBUG_DelBreakpoint( int num );
260 extern void DEBUG_EnableBreakpoint( int num, BOOL enable );
261 extern void DEBUG_InfoBreakpoints(void);
262 extern BOOL DEBUG_HandleTrap(void);
263 extern BOOL DEBUG_ShouldContinue( DBG_ADDR *addr, DWORD code, enum exec_mode mode,
264 int * count );
265 extern void DEBUG_SuspendExecution( void );
266 extern enum exec_mode DEBUG_RestartExecution( enum exec_mode mode, int count );
267 extern BOOL DEBUG_IsFctReturn(void);
268 extern int DEBUG_AddBPCondition(int bpnum, struct expr * exp);
270 /* debugger/db_disasm.c */
271 extern void DEBUG_Disasm( DBG_ADDR *addr, int display );
273 /* debugger/dbg.y */
274 extern BOOL DEBUG_Parser(void);
275 extern void DEBUG_Exit( DWORD );
277 /* debugger/debug.l */
278 extern void DEBUG_FlushSymbols(void);
280 /* debugger/display.c */
281 extern int DEBUG_DoDisplay(void);
282 extern int DEBUG_AddDisplay(struct expr * exp, int count, char format);
283 extern int DEBUG_DoDisplay(void);
284 extern int DEBUG_DelDisplay(int displaynum);
285 extern int DEBUG_InfoDisplay(void);
287 /* debugger/editline.c */
288 extern char * readline(const char *);
289 extern void add_history(char *);
291 /* debugger/expr.c */
292 extern void DEBUG_FreeExprMem(void);
293 struct expr * DEBUG_IntVarExpr(const char* name);
294 struct expr * DEBUG_SymbolExpr(const char * name);
295 struct expr * DEBUG_ConstExpr(int val);
296 struct expr * DEBUG_StringExpr(const char * str);
297 struct expr * DEBUG_SegAddr(struct expr *, struct expr *);
298 struct expr * DEBUG_USConstExpr(unsigned int val);
299 struct expr * DEBUG_BinopExpr(int oper, struct expr *, struct expr *);
300 struct expr * DEBUG_UnopExpr(int oper, struct expr *);
301 struct expr * DEBUG_StructPExpr(struct expr *, const char * element);
302 struct expr * DEBUG_StructExpr(struct expr *, const char * element);
303 struct expr * DEBUG_ArrayExpr(struct expr *, struct expr * index);
304 struct expr * DEBUG_CallExpr(const char *, int nargs, ...);
305 struct expr * DEBUG_TypeCastExpr(struct datatype *, struct expr *);
306 extern DBG_VALUE DEBUG_EvalExpr(struct expr *);
307 extern int DEBUG_DelDisplay(int displaynum);
308 extern struct expr * DEBUG_CloneExpr(const struct expr * exp);
309 extern int DEBUG_FreeExpr(struct expr * exp);
310 extern int DEBUG_DisplayExpr(const struct expr * exp);
312 /* debugger/hash.c */
313 extern struct name_hash * DEBUG_AddSymbol( const char *name,
314 const DBG_VALUE *addr,
315 const char *sourcefile,
316 int flags);
317 extern BOOL DEBUG_GetSymbolValue( const char * name, const int lineno,
318 DBG_VALUE *addr, int );
319 extern BOOL DEBUG_SetSymbolValue( const char * name, const DBG_VALUE *addr );
320 extern const char * DEBUG_FindNearestSymbol( const DBG_ADDR *addr, int flag,
321 struct name_hash ** rtn,
322 unsigned int ebp,
323 struct list_id * source);
324 extern void DEBUG_ReadSymbolTable( const char * filename );
325 extern void DEBUG_AddLineNumber( struct name_hash * func, int line_num,
326 unsigned long offset );
327 extern struct wine_locals *
328 DEBUG_AddLocal( struct name_hash * func, int regno,
329 int offset,
330 int pc_start,
331 int pc_end,
332 char * name);
333 extern int DEBUG_CheckLinenoStatus(const DBG_ADDR *addr);
334 extern void DEBUG_GetFuncInfo(struct list_id * ret, const char * file,
335 const char * func);
336 extern int DEBUG_SetSymbolSize(struct name_hash * sym, unsigned int len);
337 extern int DEBUG_SetSymbolBPOff(struct name_hash * sym, unsigned int len);
338 extern int DEBUG_GetSymbolAddr(struct name_hash * sym, DBG_ADDR * addr);
339 extern int DEBUG_cmp_sym(const void * p1, const void * p2);
340 extern BOOL DEBUG_GetLineNumberAddr( const struct name_hash *, const int lineno,
341 DBG_ADDR *addr, int bp_flag );
343 extern int DEBUG_SetLocalSymbolType(struct wine_locals * sym,
344 struct datatype * type);
345 extern BOOL DEBUG_Normalize(struct name_hash * nh );
347 /* debugger/info.c */
348 extern void DEBUG_PrintBasic( const DBG_VALUE* value, int count, char format );
349 extern struct symbol_info DEBUG_PrintAddress( const DBG_ADDR *addr,
350 enum dbg_mode mode, int flag );
351 extern void DEBUG_Help(void);
352 extern void DEBUG_HelpInfo(void);
353 extern struct symbol_info DEBUG_PrintAddressAndArgs( const DBG_ADDR *addr,
354 enum dbg_mode mode,
355 unsigned int ebp,
356 int flag );
357 extern void DEBUG_InfoClass(const char* clsName);
358 extern void DEBUG_WalkClasses(void);
359 extern void DEBUG_WalkModref(DWORD p);
360 extern void DEBUG_DumpModule(DWORD mod);
361 extern void DEBUG_WalkModules(void);
362 extern void DEBUG_WalkProcess(void);
363 extern void DEBUG_WalkThreads(void);
364 extern void DEBUG_DumpQueue(DWORD q);
365 extern void DEBUG_WalkQueues(void);
366 extern void DEBUG_InfoSegments(DWORD s, int v);
367 extern void DEBUG_InfoVirtual(void);
368 extern void DEBUG_InfoWindow(HWND hWnd);
369 extern void DEBUG_WalkWindows(HWND hWnd, int indent);
371 /* debugger/memory.c */
372 extern int DEBUG_ReadMemory( const DBG_VALUE* value );
373 extern void DEBUG_WriteMemory( const DBG_VALUE* val, int value );
374 extern void DEBUG_ExamineMemory( const DBG_VALUE *addr, int count, char format);
375 extern void DEBUG_InvalAddr( const DBG_ADDR* addr );
376 extern void DEBUG_InvalLinAddr( void* addr );
377 extern DWORD DEBUG_ToLinear( const DBG_ADDR *address );
378 extern void DEBUG_GetCurrentAddress( DBG_ADDR * );
379 extern BOOL DEBUG_GrabAddress( DBG_VALUE* value, BOOL fromCode );
380 extern enum dbg_mode DEBUG_GetSelectorType( WORD sel );
381 #ifdef __i386__
382 extern void DEBUG_FixAddress( DBG_ADDR *address, DWORD def );
383 extern int DEBUG_IsSelectorSystem( WORD sel );
384 #endif
386 /* debugger/module.c */
387 extern int DEBUG_LoadEntryPoints( const char * prefix );
388 extern void DEBUG_LoadModule32( const char* name, HANDLE hFile, DWORD base );
389 extern DBG_MODULE* DEBUG_AddModule(const char* name, enum DbgModuleType type,
390 void* mod_addr, u_long size, HMODULE hmod);
391 extern DBG_MODULE* DEBUG_FindModuleByName(const char* name, enum DbgModuleType type);
392 extern DBG_MODULE* DEBUG_FindModuleByHandle(HANDLE handle, enum DbgModuleType type);
393 extern DBG_MODULE* DEBUG_GetProcessMainModule(DBG_PROCESS* process);
394 extern DBG_MODULE* DEBUG_RegisterPEModule(HMODULE, u_long load_addr, u_long size,
395 const char* name);
396 extern DBG_MODULE* DEBUG_RegisterELFModule(u_long load_addr, u_long size,
397 const char* name);
398 extern enum DbgInfoLoad DEBUG_RegisterPEDebugInfo(DBG_MODULE* wmod, HANDLE hFile,
399 void* _nth, unsigned long nth_ofs);
400 extern void DEBUG_ReportDIL(enum DbgInfoLoad dil, const char* pfx,
401 const char* filename, DWORD load_addr);
402 extern void DEBUG_InfoShare(void);
404 /* debugger/msc.c */
405 extern enum DbgInfoLoad DEBUG_RegisterMSCDebugInfo(DBG_MODULE* module, HANDLE hFile,
406 void* nth, unsigned long nth_ofs);
407 extern enum DbgInfoLoad DEBUG_RegisterStabsDebugInfo(DBG_MODULE* module,
408 HANDLE hFile, void* nth,
409 unsigned long nth_ofs);
410 extern void DEBUG_InitCVDataTypes(void);
412 /* debugger/registers.c */
413 extern void DEBUG_InfoRegisters(void);
414 extern BOOL DEBUG_ValidateRegisters(void);
416 /* debugger/source.c */
417 extern void DEBUG_ShowDir(void);
418 extern void DEBUG_AddPath(const char * path);
419 extern void DEBUG_List(struct list_id * line1, struct list_id * line2,
420 int delta);
421 extern void DEBUG_NukePath(void);
422 extern void DEBUG_Disassemble(const DBG_VALUE *, const DBG_VALUE*, int offset);
423 extern BOOL DEBUG_DisassembleInstruction(DBG_ADDR *addr);
425 /* debugger/stack.c */
426 extern void DEBUG_InfoStack(void);
427 extern void DEBUG_BackTrace(BOOL noisy);
428 extern int DEBUG_InfoLocals(void);
429 extern int DEBUG_SetFrame(int newframe);
430 extern int DEBUG_GetCurrentFrame(struct name_hash ** name,
431 unsigned int * eip,
432 unsigned int * ebp);
434 /* debugger/stabs.c */
435 extern enum DbgInfoLoad DEBUG_ReadExecutableDbgInfo(const char* exe_name);
436 extern enum DbgInfoLoad DEBUG_ParseStabs(char * addr, unsigned int load_offset,
437 unsigned int staboff, int stablen,
438 unsigned int strtaboff, int strtablen);
440 /* debugger/types.c */
441 extern int DEBUG_nchar;
442 extern void DEBUG_InitTypes(void);
443 extern struct datatype * DEBUG_NewDataType(enum debug_type xtype,
444 const char * typename);
445 extern unsigned int DEBUG_TypeDerefPointer(const DBG_VALUE *value,
446 struct datatype ** newtype);
447 extern int DEBUG_AddStructElement(struct datatype * dt,
448 char * name, struct datatype * type,
449 int offset, int size);
450 extern int DEBUG_SetStructSize(struct datatype * dt, int size);
451 extern int DEBUG_SetPointerType(struct datatype * dt, struct datatype * dt2);
452 extern int DEBUG_SetArrayParams(struct datatype * dt, int min, int max,
453 struct datatype * dt2);
454 extern void DEBUG_Print( const DBG_VALUE *addr, int count, char format, int level );
455 extern unsigned int DEBUG_FindStructElement(DBG_VALUE * addr,
456 const char * ele_name, int * tmpbuf);
457 extern struct datatype * DEBUG_GetPointerType(struct datatype * dt);
458 extern int DEBUG_GetObjectSize(struct datatype * dt);
459 extern unsigned int DEBUG_ArrayIndex(const DBG_VALUE * addr, DBG_VALUE * result,
460 int index);
461 extern struct datatype * DEBUG_FindOrMakePointerType(struct datatype * reftype);
462 extern long long int DEBUG_GetExprValue(const DBG_VALUE * addr, char ** format);
463 extern int DEBUG_SetBitfieldParams(struct datatype * dt, int offset,
464 int nbits, struct datatype * dt2);
465 extern int DEBUG_CopyFieldlist(struct datatype * dt, struct datatype * dt2);
466 extern enum debug_type DEBUG_GetType(struct datatype * dt);
467 extern struct datatype * DEBUG_TypeCast(enum debug_type, const char *);
468 extern int DEBUG_PrintTypeCast(const struct datatype *);
469 extern int DEBUG_PrintType( const DBG_VALUE* addr );
471 /* debugger/winedbg.c */
472 #define DBG_CHN_MESG 1
473 #define DBG_CHN_ERR 2
474 #define DBG_CHN_WARN 4
475 #define DBG_CHN_FIXME 8
476 #define DBG_CHN_TRACE 16
477 extern void DEBUG_Output(int chn, const char* buffer, int len);
478 #ifdef __GNUC__
479 extern int DEBUG_Printf(int chn, const char* format, ...) __attribute__((format (printf,2,3)));
480 #else
481 extern int DEBUG_Printf(int chn, const char* format, ...);
482 #endif
483 extern DBG_INTVAR* DEBUG_GetIntVar(const char*);
484 extern BOOL DEBUG_Attach(DWORD pid, BOOL cofe);
485 extern void DEBUG_Run(const char* args);
486 extern int curr_frame;
488 /* Choose your allocator! */
489 #if 1
490 /* this one is libc's fast one */
491 extern void* DEBUG_XMalloc(size_t size);
492 extern void* DEBUG_XReAlloc(void *ptr, size_t size);
493 extern char* DEBUG_XStrDup(const char *str);
495 #define DBG_alloc(x) DEBUG_XMalloc(x)
496 #define DBG_realloc(x,y) DEBUG_XReAlloc(x,y)
497 #define DBG_free(x) free(x)
498 #define DBG_strdup(x) DEBUG_XStrDup(x)
499 #else
500 /* this one is slow (takes 5 minutes to load the debugger on my machine),
501 but is pretty crash-proof (can step through malloc() without problems,
502 malloc() arena (and other heaps) can be totally wasted and it'll still
503 work, etc... if someone could make optimized routines so it wouldn't
504 take so long to load, it could be made default) */
505 #include "heap.h"
506 #define DBG_alloc(x) HeapAlloc(dbg_heap,0,x)
507 #define DBG_realloc(x,y) HeapRealloc(dbg_heap,0,x,y)
508 #define DBG_free(x) HeapFree(dbg_heap,0,x)
509 #define DBG_strdup(x) HEAP_strdupA(dbg_heap,0,x)
510 #define DBG_need_heap
511 extern HANDLE dbg_heap;
512 #endif
514 #define DEBUG_STATUS_OFFSET 0x80003000
515 #define DEBUG_STATUS_INTERNAL_ERROR (DEBUG_STATUS_OFFSET+0)
516 #define DEBUG_STATUS_NO_SYMBOL (DEBUG_STATUS_OFFSET+1)
517 #define DEBUG_STATUS_DIV_BY_ZERO (DEBUG_STATUS_OFFSET+2)
518 #define DEBUG_STATUS_BAD_TYPE (DEBUG_STATUS_OFFSET+3)
520 extern DBG_INTVAR DEBUG_IntVars[];
522 #define DBG_IVARNAME(_var) DEBUG_IV_##_var
523 #define DBG_IVARSTRUCT(_var) DEBUG_IntVars[DBG_IVARNAME(_var)]
524 #define DBG_IVAR(_var) (*(DBG_IVARSTRUCT(_var).pval))
525 #define INTERNAL_VAR(_var,_val,_ref,_typ) DBG_IVARNAME(_var),
526 enum debug_int_var {
527 #include "intvar.h"
528 DBG_IV_LAST
530 #undef INTERNAL_VAR
532 #endif /* __WINE_DEBUGGER_H */