dbgf.h@ 58938

Last change on this file since 58938 was 58938, checked in by vboxsync, 9 years ago
HM,DBGF: Made DBGF notify HM about changes to VMM event and interrupt breakpoints. Made HM cache the basic info wrt ring-0 loop selection, opting for using a debug loop when debugging takes place to avoid cluttering slowing down the normal execution loop. The plan is to extend the single stepping loop and to put complicated dtrace probes into the same loop. Modified the VMX loop selection already.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 82.4 KB

Line
1	/** @file
2	* DBGF - Debugger Facility.
3	*/
4
5	/*
6	* Copyright (C) 2006-2015 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___VBox_vmm_dbgf_h
27	#define ___VBox_vmm_dbgf_h
28
29	#include <VBox/types.h>
30	#include <VBox/log.h> /* LOG_ENABLED */
31	#include <VBox/vmm/vmm.h>
32	#include <VBox/vmm/dbgfsel.h>
33
34	#include <iprt/stdarg.h>
35	#include <iprt/dbg.h>
36
37	RT_C_DECLS_BEGIN
38
39
40	/** @defgroup grp_dbgf The Debugger Facility API
41	* @ingroup grp_vmm
42	* @{
43	*/
44
45	#if defined(IN_RC) \|\| defined(IN_RING0)
46	/** @defgroup grp_dbgf_rz The RZ DBGF API
47	* @{
48	*/
49	VMMRZ_INT_DECL(int) DBGFRZTrap01Handler(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCUINTREG uDr6, bool fAltStepping);
50	VMMRZ_INT_DECL(int) DBGFRZTrap03Handler(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame);
51	/** @} */
52	#endif
53
54
55
56	#ifdef IN_RING3
57
58	/**
59	* Mixed address.
60	*/
61	typedef struct DBGFADDRESS
62	{
63	/** The flat address. */
64	RTGCUINTPTR FlatPtr;
65	/** The selector offset address. */
66	RTGCUINTPTR off;
67	/** The selector. DBGF_SEL_FLAT is a legal value. */
68	RTSEL Sel;
69	/** Flags describing further details about the address. */
70	uint16_t fFlags;
71	} DBGFADDRESS;
72	/** Pointer to a mixed address. */
73	typedef DBGFADDRESS *PDBGFADDRESS;
74	/** Pointer to a const mixed address. */
75	typedef const DBGFADDRESS *PCDBGFADDRESS;
76
77	/** @name DBGFADDRESS Flags.
78	* @{ */
79	/** A 16:16 far address. */
80	#define DBGFADDRESS_FLAGS_FAR16 0
81	/** A 16:32 far address. */
82	#define DBGFADDRESS_FLAGS_FAR32 1
83	/** A 16:64 far address. */
84	#define DBGFADDRESS_FLAGS_FAR64 2
85	/** A flat address. */
86	#define DBGFADDRESS_FLAGS_FLAT 3
87	/** A physical address. */
88	#define DBGFADDRESS_FLAGS_PHYS 4
89	/** A physical address. */
90	#define DBGFADDRESS_FLAGS_RING0 5
91	/** The address type mask. */
92	#define DBGFADDRESS_FLAGS_TYPE_MASK 7
93
94	/** Set if the address is valid. */
95	#define DBGFADDRESS_FLAGS_VALID RT_BIT(3)
96
97	/** The address is within the hypervisor memoary area (HMA).
98	* If not set, the address can be assumed to be a guest address. */
99	#define DBGFADDRESS_FLAGS_HMA RT_BIT(4)
100
101	/** Checks if the mixed address is flat or not. */
102	#define DBGFADDRESS_IS_FLAT(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FLAT )
103	/** Checks if the mixed address is flat or not. */
104	#define DBGFADDRESS_IS_PHYS(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_PHYS )
105	/** Checks if the mixed address is far 16:16 or not. */
106	#define DBGFADDRESS_IS_FAR16(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR16 )
107	/** Checks if the mixed address is far 16:32 or not. */
108	#define DBGFADDRESS_IS_FAR32(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR32 )
109	/** Checks if the mixed address is far 16:64 or not. */
110	#define DBGFADDRESS_IS_FAR64(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR64 )
111	/** Checks if the mixed address is valid. */
112	#define DBGFADDRESS_IS_VALID(pAddress) ( !!((pAddress)->fFlags & DBGFADDRESS_FLAGS_VALID) )
113	/** Checks if the address is flagged as within the HMA. */
114	#define DBGFADDRESS_IS_HMA(pAddress) ( !!((pAddress)->fFlags & DBGFADDRESS_FLAGS_HMA) )
115	/** @} */
116
117	VMMR3DECL(int) DBGFR3AddrFromSelOff(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddress, RTSEL Sel, RTUINTPTR off);
118	VMMR3DECL(int) DBGFR3AddrFromSelInfoOff(PUVM pUVM, PDBGFADDRESS pAddress, PCDBGFSELINFO pSelInfo, RTUINTPTR off);
119	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrFromFlat(PUVM pUVM, PDBGFADDRESS pAddress, RTGCUINTPTR FlatPtr);
120	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrFromPhys(PUVM pUVM, PDBGFADDRESS pAddress, RTGCPHYS PhysAddr);
121	VMMR3DECL(bool) DBGFR3AddrIsValid(PUVM pUVM, PCDBGFADDRESS pAddress);
122	VMMR3DECL(int) DBGFR3AddrToPhys(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddress, PRTGCPHYS pGCPhys);
123	VMMR3DECL(int) DBGFR3AddrToHostPhys(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddress, PRTHCPHYS pHCPhys);
124	VMMR3DECL(int) DBGFR3AddrToVolatileR3Ptr(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddress, bool fReadOnly, void **ppvR3Ptr);
125	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrAdd(PDBGFADDRESS pAddress, RTGCUINTPTR uAddend);
126	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrSub(PDBGFADDRESS pAddress, RTGCUINTPTR uSubtrahend);
127
128	#endif /* IN_RING3 */
129
130
131
132	/**
133	* VMM Debug Event Type.
134	*/
135	typedef enum DBGFEVENTTYPE
136	{
137	/** Halt completed.
138	* This notifies that a halt command have been successfully completed.
139	*/
140	DBGFEVENT_HALT_DONE = 0,
141	/** Detach completed.
142	* This notifies that the detach command have been successfully completed.
143	*/
144	DBGFEVENT_DETACH_DONE,
145	/** The command from the debugger is not recognized.
146	* This means internal error or half implemented features.
147	*/
148	DBGFEVENT_INVALID_COMMAND,
149
150	/** Fatal error.
151	* This notifies a fatal error in the VMM and that the debugger get's a
152	* chance to first hand information about the the problem.
153	*/
154	DBGFEVENT_FATAL_ERROR,
155	/** Breakpoint Hit.
156	* This notifies that a breakpoint installed by the debugger was hit. The
157	* identifier of the breakpoint can be found in the DBGFEVENT::u::Bp::iBp member.
158	*/
159	DBGFEVENT_BREAKPOINT,
160	/** I/O port breakpoint.
161	* @todo not yet implemented. */
162	DBGFEVENT_BREAKPOINT_IO,
163	/** MMIO breakpoint.
164	* @todo not yet implemented. */
165	DBGFEVENT_BREAKPOINT_MMIO,
166	/** Breakpoint Hit in the Hypervisor.
167	* This notifies that a breakpoint installed by the debugger was hit. The
168	* identifier of the breakpoint can be found in the DBGFEVENT::u::Bp::iBp member.
169	*/
170	DBGFEVENT_BREAKPOINT_HYPER,
171	/** Assertion in the Hypervisor (breakpoint instruction).
172	* This notifies that a breakpoint instruction was hit in the hypervisor context.
173	*/
174	DBGFEVENT_ASSERTION_HYPER,
175	/** Single Stepped.
176	* This notifies that a single step operation was completed.
177	*/
178	DBGFEVENT_STEPPED,
179	/** Single Stepped.
180	* This notifies that a hypervisor single step operation was completed.
181	*/
182	DBGFEVENT_STEPPED_HYPER,
183	/** The developer have used the DBGFSTOP macro or the PDMDeviceDBGFSTOP function
184	* to bring up the debugger at a specific place.
185	*/
186	DBGFEVENT_DEV_STOP,
187	/** The VM is powering off.
188	* When this notification is received, the debugger thread should detach ASAP.
189	*/
190	DBGFEVENT_POWERING_OFF,
191
192	/** Hardware Interrupt break.
193	* @todo not yet implemented. */
194	DBGFEVENT_INTERRUPT_HARDWARE,
195	/** Software Interrupt break.
196	* @todo not yet implemented. */
197	DBGFEVENT_INTERRUPT_SOFTWARE,
198
199	/** The first selectable event.
200	* Whether the debugger wants or doesn't want these events can be configured
201	* via DBGFR3xxx and queried via DBGFR3yyy. */
202	DBGFEVENT_FIRST_SELECTABLE,
203	/** Tripple fault.
204	* @todo not yet implemented. */
205	DBGFEVENT_TRIPPLE_FAULT = DBGFEVENT_FIRST_SELECTABLE,
206	DBGFEVENT_XCPT_DE, /*< 0x00 - \#DE - Fault - NoErr - Integer divide error (zero/overflow). /
207	DBGFEVENT_XCPT_DB, /*< 0x01 - \#DB - trap/fault - NoErr - debug event. /
208	DBGFEVENT_XCPT_02, /*< 0x02 - Reserved for NMI, see interrupt events. /
209	DBGFEVENT_XCPT_BP, /*< 0x03 - \#BP - Trap - NoErr - Breakpoint, INT 3 instruction. /
210	DBGFEVENT_XCPT_OF, /*< 0x04 - \#OF - Trap - NoErr - Overflow, INTO instruction. /
211	DBGFEVENT_XCPT_BR, /*< 0x05 - \#BR - Fault - NoErr - BOUND Range Exceeded, BOUND instruction. /
212	DBGFEVENT_XCPT_UD, /*< 0x06 - \#UD - Fault - NoErr - Undefined(/Invalid) Opcode. /
213	DBGFEVENT_XCPT_NM, /*< 0x07 - \#NM - Fault - NoErr - Device not available, FP or (F)WAIT instruction. /
214	DBGFEVENT_XCPT_DF, /*< 0x08 - \#DF - Abort - Err=0 - Double fault. /
215	DBGFEVENT_XCPT_09, /*< 0x09 - Int9 - Fault - NoErr - Coprocessor Segment Overrun (obsolete). /
216	DBGFEVENT_XCPT_TS, /*< 0x0a - \#TS - Fault - ErrCd - Invalid TSS, Taskswitch or TSS access. /
217	DBGFEVENT_XCPT_NP, /*< 0x0b - \#NP - Fault - ErrCd - Segment not present. /
218	DBGFEVENT_XCPT_SS, /*< 0x0c - \#SS - Fault - ErrCd - Stack-Segment fault. /
219	DBGFEVENT_XCPT_GP, /*< 0x0d - \#GP - Fault - ErrCd - General protection fault. /
220	DBGFEVENT_XCPT_PF, /*< 0x0e - \#PF - Fault - ErrCd - Page fault. - interrupt gate!!! /
221	DBGFEVENT_XCPT_0f, /*< 0x0f - Rsvd - Resvd - Resvd - Intel Reserved. /
222	DBGFEVENT_XCPT_MF, /*< 0x10 - \#MF - Fault - NoErr - x86 FPU Floating-Point Error (Math fault), FP or (F)WAIT instruction. /
223	DBGFEVENT_XCPT_AC, /*< 0x11 - \#AC - Fault - Err=0 - Alignment Check. /
224	DBGFEVENT_XCPT_MC, /*< 0x12 - \#MC - Abort - NoErr - Machine Check. /
225	DBGFEVENT_XCPT_XF, /*< 0x13 - \#XF - Fault - NoErr - SIMD Floating-Point Exception. /
226	DBGFEVENT_XCPT_VE, /*< 0x14 - \#VE - Fault - Noerr - Virtualization exception. /
227	DBGFEVENT_XCPT_15, /*< 0x15 - Intel Reserved. /
228	DBGFEVENT_XCPT_16, /*< 0x16 - Intel Reserved. /
229	DBGFEVENT_XCPT_17, /*< 0x17 - Intel Reserved. /
230	DBGFEVENT_XCPT_18, /*< 0x18 - Intel Reserved. /
231	DBGFEVENT_XCPT_19, /*< 0x19 - Intel Reserved. /
232	DBGFEVENT_XCPT_1a, /*< 0x1a - Intel Reserved. /
233	DBGFEVENT_XCPT_1b, /*< 0x1b - Intel Reserved. /
234	DBGFEVENT_XCPT_1c, /*< 0x1c - Intel Reserved. /
235	DBGFEVENT_XCPT_1d, /*< 0x1d - Intel Reserved. /
236	DBGFEVENT_XCPT_1e, /*< 0x1e - \#SX - Fault - ErrCd - Security Exception. /
237	DBGFEVENT_XCPT_1f, /*< 0x1f - Intel Reserved. /
238	/** The first exception event. */
239	DBGFEVENT_XCPT_FIRST = DBGFEVENT_XCPT_DE,
240	/** The last exception event. */
241	DBGFEVENT_XCPT_LAST = DBGFEVENT_XCPT_1f,
242	/** Interrupt event.
243	* @todo not yet implemented. */
244	DBGFEVENT_INT,
245	/** Access to an unassigned I/O port.
246	* @todo not yet implemented. */
247	DBGFEVENT_IOPORT_UNASSIGNED,
248	/** Access to an unused I/O port on a device.
249	* @todo not yet implemented. */
250	DBGFEVENT_IOPORT_UNUSED,
251	/** Unassigned memory event.
252	* @todo not yet implemented. */
253	DBGFEVENT_MEMORY_UNASSIGNED,
254	/** Attempt to write to unshadowed ROM.
255	* @todo not yet implemented. */
256	DBGFEVENT_MEMORY_ROM_WRITE,
257
258	/** The first VM exit event. */
259	DBGFEVENT_EXIT_FIRST,
260	/** Exit - Task switch.
261	* @todo not yet implemented. */
262	DBGFEVENT_EXIT_TASK_SWITCH = DBGFEVENT_EXIT_FIRST,
263	/** Exit - HALT instruction.
264	* @todo not yet implemented. */
265	DBGFEVENT_EXIT_HALT,
266	/** Exit - MWAIT instruction.
267	* @todo not yet implemented. */
268	DBGFEVENT_EXIT_MWAIT,
269	/** Exit - MONITOR instruction.
270	* @todo not yet implemented. */
271	DBGFEVENT_EXIT_MONITOR,
272	/** Exit - CPUID instruction (missing stuff in raw-mode).
273	* @todo not yet implemented. */
274	DBGFEVENT_EXIT_CPUID,
275	/** Exit - INV instruction.
276	* @todo not yet implemented. */
277	DBGFEVENT_EXIT_INV,
278	/** Exit - WBINVD instruction.
279	* @todo not yet implemented. */
280	DBGFEVENT_EXIT_WBINVD,
281	/** Exit - INVLPG instruction.
282	* @todo not yet implemented. */
283	DBGFEVENT_EXIT_INVLPG,
284	/** Exit - RDTSC instruction.
285	* @todo not yet implemented. */
286	DBGFEVENT_EXIT_RDTSC,
287	/** Exit - RDTSCP instruction.
288	* @todo not yet implemented. */
289	DBGFEVENT_EXIT_RDTSCP,
290	/** Exit - RDPMC instruction.
291	* @todo not yet implemented. */
292	DBGFEVENT_EXIT_RDPMC,
293	/** Exit - RDMSR instruction.
294	* @todo not yet implemented. */
295	DBGFEVENT_EXIT_RDMSR,
296	/** Exit - WRMSR instruction.
297	* @todo not yet implemented. */
298	DBGFEVENT_EXIT_WRMSR,
299	/** Exit - CRx read instruction (missing smsw in raw-mode).
300	* @todo not yet implemented. */
301	DBGFEVENT_EXIT_CRX_READ,
302	/** Exit - CRx write instruction.
303	* @todo not yet implemented. */
304	DBGFEVENT_EXIT_CRX_WRITE,
305	/** Exit - DRx read instruction.
306	* @todo not yet implemented. */
307	DBGFEVENT_EXIT_DRX_READ,
308	/** Exit - DRx write instruction.
309	* @todo not yet implemented. */
310	DBGFEVENT_EXIT_DRx_WRITE,
311	/** Exit - PAUSE instruction (not in raw-mode).
312	* @todo not yet implemented. */
313	DBGFEVENT_EXIT_PAUSE,
314	/** Exit - XSETBV instruction.
315	* @todo not yet implemented. */
316	DBGFEVENT_EXIT_XSETBV,
317	/** Exit - VMCALL (intel) or VMMCALL (AMD) instruction.
318	* @todo not yet implemented. */
319	DBGFEVENT_EXIT_VMM_CALL,
320	/** Exit - the last common event. */
321	DBGFEVENT_EXIT_LAST_COMMON = DBGFEVENT_EXIT_VMM_CALL,
322
323	/** Exit - VT-x - First. */
324	DBGFEVENT_EXIT_VMX_FIRST,
325	/** Exit - VT-x VMCLEAR instruction.
326	* @todo not yet implemented. */
327	DBGFEVENT_EXIT_VMX_VMCLEAR = DBGFEVENT_EXIT_VMX_FIRST,
328	/** Exit - VT-x VMLAUNCH instruction.
329	* @todo not yet implemented. */
330	DBGFEVENT_EXIT_VMX_VMLAUNCH,
331	/** Exit - VT-x VMPTRLD instruction.
332	* @todo not yet implemented. */
333	DBGFEVENT_EXIT_VMX_VMPTRLD,
334	/** Exit - VT-x VMPTRST instruction.
335	* @todo not yet implemented. */
336	DBGFEVENT_EXIT_VMX_VMPTRST,
337	/** Exit - VT-x VMREAD instruction.
338	* @todo not yet implemented. */
339	DBGFEVENT_EXIT_VMX_VMREAD,
340	/** Exit - VT-x VMRESUME instruction.
341	* @todo not yet implemented. */
342	DBGFEVENT_EXIT_VMX_VMRESUME,
343	/** Exit - VT-x VMWRITE instruction.
344	* @todo not yet implemented. */
345	DBGFEVENT_EXIT_VMX_VMWRITE,
346	/** Exit - VT-x VMXOFF instruction.
347	* @todo not yet implemented. */
348	DBGFEVENT_EXIT_VMX_VMXOFF,
349	/** Exit - VT-x VMXON instruction.
350	* @todo not yet implemented. */
351	DBGFEVENT_EXIT_VMX_VMXON,
352	/** Exit - VT-x VMFUNC instruction.
353	* @todo not yet implemented. */
354	DBGFEVENT_EXIT_VMX_VMFUNC,
355	/** Exit - VT-x - Last. */
356	DBGFEVENT_EXIT_VMX_LAST = DBGFEVENT_EXIT_VMX_VMFUNC,
357
358	/** Exit - AMD-V - first */
359	DBGFEVENT_EXIT_SVM_FIRST,
360	/** Exit - AMD-V VMRUN instruction.
361	* @todo not yet implemented. */
362	DBGFEVENT_EXIT_SVM_VMRUN = DBGFEVENT_EXIT_SVM_FIRST,
363	/** Exit - AMD-V VMLOAD instruction.
364	* @todo not yet implemented. */
365	DBGFEVENT_EXIT_SVM_VMLOAD,
366	/** Exit - AMD-V VMSAVE instruction.
367	* @todo not yet implemented. */
368	DBGFEVENT_EXIT_SVM_VMSAVE,
369	/** Exit - AMD-V STGI instruction.
370	* @todo not yet implemented. */
371	DBGFEVENT_EXIT_SVM_STGI,
372	/** Exit - AMD-V CLGI instruction.
373	* @todo not yet implemented. */
374	DBGFEVENT_EXIT_SVM_CLGI,
375	/** The last ADM-V VM exit event. */
376	DBGFEVENT_EXIT_SVM_LAST = DBGFEVENT_EXIT_SVM_CLGI,
377
378	/** The last VM exit event. */
379	DBGFEVENT_EXIT_LAST = DBGFEVENT_EXIT_SVM_LAST,
380
381
382	/** End of valid event values. */
383	DBGFEVENT_END,
384	/** The usual 32-bit hack. */
385	DBGFEVENT_32BIT_HACK = 0x7fffffff
386	} DBGFEVENTTYPE;
387	AssertCompile(DBGFEVENT_XCPT_LAST - DBGFEVENT_XCPT_FIRST == 0x1f);
388
389	/**
390	* The context of an event.
391	*/
392	typedef enum DBGFEVENTCTX
393	{
394	/** The usual invalid entry. */
395	DBGFEVENTCTX_INVALID = 0,
396	/** Raw mode. */
397	DBGFEVENTCTX_RAW,
398	/** Recompiled mode. */
399	DBGFEVENTCTX_REM,
400	/** VMX / AVT mode. */
401	DBGFEVENTCTX_HM,
402	/** Hypervisor context. */
403	DBGFEVENTCTX_HYPER,
404	/** Other mode */
405	DBGFEVENTCTX_OTHER,
406
407	/** The usual 32-bit hack */
408	DBGFEVENTCTX_32BIT_HACK = 0x7fffffff
409	} DBGFEVENTCTX;
410
411	/**
412	* VMM Debug Event.
413	*/
414	typedef struct DBGFEVENT
415	{
416	/** Type. */
417	DBGFEVENTTYPE enmType;
418	/** Context */
419	DBGFEVENTCTX enmCtx;
420	/** Type specific data. */
421	union
422	{
423	/** Fatal error details. */
424	struct
425	{
426	/** The GC return code. */
427	int rc;
428	} FatalError;
429
430	/** Source location. */
431	struct
432	{
433	/** File name. */
434	R3PTRTYPE(const char *) pszFile;
435	/** Function name. */
436	R3PTRTYPE(const char *) pszFunction;
437	/** Message. */
438	R3PTRTYPE(const char *) pszMessage;
439	/** Line number. */
440	unsigned uLine;
441	} Src;
442
443	/** Assertion messages. */
444	struct
445	{
446	/** The first message. */
447	R3PTRTYPE(const char *) pszMsg1;
448	/** The second message. */
449	R3PTRTYPE(const char *) pszMsg2;
450	} Assert;
451
452	/** Breakpoint. */
453	struct DBGFEVENTBP
454	{
455	/** The identifier of the breakpoint which was hit. */
456	RTUINT iBp;
457	} Bp;
458	/** Padding for ensuring that the structure is 8 byte aligned. */
459	uint64_t au64Padding[4];
460	} u;
461	} DBGFEVENT;
462	AssertCompileSizeAlignment(DBGFEVENT, 8);
463	/** Pointer to VMM Debug Event. */
464	typedef DBGFEVENT *PDBGFEVENT;
465	/** Pointer to const VMM Debug Event. */
466	typedef const DBGFEVENT *PCDBGFEVENT;
467
468	#ifdef IN_RING3 /* The event API only works in ring-3. */
469
470	/** @def DBGFSTOP
471	* Stops the debugger raising a DBGFEVENT_DEVELOPER_STOP event.
472	*
473	* @returns VBox status code which must be propagated up to EM if not VINF_SUCCESS.
474	* @param pVM The cross context VM structure.
475	*/
476	# ifdef VBOX_STRICT
477	# define DBGFSTOP(pVM) DBGFR3EventSrc(pVM, DBGFEVENT_DEV_STOP, __FILE__, __LINE__, __PRETTY_FUNCTION__, NULL)
478	# else
479	# define DBGFSTOP(pVM) VINF_SUCCESS
480	# endif
481
482	VMMR3_INT_DECL(int) DBGFR3Init(PVM pVM);
483	VMMR3_INT_DECL(int) DBGFR3Term(PVM pVM);
484	VMMR3_INT_DECL(void) DBGFR3PowerOff(PVM pVM);
485	VMMR3_INT_DECL(void) DBGFR3Relocate(PVM pVM, RTGCINTPTR offDelta);
486	VMMR3_INT_DECL(int) DBGFR3VMMForcedAction(PVM pVM);
487	VMMR3DECL(int) DBGFR3Event(PVM pVM, DBGFEVENTTYPE enmEvent);
488	VMMR3DECL(int) DBGFR3EventSrc(PVM pVM, DBGFEVENTTYPE enmEvent, const char *pszFile, unsigned uLine,
489	const char pszFunction, const char pszFormat, ...) RT_IPRT_FORMAT_ATTR_MAYBE_NULL(6, 7);
490	VMMR3DECL(int) DBGFR3EventSrcV(PVM pVM, DBGFEVENTTYPE enmEvent, const char *pszFile, unsigned uLine,
491	const char pszFunction, const char pszFormat, va_list args) RT_IPRT_FORMAT_ATTR_MAYBE_NULL(6, 0);
492	VMMR3_INT_DECL(int) DBGFR3EventAssertion(PVM pVM, DBGFEVENTTYPE enmEvent, const char pszMsg1, const char pszMsg2);
493	VMMR3_INT_DECL(int) DBGFR3EventBreakpoint(PVM pVM, DBGFEVENTTYPE enmEvent);
494	VMMR3_INT_DECL(int) DBGFR3PrgStep(PVMCPU pVCpu);
495
496	VMMR3DECL(int) DBGFR3Attach(PUVM pUVM);
497	VMMR3DECL(int) DBGFR3Detach(PUVM pUVM);
498	VMMR3DECL(int) DBGFR3EventWait(PUVM pUVM, RTMSINTERVAL cMillies, PCDBGFEVENT *ppEvent);
499	VMMR3DECL(int) DBGFR3Halt(PUVM pUVM);
500	VMMR3DECL(bool) DBGFR3IsHalted(PUVM pUVM);
501	VMMR3DECL(int) DBGFR3QueryWaitable(PUVM pUVM);
502	VMMR3DECL(int) DBGFR3Resume(PUVM pUVM);
503	VMMR3DECL(int) DBGFR3Step(PUVM pUVM, VMCPUID idCpu);
504	VMMR3DECL(int) DBGFR3InjectNMI(PUVM pUVM, VMCPUID idCpu);
505
506	/**
507	* Event configuration array element, see DBGFR3EventConfigEx.
508	*/
509	typedef struct DBGFEVENTCONFIG
510	{
511	/** The event to configure */
512	DBGFEVENTTYPE enmType;
513	/** The new state. */
514	bool fEnabled;
515	} DBGFEVENTCONFIG;
516	/** Pointer to an event config. */
517	typedef DBGFEVENTCONFIG *PDBGFEVENTCONFIG;
518	/** Pointer to a const event config. */
519	typedef const DBGFEVENTCONFIG *PCDBGFEVENTCONFIG;
520
521	VMMR3DECL(int) DBGFR3EventConfigEx(PUVM pUVM, PCDBGFEVENTCONFIG paConfigs, size_t cConfigs);
522	VMMR3DECL(int) DBGFR3EventConfig(PUVM pUVM, DBGFEVENTTYPE enmEvent, bool fEnabled);
523	VMMR3DECL(bool) DBGFR3EventIsEnabled(PUVM pUVM, DBGFEVENTTYPE enmEvent);
524	VMMR3DECL(int) DBGFR3EventQuery(PUVM pUVM, PDBGFEVENTCONFIG paConfigs, size_t cConfigs);
525
526	/** @name DBGFINTERRUPTSTATE_XXX - interrupt break state.
527	* @{ */
528	#define DBGFINTERRUPTSTATE_DISABLED 0
529	#define DBGFINTERRUPTSTATE_ENABLED 1
530	#define DBGFINTERRUPTSTATE_DONT_TOUCH 2
531	/** @} */
532
533	/**
534	* Interrupt break state configuration entry.
535	*/
536	typedef struct DBGFINTERRUPTCONFIG
537	{
538	/** The interrupt number. */
539	uint8_t iInterrupt;
540	/** The hardware interrupt state (DBGFINTERRUPTSTATE_XXX). */
541	uint8_t enmHardState;
542	/** The software interrupt state (DBGFINTERRUPTSTATE_XXX). */
543	uint8_t enmSoftState;
544	} DBGFINTERRUPTCONFIG;
545	/** Pointer to an interrupt break state config entyr. */
546	typedef DBGFINTERRUPTCONFIG *PDBGFINTERRUPTCONFIG;
547	/** Pointer to a const interrupt break state config entyr. */
548	typedef DBGFINTERRUPTCONFIG const *PCDBGFINTERRUPTCONFIG;
549
550	VMMR3DECL(int) DBGFR3InterruptConfigEx(PUVM pUVM, PCDBGFINTERRUPTCONFIG paConfigs, size_t cConfigs);
551	VMMR3DECL(int) DBGFR3InterruptHardwareConfig(PUVM pUVM, uint8_t iInterrupt, bool fEnabled);
552	VMMR3DECL(int) DBGFR3InterruptSoftwareConfig(PUVM pUVM, uint8_t iInterrupt, bool fEnabled);
553	VMMR3DECL(int) DBGFR3InterruptHardwareIsEnabled(PUVM pUVM, uint8_t iInterrupt);
554	VMMR3DECL(int) DBGFR3InterruptSoftwareIsEnabled(PUVM pUVM, uint8_t iInterrupt);
555
556	#endif /* IN_RING3 */
557
558	/** @def DBGF_IS_EVENT_ENABLED
559	* Checks if a selectable debug event is enabled or not (fast).
560	*
561	* @returns true/false.
562	* @param a_pVM Pointer to the cross context VM structure.
563	* @param a_enmEvent The selectable event to check.
564	* @remarks Only for use internally in the VMM. Use DBGFR3EventIsEnabled elsewhere.
565	*/
566	#if defined(VBOX_STRICT) && defined(RT_COMPILER_SUPPORTS_LAMBDA)
567	# define DBGF_IS_EVENT_ENABLED(a_pVM, a_enmEvent) \
568	([](PVM a_pLambdaVM, DBGFEVENTTYPE a_enmLambdaEvent) -> bool { \
569	Assert(a_enmLambdaEvent >= DBGFEVENT_FIRST_SELECTABLE); \
570	Assert(a_enmLambdaEvent < DBGFEVENT_END); \
571	return ASMBitTest(&a_pLambdaVM->dbgf.ro.bmSelectedEvents, a_enmLambdaEvent); \
572	}(a_pVM, a_enmEvent))
573	#elif defined(VBOX_STRICT) && defined(__GNUC__)
574	# define DBGF_IS_EVENT_ENABLED(a_pVM, a_enmEvent) \
575	__extension__ ({ \
576	Assert((a_enmEvent) >= DBGFEVENT_FIRST_SELECTABLE); \
577	Assert((a_enmEvent) < DBGFEVENT_END); \
578	ASMBitTest(&(a_pVM)->dbgf.ro.bmSelectedEvents, (a_enmEvent)); \
579	})
580	#else
581	# define DBGF_IS_EVENT_ENABLED(a_pVM, a_enmEvent) \
582	ASMBitTest(&(a_pVM)->dbgf.ro.bmSelectedEvents, (a_enmEvent))
583	#endif
584
585
586	/** @def DBGF_IS_HARDWARE_INT_ENABLED
587	* Checks if hardware interrupt interception is enabled or not for an interrupt.
588	*
589	* @returns true/false.
590	* @param a_pVM Pointer to the cross context VM structure.
591	* @param a_iInterrupt Interrupt to check.
592	* @remarks Only for use internally in the VMM. Use
593	* DBGFR3InterruptHardwareIsEnabled elsewhere.
594	*/
595	#define DBGF_IS_HARDWARE_INT_ENABLED(a_pVM, a_iInterrupt) \
596	ASMBitTest(&(a_pVM)->dbgf.ro.bmHardIntBreakpoints, (uint8_t)(a_iInterrupt))
597
598	/** @def DBGF_IS_SOFTWARE_INT_ENABLED
599	* Checks if software interrupt interception is enabled or not for an interrupt.
600	*
601	* @returns true/false.
602	* @param a_pVM Pointer to the cross context VM structure.
603	* @param a_iInterrupt Interrupt to check.
604	* @remarks Only for use internally in the VMM. Use
605	* DBGFR3InterruptSoftwareIsEnabled elsewhere.
606	*/
607	#define DBGF_IS_SOFTWARE_INT_ENABLED(a_pVM, a_iInterrupt) \
608	ASMBitTest(&(a_pVM)->dbgf.ro.bmSoftIntBreakpoints, (uint8_t)(a_iInterrupt))
609
610
611
612	/** Breakpoint type. */
613	typedef enum DBGFBPTYPE
614	{
615	/** Free breakpoint entry. */
616	DBGFBPTYPE_FREE = 0,
617	/** Debug register. */
618	DBGFBPTYPE_REG,
619	/** INT 3 instruction. */
620	DBGFBPTYPE_INT3,
621	/** Recompiler. */
622	DBGFBPTYPE_REM,
623	/** Port I/O breakpoint. */
624	DBGFBPTYPE_PORT_IO,
625	/** Memory mapped I/O breakpoint. */
626	DBGFBPTYPE_MMIO,
627	/** ensure 32-bit size. */
628	DBGFBPTYPE_32BIT_HACK = 0x7fffffff
629	} DBGFBPTYPE;
630
631
632	/** @name DBGFBPIOACCESS_XXX - I/O (port + mmio) access types.
633	* @{ */
634	/** Byte sized read accesses. */
635	#define DBGFBPIOACCESS_READ_BYTE UINT32_C(0x00000001)
636	/** Word sized accesses. */
637	#define DBGFBPIOACCESS_READ_WORD UINT32_C(0x00000002)
638	/** Double word sized accesses. */
639	#define DBGFBPIOACCESS_READ_DWORD UINT32_C(0x00000004)
640	/** Quad word sized accesses - not available for I/O ports. */
641	#define DBGFBPIOACCESS_READ_QWORD UINT32_C(0x00000008)
642	/** Other sized accesses - not available for I/O ports. */
643	#define DBGFBPIOACCESS_READ_OTHER UINT32_C(0x00000010)
644	/** Read mask. */
645	#define DBGFBPIOACCESS_READ_MASK UINT32_C(0x0000001f)
646
647	/** Byte sized write accesses. */
648	#define DBGFBPIOACCESS_WRITE_BYTE UINT32_C(0x00000100)
649	/** Word sized write accesses. */
650	#define DBGFBPIOACCESS_WRITE_WORD UINT32_C(0x00000200)
651	/** Double word sized write accesses. */
652	#define DBGFBPIOACCESS_WRITE_DWORD UINT32_C(0x00000400)
653	/** Quad word sized write accesses - not available for I/O ports. */
654	#define DBGFBPIOACCESS_WRITE_QWORD UINT32_C(0x00000800)
655	/** Other sized write accesses - not available for I/O ports. */
656	#define DBGFBPIOACCESS_WRITE_OTHER UINT32_C(0x00001000)
657	/** Write mask. */
658	#define DBGFBPIOACCESS_WRITE_MASK UINT32_C(0x00001f00)
659
660	/** All kind of access (read, write, all sizes). */
661	#define DBGFBPIOACCESS_ALL UINT32_C(0x00001f1f)
662
663	/** The acceptable mask for I/O ports. */
664	#define DBGFBPIOACCESS_VALID_MASK_PORT_IO UINT32_C(0x00000303)
665	/** The acceptable mask for MMIO. */
666	#define DBGFBPIOACCESS_VALID_MASK_MMIO UINT32_C(0x00001f1f)
667	/** @} */
668
669	/**
670	* A Breakpoint.
671	*/
672	typedef struct DBGFBP
673	{
674	/** The number of breakpoint hits. */
675	uint64_t cHits;
676	/** The hit number which starts to trigger the breakpoint. */
677	uint64_t iHitTrigger;
678	/** The hit number which stops triggering the breakpoint (disables it).
679	* Use ~(uint64_t)0 if it should never stop. */
680	uint64_t iHitDisable;
681	/** The breakpoint id. */
682	uint16_t iBp;
683	/** The breakpoint status - enabled or disabled. */
684	bool fEnabled;
685	/** The breakpoint type. */
686	DBGFBPTYPE enmType;
687
688	/** Union of type specific data. */
689	union
690	{
691	/** The flat GC address breakpoint address for REG, INT3 and REM breakpoints. */
692	RTGCUINTPTR GCPtr;
693
694	/** Debug register data. */
695	struct DBGFBPREG
696	{
697	/** The flat GC address of the breakpoint. */
698	RTGCUINTPTR GCPtr;
699	/** The debug register number. */
700	uint8_t iReg;
701	/** The access type (one of the X86_DR7_RW_* value). */
702	uint8_t fType;
703	/** The access size. */
704	uint8_t cb;
705	} Reg;
706	/** Recompiler breakpoint data. */
707	struct DBGFBPINT3
708	{
709	/** The flat GC address of the breakpoint. */
710	RTGCUINTPTR GCPtr;
711	/** The byte value we replaced by the INT 3 instruction. */
712	uint8_t bOrg;
713	} Int3;
714
715	/** Recompiler breakpoint data. */
716	struct DBGFBPREM
717	{
718	/** The flat GC address of the breakpoint.
719	* (PC register value?) */
720	RTGCUINTPTR GCPtr;
721	} Rem;
722
723	/** I/O port breakpoint data. */
724	struct DBGFBPPORTIO
725	{
726	/** The first port. */
727	RTIOPORT uPort;
728	/** The number of ports. */
729	RTIOPORT cPorts;
730	/** Valid DBGFBPIOACCESS_XXX selection, max DWORD size. */
731	uint32_t fAccess;
732	} PortIo;
733
734	/** Memory mapped I/O breakpoint data. */
735	struct DBGFBPMMIO
736	{
737	/** The first MMIO address. */
738	RTGCPHYS PhysAddr;
739	/** The size of the MMIO range in bytes. */
740	uint32_t cb;
741	/** Valid DBGFBPIOACCESS_XXX selection, max DWORD size. */
742	uint32_t fAccess;
743	} Mmio;
744
745	/** Paddind to ensure that the size is identical on win32 and linux. */
746	uint64_t u64Padding[2];
747	} u;
748	} DBGFBP;
749	AssertCompileMembersAtSameOffset(DBGFBP, u.GCPtr, DBGFBP, u.Reg.GCPtr);
750	AssertCompileMembersAtSameOffset(DBGFBP, u.GCPtr, DBGFBP, u.Int3.GCPtr);
751	AssertCompileMembersAtSameOffset(DBGFBP, u.GCPtr, DBGFBP, u.Rem.GCPtr);
752
753	/** Pointer to a breakpoint. */
754	typedef DBGFBP *PDBGFBP;
755	/** Pointer to a const breakpoint. */
756	typedef const DBGFBP *PCDBGFBP;
757
758	#ifdef IN_RING3 /* The breakpoint management API is only available in ring-3. */
759	VMMR3DECL(int) DBGFR3BpSet(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
760	VMMR3DECL(int) DBGFR3BpSetReg(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable,
761	uint8_t fType, uint8_t cb, uint32_t *piBp);
762	VMMR3DECL(int) DBGFR3BpSetREM(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
763	VMMR3DECL(int) DBGFR3BpSetPortIo(PUVM pUVM, RTIOPORT uPort, RTIOPORT cPorts, uint32_t fAccess,
764	uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
765	VMMR3DECL(int) DBGFR3BpSetMmio(PUVM pUVM, RTGCPHYS GCPhys, uint32_t cb, uint32_t fAccess,
766	uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
767	VMMR3DECL(int) DBGFR3BpClear(PUVM pUVM, uint32_t iBp);
768	VMMR3DECL(int) DBGFR3BpEnable(PUVM pUVM, uint32_t iBp);
769	VMMR3DECL(int) DBGFR3BpDisable(PUVM pUVM, uint32_t iBp);
770
771	/**
772	* Breakpoint enumeration callback function.
773	*
774	* @returns VBox status code.
775	* The enumeration stops on failure status and VINF_CALLBACK_RETURN.
776	* @param pUVM The user mode VM handle.
777	* @param pvUser The user argument.
778	* @param pBp Pointer to the breakpoint information. (readonly)
779	*/
780	typedef DECLCALLBACK(int) FNDBGFBPENUM(PUVM pUVM, void *pvUser, PCDBGFBP pBp);
781	/** Pointer to a breakpoint enumeration callback function. */
782	typedef FNDBGFBPENUM *PFNDBGFBPENUM;
783
784	VMMR3DECL(int) DBGFR3BpEnum(PUVM pUVM, PFNDBGFBPENUM pfnCallback, void *pvUser);
785	#endif /* IN_RING3 */
786
787	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR7(PVM pVM);
788	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR0(PVM pVM);
789	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR1(PVM pVM);
790	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR2(PVM pVM);
791	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR3(PVM pVM);
792	VMM_INT_DECL(bool) DBGFBpIsHwArmed(PVM pVM);
793	VMM_INT_DECL(bool) DBGFBpIsHwIoArmed(PVM pVM);
794	VMM_INT_DECL(bool) DBGFIsStepping(PVMCPU pVCpu);
795	VMM_INT_DECL(VBOXSTRICTRC) DBGFBpCheckIo(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, RTIOPORT uIoPort, uint8_t cbValue);
796
797
798	#ifdef IN_RING3 /* The CPU mode API only works in ring-3. */
799	VMMR3DECL(CPUMMODE) DBGFR3CpuGetMode(PUVM pUVM, VMCPUID idCpu);
800	VMMR3DECL(VMCPUID) DBGFR3CpuGetCount(PUVM pUVM);
801	VMMR3DECL(bool) DBGFR3CpuIsIn64BitCode(PUVM pUVM, VMCPUID idCpu);
802	#endif
803
804
805
806	#ifdef IN_RING3 /* The info callbacks API only works in ring-3. */
807
808	/**
809	* Info helper callback structure.
810	*/
811	typedef struct DBGFINFOHLP
812	{
813	/**
814	* Print formatted string.
815	*
816	* @param pHlp Pointer to this structure.
817	* @param pszFormat The format string.
818	* @param ... Arguments.
819	*/
820	DECLCALLBACKMEMBER(void, pfnPrintf)(PCDBGFINFOHLP pHlp, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(2, 3);
821
822	/**
823	* Print formatted string.
824	*
825	* @param pHlp Pointer to this structure.
826	* @param pszFormat The format string.
827	* @param args Argument list.
828	*/
829	DECLCALLBACKMEMBER(void, pfnPrintfV)(PCDBGFINFOHLP pHlp, const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(2, 0);
830	} DBGFINFOHLP;
831
832
833	/**
834	* Info handler, device version.
835	*
836	* @param pDevIns The device instance which registered the info.
837	* @param pHlp Callback functions for doing output.
838	* @param pszArgs Argument string. Optional and specific to the handler.
839	*/
840	typedef DECLCALLBACK(void) FNDBGFHANDLERDEV(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs);
841	/** Pointer to a FNDBGFHANDLERDEV function. */
842	typedef FNDBGFHANDLERDEV *PFNDBGFHANDLERDEV;
843
844	/**
845	* Info handler, USB device version.
846	*
847	* @param pUsbIns The USB device instance which registered the info.
848	* @param pHlp Callback functions for doing output.
849	* @param pszArgs Argument string. Optional and specific to the handler.
850	*/
851	typedef DECLCALLBACK(void) FNDBGFHANDLERUSB(PPDMUSBINS pUsbIns, PCDBGFINFOHLP pHlp, const char *pszArgs);
852	/** Pointer to a FNDBGFHANDLERUSB function. */
853	typedef FNDBGFHANDLERUSB *PFNDBGFHANDLERUSB;
854
855	/**
856	* Info handler, driver version.
857	*
858	* @param pDrvIns The driver instance which registered the info.
859	* @param pHlp Callback functions for doing output.
860	* @param pszArgs Argument string. Optional and specific to the handler.
861	*/
862	typedef DECLCALLBACK(void) FNDBGFHANDLERDRV(PPDMDRVINS pDrvIns, PCDBGFINFOHLP pHlp, const char *pszArgs);
863	/** Pointer to a FNDBGFHANDLERDRV function. */
864	typedef FNDBGFHANDLERDRV *PFNDBGFHANDLERDRV;
865
866	/**
867	* Info handler, internal version.
868	*
869	* @param pVM The cross context VM structure.
870	* @param pHlp Callback functions for doing output.
871	* @param pszArgs Argument string. Optional and specific to the handler.
872	*/
873	typedef DECLCALLBACK(void) FNDBGFHANDLERINT(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
874	/** Pointer to a FNDBGFHANDLERINT function. */
875	typedef FNDBGFHANDLERINT *PFNDBGFHANDLERINT;
876
877	/**
878	* Info handler, external version.
879	*
880	* @param pvUser User argument.
881	* @param pHlp Callback functions for doing output.
882	* @param pszArgs Argument string. Optional and specific to the handler.
883	*/
884	typedef DECLCALLBACK(void) FNDBGFHANDLEREXT(void pvUser, PCDBGFINFOHLP pHlp, const char pszArgs);
885	/** Pointer to a FNDBGFHANDLEREXT function. */
886	typedef FNDBGFHANDLEREXT *PFNDBGFHANDLEREXT;
887
888
889	/** @name Flags for the info registration functions.
890	* @{ */
891	/** The handler must run on the EMT. */
892	#define DBGFINFO_FLAGS_RUN_ON_EMT RT_BIT(0)
893	/** @} */
894
895	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDevice(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERDEV pfnHandler, PPDMDEVINS pDevIns);
896	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDriver(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler, PPDMDRVINS pDrvIns);
897	VMMR3_INT_DECL(int) DBGFR3InfoRegisterInternal(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERINT pfnHandler);
898	VMMR3_INT_DECL(int) DBGFR3InfoRegisterInternalEx(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERINT pfnHandler, uint32_t fFlags);
899	VMMR3DECL(int) DBGFR3InfoRegisterExternal(PUVM pUVM, const char pszName, const char pszDesc, PFNDBGFHANDLEREXT pfnHandler, void *pvUser);
900	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char *pszName);
901	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName);
902	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterInternal(PVM pVM, const char *pszName);
903	VMMR3DECL(int) DBGFR3InfoDeregisterExternal(PUVM pUVM, const char *pszName);
904	VMMR3DECL(int) DBGFR3Info(PUVM pUVM, const char pszName, const char pszArgs, PCDBGFINFOHLP pHlp);
905	VMMR3DECL(int) DBGFR3InfoEx(PUVM pUVM, VMCPUID idCpu, const char pszName, const char pszArgs, PCDBGFINFOHLP pHlp);
906	VMMR3DECL(int) DBGFR3InfoLogRel(PUVM pUVM, const char pszName, const char pszArgs);
907	VMMR3DECL(int) DBGFR3InfoStdErr(PUVM pUVM, const char pszName, const char pszArgs);
908	VMMR3_INT_DECL(int) DBGFR3InfoMulti(PVM pVM, const char pszIncludePat, const char pszExcludePat,
909	const char *pszSepFmt, PCDBGFINFOHLP pHlp);
910
911	/** @def DBGFR3_INFO_LOG
912	* Display a piece of info writing to the log if enabled.
913	*
914	* @param a_pVM The shared VM handle.
915	* @param a_pszName The identifier of the info to display.
916	* @param a_pszArgs Arguments to the info handler.
917	*/
918	#ifdef LOG_ENABLED
919	# define DBGFR3_INFO_LOG(a_pVM, a_pszName, a_pszArgs) \
920	do { \
921	if (LogIsEnabled()) \
922	DBGFR3Info((a_pVM)->pUVM, a_pszName, a_pszArgs, NULL); \
923	} while (0)
924	#else
925	# define DBGFR3_INFO_LOG(a_pVM, a_pszName, a_pszArgs) do { } while (0)
926	#endif
927
928	/**
929	* Enumeration callback for use with DBGFR3InfoEnum.
930	*
931	* @returns VBox status code.
932	* A status code indicating failure will end the enumeration
933	* and DBGFR3InfoEnum will return with that status code.
934	* @param pUVM The user mode VM handle.
935	* @param pszName Info identifier name.
936	* @param pszDesc The description.
937	*/
938	typedef DECLCALLBACK(int) FNDBGFINFOENUM(PUVM pUVM, const char pszName, const char pszDesc, void *pvUser);
939	/** Pointer to a FNDBGFINFOENUM function. */
940	typedef FNDBGFINFOENUM *PFNDBGFINFOENUM;
941
942	VMMR3DECL(int) DBGFR3InfoEnum(PUVM pUVM, PFNDBGFINFOENUM pfnCallback, void *pvUser);
943	VMMR3DECL(PCDBGFINFOHLP) DBGFR3InfoLogHlp(void);
944	VMMR3DECL(PCDBGFINFOHLP) DBGFR3InfoLogRelHlp(void);
945
946	#endif /* IN_RING3 */
947
948
949	#ifdef IN_RING3 /* The log contrl API only works in ring-3. */
950	VMMR3DECL(int) DBGFR3LogModifyGroups(PUVM pUVM, const char *pszGroupSettings);
951	VMMR3DECL(int) DBGFR3LogModifyFlags(PUVM pUVM, const char *pszFlagSettings);
952	VMMR3DECL(int) DBGFR3LogModifyDestinations(PUVM pUVM, const char *pszDestSettings);
953	#endif /* IN_RING3 */
954
955	#ifdef IN_RING3 /* The debug information management APIs only works in ring-3. */
956
957	/** Max length (including '\\0') of a symbol name. */
958	#define DBGF_SYMBOL_NAME_LENGTH 512
959
960	/**
961	* Debug symbol.
962	*/
963	typedef struct DBGFSYMBOL
964	{
965	/** Symbol value (address). */
966	RTGCUINTPTR Value;
967	/** Symbol size. */
968	uint32_t cb;
969	/** Symbol Flags. (reserved). */
970	uint32_t fFlags;
971	/** Symbol name. */
972	char szName[DBGF_SYMBOL_NAME_LENGTH];
973	} DBGFSYMBOL;
974	/** Pointer to debug symbol. */
975	typedef DBGFSYMBOL *PDBGFSYMBOL;
976	/** Pointer to const debug symbol. */
977	typedef const DBGFSYMBOL *PCDBGFSYMBOL;
978
979	/**
980	* Debug line number information.
981	*/
982	typedef struct DBGFLINE
983	{
984	/** Address. */
985	RTGCUINTPTR Address;
986	/** Line number. */
987	uint32_t uLineNo;
988	/** Filename. */
989	char szFilename[260];
990	} DBGFLINE;
991	/** Pointer to debug line number. */
992	typedef DBGFLINE *PDBGFLINE;
993	/** Pointer to const debug line number. */
994	typedef const DBGFLINE *PCDBGFLINE;
995
996	/** @name Address spaces aliases.
997	* @{ */
998	/** The guest global address space. */
999	#define DBGF_AS_GLOBAL ((RTDBGAS)-1)
1000	/** The guest kernel address space.
1001	* This is usually resolves to the same as DBGF_AS_GLOBAL. */
1002	#define DBGF_AS_KERNEL ((RTDBGAS)-2)
1003	/** The physical address space. */
1004	#define DBGF_AS_PHYS ((RTDBGAS)-3)
1005	/** Raw-mode context. */
1006	#define DBGF_AS_RC ((RTDBGAS)-4)
1007	/** Ring-0 context. */
1008	#define DBGF_AS_R0 ((RTDBGAS)-5)
1009	/** Raw-mode context and then global guest context.
1010	* When used for looking up information, it works as if the call was first made
1011	* with DBGF_AS_RC and then on failure with DBGF_AS_GLOBAL. When called for
1012	* making address space changes, it works as if DBGF_AS_RC was used. */
1013	#define DBGF_AS_RC_AND_GC_GLOBAL ((RTDBGAS)-6)
1014
1015	/** The first special one. */
1016	#define DBGF_AS_FIRST DBGF_AS_RC_AND_GC_GLOBAL
1017	/** The last special one. */
1018	#define DBGF_AS_LAST DBGF_AS_GLOBAL
1019	#endif
1020	/** The number of special address space handles. */
1021	#define DBGF_AS_COUNT (6U)
1022	#ifdef IN_RING3
1023	/** Converts an alias handle to an array index. */
1024	#define DBGF_AS_ALIAS_2_INDEX(hAlias) \
1025	( (uintptr_t)(hAlias) - (uintptr_t)DBGF_AS_FIRST )
1026	/** Predicat macro that check if the specified handle is an alias. */
1027	#define DBGF_AS_IS_ALIAS(hAlias) \
1028	( DBGF_AS_ALIAS_2_INDEX(hAlias) < DBGF_AS_COUNT )
1029	/** Predicat macro that check if the specified alias is a fixed one or not. */
1030	#define DBGF_AS_IS_FIXED_ALIAS(hAlias) \
1031	( DBGF_AS_ALIAS_2_INDEX(hAlias) < (uintptr_t)DBGF_AS_PHYS - (uintptr_t)DBGF_AS_FIRST + 1U )
1032
1033	/** @} */
1034
1035	VMMR3DECL(RTDBGCFG) DBGFR3AsGetConfig(PUVM pUVM);
1036
1037	VMMR3DECL(int) DBGFR3AsAdd(PUVM pUVM, RTDBGAS hDbgAs, RTPROCESS ProcId);
1038	VMMR3DECL(int) DBGFR3AsDelete(PUVM pUVM, RTDBGAS hDbgAs);
1039	VMMR3DECL(int) DBGFR3AsSetAlias(PUVM pUVM, RTDBGAS hAlias, RTDBGAS hAliasFor);
1040	VMMR3DECL(RTDBGAS) DBGFR3AsResolve(PUVM pUVM, RTDBGAS hAlias);
1041	VMMR3DECL(RTDBGAS) DBGFR3AsResolveAndRetain(PUVM pUVM, RTDBGAS hAlias);
1042	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByName(PUVM pUVM, const char *pszName);
1043	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByPid(PUVM pUVM, RTPROCESS ProcId);
1044
1045	VMMR3DECL(int) DBGFR3AsLoadImage(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName,
1046	RTLDRARCH enmArch, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags);
1047	VMMR3DECL(int) DBGFR3AsLoadMap(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, RTGCUINTPTR uSubtrahend, uint32_t fFlags);
1048	VMMR3DECL(int) DBGFR3AsLinkModule(PUVM pUVM, RTDBGAS hDbgAs, RTDBGMOD hMod, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags);
1049	VMMR3DECL(int) DBGFR3AsUnlinkModuleByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszModName);
1050
1051	VMMR3DECL(int) DBGFR3AsSymbolByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1052	PRTGCINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
1053	VMMR3DECL(PRTDBGSYMBOL) DBGFR3AsSymbolByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t Flags,
1054	PRTGCINTPTR poffDisp, PRTDBGMOD phMod);
1055	VMMR3DECL(int) DBGFR3AsSymbolByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
1056
1057	VMMR3DECL(int) DBGFR3AsLineByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1058	PRTGCINTPTR poffDisp, PRTDBGLINE pLine, PRTDBGMOD phMod);
1059	VMMR3DECL(PRTDBGLINE) DBGFR3AsLineByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1060	PRTGCINTPTR poffDisp, PRTDBGMOD phMod);
1061
1062	#endif /* IN_RING3 */
1063
1064	#ifdef IN_RING3 /* The stack API only works in ring-3. */
1065
1066	/**
1067	* Return type.
1068	*/
1069	typedef enum DBGFRETRUNTYPE
1070	{
1071	/** The usual invalid 0 value. */
1072	DBGFRETURNTYPE_INVALID = 0,
1073	/** Near 16-bit return. */
1074	DBGFRETURNTYPE_NEAR16,
1075	/** Near 32-bit return. */
1076	DBGFRETURNTYPE_NEAR32,
1077	/** Near 64-bit return. */
1078	DBGFRETURNTYPE_NEAR64,
1079	/** Far 16:16 return. */
1080	DBGFRETURNTYPE_FAR16,
1081	/** Far 16:32 return. */
1082	DBGFRETURNTYPE_FAR32,
1083	/** Far 16:64 return. */
1084	DBGFRETURNTYPE_FAR64,
1085	/** 16-bit iret return (e.g. real or 286 protect mode). */
1086	DBGFRETURNTYPE_IRET16,
1087	/** 32-bit iret return. */
1088	DBGFRETURNTYPE_IRET32,
1089	/** 32-bit iret return. */
1090	DBGFRETURNTYPE_IRET32_PRIV,
1091	/** 32-bit iret return to V86 mode. */
1092	DBGFRETURNTYPE_IRET32_V86,
1093	/** @todo 64-bit iret return. */
1094	DBGFRETURNTYPE_IRET64,
1095	/** The end of the valid return types. */
1096	DBGFRETURNTYPE_END,
1097	/** The usual 32-bit blowup. */
1098	DBGFRETURNTYPE_32BIT_HACK = 0x7fffffff
1099	} DBGFRETURNTYPE;
1100
1101	/**
1102	* Figures the size of the return state on the stack.
1103	*
1104	* @returns number of bytes. 0 if invalid parameter.
1105	* @param enmRetType The type of return.
1106	*/
1107	DECLINLINE(unsigned) DBGFReturnTypeSize(DBGFRETURNTYPE enmRetType)
1108	{
1109	switch (enmRetType)
1110	{
1111	case DBGFRETURNTYPE_NEAR16: return 2;
1112	case DBGFRETURNTYPE_NEAR32: return 4;
1113	case DBGFRETURNTYPE_NEAR64: return 8;
1114	case DBGFRETURNTYPE_FAR16: return 4;
1115	case DBGFRETURNTYPE_FAR32: return 4;
1116	case DBGFRETURNTYPE_FAR64: return 8;
1117	case DBGFRETURNTYPE_IRET16: return 6;
1118	case DBGFRETURNTYPE_IRET32: return 4*3;
1119	case DBGFRETURNTYPE_IRET32_PRIV: return 4*5;
1120	case DBGFRETURNTYPE_IRET32_V86: return 4*9;
1121	case DBGFRETURNTYPE_IRET64:
1122	default:
1123	return 0;
1124	}
1125	}
1126
1127
1128	/** Pointer to stack frame info. */
1129	typedef struct DBGFSTACKFRAME *PDBGFSTACKFRAME;
1130	/** Pointer to const stack frame info. */
1131	typedef struct DBGFSTACKFRAME const *PCDBGFSTACKFRAME;
1132	/**
1133	* Info about a stack frame.
1134	*/
1135	typedef struct DBGFSTACKFRAME
1136	{
1137	/** Frame number. */
1138	uint32_t iFrame;
1139	/** Frame flags. */
1140	uint32_t fFlags;
1141	/** The frame address.
1142	* The off member is [e\|r]bp and the Sel member is ss. */
1143	DBGFADDRESS AddrFrame;
1144	/** The stack address of the frame.
1145	* The off member is [e\|r]sp and the Sel member is ss. */
1146	DBGFADDRESS AddrStack;
1147	/** The program counter (PC) address of the frame.
1148	* The off member is [e\|r]ip and the Sel member is cs. */
1149	DBGFADDRESS AddrPC;
1150	/** Pointer to the symbol nearest the program counter (PC). NULL if not found. */
1151	PRTDBGSYMBOL pSymPC;
1152	/** Pointer to the linnumber nearest the program counter (PC). NULL if not found. */
1153	PRTDBGLINE pLinePC;
1154
1155	/** The return frame address.
1156	* The off member is [e\|r]bp and the Sel member is ss. */
1157	DBGFADDRESS AddrReturnFrame;
1158	/** The return stack address.
1159	* The off member is [e\|r]sp and the Sel member is ss. */
1160	DBGFADDRESS AddrReturnStack;
1161	/** The way this frame returns to the next one. */
1162	DBGFRETURNTYPE enmReturnType;
1163
1164	/** The program counter (PC) address which the frame returns to.
1165	* The off member is [e\|r]ip and the Sel member is cs. */
1166	DBGFADDRESS AddrReturnPC;
1167	/** Pointer to the symbol nearest the return PC. NULL if not found. */
1168	PRTDBGSYMBOL pSymReturnPC;
1169	/** Pointer to the linnumber nearest the return PC. NULL if not found. */
1170	PRTDBGLINE pLineReturnPC;
1171
1172	/** 32-bytes of stack arguments. */
1173	union
1174	{
1175	/** 64-bit view */
1176	uint64_t au64[4];
1177	/** 32-bit view */
1178	uint32_t au32[8];
1179	/** 16-bit view */
1180	uint16_t au16[16];
1181	/** 8-bit view */
1182	uint8_t au8[32];
1183	} Args;
1184
1185	/** Pointer to the next frame.
1186	* Might not be used in some cases, so consider it internal. */
1187	PCDBGFSTACKFRAME pNextInternal;
1188	/** Pointer to the first frame.
1189	* Might not be used in some cases, so consider it internal. */
1190	PCDBGFSTACKFRAME pFirstInternal;
1191	} DBGFSTACKFRAME;
1192
1193	/** @name DBGFSTACKFRAME Flags.
1194	* @{ */
1195	/** Set if the content of the frame is filled in by DBGFR3StackWalk() and can be used
1196	* to construct the next frame. */
1197	# define DBGFSTACKFRAME_FLAGS_ALL_VALID RT_BIT(0)
1198	/** This is the last stack frame we can read.
1199	* This flag is not set if the walk stop because of max dept or recursion. */
1200	# define DBGFSTACKFRAME_FLAGS_LAST RT_BIT(1)
1201	/** This is the last record because we detected a loop. */
1202	# define DBGFSTACKFRAME_FLAGS_LOOP RT_BIT(2)
1203	/** This is the last record because we reached the maximum depth. */
1204	# define DBGFSTACKFRAME_FLAGS_MAX_DEPTH RT_BIT(3)
1205	/** 16-bit frame. */
1206	# define DBGFSTACKFRAME_FLAGS_16BIT RT_BIT(4)
1207	/** 32-bit frame. */
1208	# define DBGFSTACKFRAME_FLAGS_32BIT RT_BIT(5)
1209	/** 64-bit frame. */
1210	# define DBGFSTACKFRAME_FLAGS_64BIT RT_BIT(6)
1211	/** @} */
1212
1213	/** @name DBGFCODETYPE
1214	* @{ */
1215	typedef enum DBGFCODETYPE
1216	{
1217	/** The usual invalid 0 value. */
1218	DBGFCODETYPE_INVALID = 0,
1219	/** Stack walk for guest code. */
1220	DBGFCODETYPE_GUEST,
1221	/** Stack walk for hypervisor code. */
1222	DBGFCODETYPE_HYPER,
1223	/** Stack walk for ring 0 code. */
1224	DBGFCODETYPE_RING0,
1225	/** The usual 32-bit blowup. */
1226	DBGFCODETYPE_32BIT_HACK = 0x7fffffff
1227	} DBGFCODETYPE;
1228	/** @} */
1229
1230	VMMR3DECL(int) DBGFR3StackWalkBegin(PUVM pUVM, VMCPUID idCpu, DBGFCODETYPE enmCodeType,
1231	PCDBGFSTACKFRAME *ppFirstFrame);
1232	VMMR3DECL(int) DBGFR3StackWalkBeginEx(PUVM pUVM, VMCPUID idCpu, DBGFCODETYPE enmCodeType, PCDBGFADDRESS pAddrFrame,
1233	PCDBGFADDRESS pAddrStack,PCDBGFADDRESS pAddrPC,
1234	DBGFRETURNTYPE enmReturnType, PCDBGFSTACKFRAME *ppFirstFrame);
1235	VMMR3DECL(PCDBGFSTACKFRAME) DBGFR3StackWalkNext(PCDBGFSTACKFRAME pCurrent);
1236	VMMR3DECL(void) DBGFR3StackWalkEnd(PCDBGFSTACKFRAME pFirstFrame);
1237
1238	#endif /* IN_RING3 */
1239
1240
1241	#ifdef IN_RING3 /* The disassembly API only works in ring-3. */
1242
1243	/** @name Flags to pass to DBGFR3DisasInstrEx().
1244	* @{ */
1245	/** Disassemble the current guest instruction, with annotations. */
1246	#define DBGF_DISAS_FLAGS_CURRENT_GUEST RT_BIT(0)
1247	/** Disassemble the current hypervisor instruction, with annotations. */
1248	#define DBGF_DISAS_FLAGS_CURRENT_HYPER RT_BIT(1)
1249	/** No annotations for current context. */
1250	#define DBGF_DISAS_FLAGS_NO_ANNOTATION RT_BIT(2)
1251	/** No symbol lookup. */
1252	#define DBGF_DISAS_FLAGS_NO_SYMBOLS RT_BIT(3)
1253	/** No instruction bytes. */
1254	#define DBGF_DISAS_FLAGS_NO_BYTES RT_BIT(4)
1255	/** No address in the output. */
1256	#define DBGF_DISAS_FLAGS_NO_ADDRESS RT_BIT(5)
1257	/** Probably a hypervisor instruction. */
1258	#define DBGF_DISAS_FLAGS_HYPER RT_BIT(6)
1259	/** Disassemble original unpatched bytes (PATM). */
1260	#define DBGF_DISAS_FLAGS_UNPATCHED_BYTES RT_BIT(7)
1261	/** Annotate patched instructions. */
1262	#define DBGF_DISAS_FLAGS_ANNOTATE_PATCHED RT_BIT(8)
1263	/** Disassemble in the default mode of the specific context. */
1264	#define DBGF_DISAS_FLAGS_DEFAULT_MODE UINT32_C(0x00000000)
1265	/** Disassemble in 16-bit mode. */
1266	#define DBGF_DISAS_FLAGS_16BIT_MODE UINT32_C(0x10000000)
1267	/** Disassemble in 16-bit mode with real mode address translation. */
1268	#define DBGF_DISAS_FLAGS_16BIT_REAL_MODE UINT32_C(0x20000000)
1269	/** Disassemble in 32-bit mode. */
1270	#define DBGF_DISAS_FLAGS_32BIT_MODE UINT32_C(0x30000000)
1271	/** Disassemble in 64-bit mode. */
1272	#define DBGF_DISAS_FLAGS_64BIT_MODE UINT32_C(0x40000000)
1273	/** The disassembly mode mask. */
1274	#define DBGF_DISAS_FLAGS_MODE_MASK UINT32_C(0x70000000)
1275	/** Mask containing the valid flags. */
1276	#define DBGF_DISAS_FLAGS_VALID_MASK UINT32_C(0x700001ff)
1277	/** @} */
1278
1279	/** Special flat selector. */
1280	#define DBGF_SEL_FLAT 1
1281
1282	VMMR3DECL(int) DBGFR3DisasInstrEx(PUVM pUVM, VMCPUID idCpu, RTSEL Sel, RTGCPTR GCPtr, uint32_t fFlags,
1283	char pszOutput, uint32_t cbOutput, uint32_t pcbInstr);
1284	VMMR3_INT_DECL(int) DBGFR3DisasInstrCurrent(PVMCPU pVCpu, char *pszOutput, uint32_t cbOutput);
1285	VMMR3DECL(int) DBGFR3DisasInstrCurrentLogInternal(PVMCPU pVCpu, const char *pszPrefix);
1286
1287	/** @def DBGFR3_DISAS_INSTR_CUR_LOG
1288	* Disassembles the current guest context instruction and writes it to the log.
1289	* All registers and data will be displayed. Addresses will be attempted resolved to symbols.
1290	*/
1291	#ifdef LOG_ENABLED
1292	# define DBGFR3_DISAS_INSTR_CUR_LOG(pVCpu, pszPrefix) \
1293	do { \
1294	if (LogIsEnabled()) \
1295	DBGFR3DisasInstrCurrentLogInternal(pVCpu, pszPrefix); \
1296	} while (0)
1297	#else
1298	# define DBGFR3_DISAS_INSTR_CUR_LOG(pVCpu, pszPrefix) do { } while (0)
1299	#endif
1300
1301	VMMR3DECL(int) DBGFR3DisasInstrLogInternal(PVMCPU pVCpu, RTSEL Sel, RTGCPTR GCPtr, const char *pszPrefix);
1302
1303	/** @def DBGFR3_DISAS_INSTR_LOG
1304	* Disassembles the specified guest context instruction and writes it to the log.
1305	* Addresses will be attempted resolved to symbols.
1306	* @thread Any EMT.
1307	*/
1308	# ifdef LOG_ENABLED
1309	# define DBGFR3_DISAS_INSTR_LOG(pVCpu, Sel, GCPtr, pszPrefix) \
1310	do { \
1311	if (LogIsEnabled()) \
1312	DBGFR3DisasInstrLogInternal(pVCpu, Sel, GCPtr, pszPrefix); \
1313	} while (0)
1314	# else
1315	# define DBGFR3_DISAS_INSTR_LOG(pVCpu, Sel, GCPtr, pszPrefix) do { } while (0)
1316	# endif
1317	#endif
1318
1319
1320	#ifdef IN_RING3
1321	VMMR3DECL(int) DBGFR3MemScan(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, RTGCUINTPTR cbRange, RTGCUINTPTR uAlign,
1322	const void *pvNeedle, size_t cbNeedle, PDBGFADDRESS pHitAddress);
1323	VMMR3DECL(int) DBGFR3MemRead(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, void *pvBuf, size_t cbRead);
1324	VMMR3DECL(int) DBGFR3MemReadString(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, char *pszBuf, size_t cbBuf);
1325	VMMR3DECL(int) DBGFR3MemWrite(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, void const *pvBuf, size_t cbRead);
1326	#endif
1327
1328
1329	/** @name Flags for DBGFR3PagingDumpEx, PGMR3DumpHierarchyHCEx and
1330	* PGMR3DumpHierarchyGCEx
1331	* @{ */
1332	/** The CR3 from the current CPU state. */
1333	#define DBGFPGDMP_FLAGS_CURRENT_CR3 RT_BIT_32(0)
1334	/** The current CPU paging mode (PSE, PAE, LM, EPT, NX). */
1335	#define DBGFPGDMP_FLAGS_CURRENT_MODE RT_BIT_32(1)
1336	/** Whether PSE is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1337	* Same value as X86_CR4_PSE. */
1338	#define DBGFPGDMP_FLAGS_PSE RT_BIT_32(4) /* */
1339	/** Whether PAE is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1340	* Same value as X86_CR4_PAE. */
1341	#define DBGFPGDMP_FLAGS_PAE RT_BIT_32(5) /* */
1342	/** Whether LME is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1343	* Same value as MSR_K6_EFER_LME. */
1344	#define DBGFPGDMP_FLAGS_LME RT_BIT_32(8)
1345	/** Whether nested paging is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE). */
1346	#define DBGFPGDMP_FLAGS_NP RT_BIT_32(9)
1347	/** Whether extended nested page tables are enabled
1348	* (!DBGFPGDMP_FLAGS_CURRENT_STATE). */
1349	#define DBGFPGDMP_FLAGS_EPT RT_BIT_32(10)
1350	/** Whether no-execution is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1351	* Same value as MSR_K6_EFER_NXE. */
1352	#define DBGFPGDMP_FLAGS_NXE RT_BIT_32(11)
1353	/** Whether to print the CR3. */
1354	#define DBGFPGDMP_FLAGS_PRINT_CR3 RT_BIT_32(27)
1355	/** Whether to print the header. */
1356	#define DBGFPGDMP_FLAGS_HEADER RT_BIT_32(28)
1357	/** Whether to dump additional page information. */
1358	#define DBGFPGDMP_FLAGS_PAGE_INFO RT_BIT_32(29)
1359	/** Dump the shadow tables if set.
1360	* Cannot be used together with DBGFPGDMP_FLAGS_GUEST. */
1361	#define DBGFPGDMP_FLAGS_SHADOW RT_BIT_32(30)
1362	/** Dump the guest tables if set.
1363	* Cannot be used together with DBGFPGDMP_FLAGS_SHADOW. */
1364	#define DBGFPGDMP_FLAGS_GUEST RT_BIT_32(31)
1365	/** Mask of valid bits. */
1366	#define DBGFPGDMP_FLAGS_VALID_MASK UINT32_C(0xf8000f33)
1367	/** The mask of bits controlling the paging mode. */
1368	#define DBGFPGDMP_FLAGS_MODE_MASK UINT32_C(0x00000f32)
1369	/** @} */
1370	VMMDECL(int) DBGFR3PagingDumpEx(PUVM pUVM, VMCPUID idCpu, uint32_t fFlags, uint64_t cr3, uint64_t u64FirstAddr,
1371	uint64_t u64LastAddr, uint32_t cMaxDepth, PCDBGFINFOHLP pHlp);
1372
1373
1374	/** @name DBGFR3SelQueryInfo flags.
1375	* @{ */
1376	/** Get the info from the guest descriptor table. */
1377	#define DBGFSELQI_FLAGS_DT_GUEST UINT32_C(0)
1378	/** Get the info from the shadow descriptor table.
1379	* Only works in raw-mode. */
1380	#define DBGFSELQI_FLAGS_DT_SHADOW UINT32_C(1)
1381	/** If currently executing in in 64-bit mode, blow up data selectors. */
1382	#define DBGFSELQI_FLAGS_DT_ADJ_64BIT_MODE UINT32_C(2)
1383	/** @} */
1384	VMMR3DECL(int) DBGFR3SelQueryInfo(PUVM pUVM, VMCPUID idCpu, RTSEL Sel, uint32_t fFlags, PDBGFSELINFO pSelInfo);
1385
1386
1387	/**
1388	* Register identifiers.
1389	*/
1390	typedef enum DBGFREG
1391	{
1392	/* General purpose registers: */
1393	DBGFREG_AL = 0,
1394	DBGFREG_AX = DBGFREG_AL,
1395	DBGFREG_EAX = DBGFREG_AL,
1396	DBGFREG_RAX = DBGFREG_AL,
1397
1398	DBGFREG_CL,
1399	DBGFREG_CX = DBGFREG_CL,
1400	DBGFREG_ECX = DBGFREG_CL,
1401	DBGFREG_RCX = DBGFREG_CL,
1402
1403	DBGFREG_DL,
1404	DBGFREG_DX = DBGFREG_DL,
1405	DBGFREG_EDX = DBGFREG_DL,
1406	DBGFREG_RDX = DBGFREG_DL,
1407
1408	DBGFREG_BL,
1409	DBGFREG_BX = DBGFREG_BL,
1410	DBGFREG_EBX = DBGFREG_BL,
1411	DBGFREG_RBX = DBGFREG_BL,
1412
1413	DBGFREG_SPL,
1414	DBGFREG_SP = DBGFREG_SPL,
1415	DBGFREG_ESP = DBGFREG_SPL,
1416	DBGFREG_RSP = DBGFREG_SPL,
1417
1418	DBGFREG_BPL,
1419	DBGFREG_BP = DBGFREG_BPL,
1420	DBGFREG_EBP = DBGFREG_BPL,
1421	DBGFREG_RBP = DBGFREG_BPL,
1422
1423	DBGFREG_SIL,
1424	DBGFREG_SI = DBGFREG_SIL,
1425	DBGFREG_ESI = DBGFREG_SIL,
1426	DBGFREG_RSI = DBGFREG_SIL,
1427
1428	DBGFREG_DIL,
1429	DBGFREG_DI = DBGFREG_DIL,
1430	DBGFREG_EDI = DBGFREG_DIL,
1431	DBGFREG_RDI = DBGFREG_DIL,
1432
1433	DBGFREG_R8,
1434	DBGFREG_R8B = DBGFREG_R8,
1435	DBGFREG_R8W = DBGFREG_R8,
1436	DBGFREG_R8D = DBGFREG_R8,
1437
1438	DBGFREG_R9,
1439	DBGFREG_R9B = DBGFREG_R9,
1440	DBGFREG_R9W = DBGFREG_R9,
1441	DBGFREG_R9D = DBGFREG_R9,
1442
1443	DBGFREG_R10,
1444	DBGFREG_R10B = DBGFREG_R10,
1445	DBGFREG_R10W = DBGFREG_R10,
1446	DBGFREG_R10D = DBGFREG_R10,
1447
1448	DBGFREG_R11,
1449	DBGFREG_R11B = DBGFREG_R11,
1450	DBGFREG_R11W = DBGFREG_R11,
1451	DBGFREG_R11D = DBGFREG_R11,
1452
1453	DBGFREG_R12,
1454	DBGFREG_R12B = DBGFREG_R12,
1455	DBGFREG_R12W = DBGFREG_R12,
1456	DBGFREG_R12D = DBGFREG_R12,
1457
1458	DBGFREG_R13,
1459	DBGFREG_R13B = DBGFREG_R13,
1460	DBGFREG_R13W = DBGFREG_R13,
1461	DBGFREG_R13D = DBGFREG_R13,
1462
1463	DBGFREG_R14,
1464	DBGFREG_R14B = DBGFREG_R14,
1465	DBGFREG_R14W = DBGFREG_R14,
1466	DBGFREG_R14D = DBGFREG_R14,
1467
1468	DBGFREG_R15,
1469	DBGFREG_R15B = DBGFREG_R15,
1470	DBGFREG_R15W = DBGFREG_R15,
1471	DBGFREG_R15D = DBGFREG_R15,
1472
1473	/* Segments and other special registers: */
1474	DBGFREG_CS,
1475	DBGFREG_CS_ATTR,
1476	DBGFREG_CS_BASE,
1477	DBGFREG_CS_LIMIT,
1478
1479	DBGFREG_DS,
1480	DBGFREG_DS_ATTR,
1481	DBGFREG_DS_BASE,
1482	DBGFREG_DS_LIMIT,
1483
1484	DBGFREG_ES,
1485	DBGFREG_ES_ATTR,
1486	DBGFREG_ES_BASE,
1487	DBGFREG_ES_LIMIT,
1488
1489	DBGFREG_FS,
1490	DBGFREG_FS_ATTR,
1491	DBGFREG_FS_BASE,
1492	DBGFREG_FS_LIMIT,
1493
1494	DBGFREG_GS,
1495	DBGFREG_GS_ATTR,
1496	DBGFREG_GS_BASE,
1497	DBGFREG_GS_LIMIT,
1498
1499	DBGFREG_SS,
1500	DBGFREG_SS_ATTR,
1501	DBGFREG_SS_BASE,
1502	DBGFREG_SS_LIMIT,
1503
1504	DBGFREG_IP,
1505	DBGFREG_EIP = DBGFREG_IP,
1506	DBGFREG_RIP = DBGFREG_IP,
1507
1508	DBGFREG_FLAGS,
1509	DBGFREG_EFLAGS = DBGFREG_FLAGS,
1510	DBGFREG_RFLAGS = DBGFREG_FLAGS,
1511
1512	/* FPU: */
1513	DBGFREG_FCW,
1514	DBGFREG_FSW,
1515	DBGFREG_FTW,
1516	DBGFREG_FOP,
1517	DBGFREG_FPUIP,
1518	DBGFREG_FPUCS,
1519	DBGFREG_FPUDP,
1520	DBGFREG_FPUDS,
1521	DBGFREG_MXCSR,
1522	DBGFREG_MXCSR_MASK,
1523
1524	DBGFREG_ST0,
1525	DBGFREG_ST1,
1526	DBGFREG_ST2,
1527	DBGFREG_ST3,
1528	DBGFREG_ST4,
1529	DBGFREG_ST5,
1530	DBGFREG_ST6,
1531	DBGFREG_ST7,
1532
1533	DBGFREG_MM0,
1534	DBGFREG_MM1,
1535	DBGFREG_MM2,
1536	DBGFREG_MM3,
1537	DBGFREG_MM4,
1538	DBGFREG_MM5,
1539	DBGFREG_MM6,
1540	DBGFREG_MM7,
1541
1542	/* SSE: */
1543	DBGFREG_XMM0,
1544	DBGFREG_XMM1,
1545	DBGFREG_XMM2,
1546	DBGFREG_XMM3,
1547	DBGFREG_XMM4,
1548	DBGFREG_XMM5,
1549	DBGFREG_XMM6,
1550	DBGFREG_XMM7,
1551	DBGFREG_XMM8,
1552	DBGFREG_XMM9,
1553	DBGFREG_XMM10,
1554	DBGFREG_XMM11,
1555	DBGFREG_XMM12,
1556	DBGFREG_XMM13,
1557	DBGFREG_XMM14,
1558	DBGFREG_XMM15,
1559	/** @todo add XMM aliases. */
1560
1561	/* System registers: */
1562	DBGFREG_GDTR_BASE,
1563	DBGFREG_GDTR_LIMIT,
1564	DBGFREG_IDTR_BASE,
1565	DBGFREG_IDTR_LIMIT,
1566	DBGFREG_LDTR,
1567	DBGFREG_LDTR_ATTR,
1568	DBGFREG_LDTR_BASE,
1569	DBGFREG_LDTR_LIMIT,
1570	DBGFREG_TR,
1571	DBGFREG_TR_ATTR,
1572	DBGFREG_TR_BASE,
1573	DBGFREG_TR_LIMIT,
1574
1575	DBGFREG_CR0,
1576	DBGFREG_CR2,
1577	DBGFREG_CR3,
1578	DBGFREG_CR4,
1579	DBGFREG_CR8,
1580
1581	DBGFREG_DR0,
1582	DBGFREG_DR1,
1583	DBGFREG_DR2,
1584	DBGFREG_DR3,
1585	DBGFREG_DR6,
1586	DBGFREG_DR7,
1587
1588	/* MSRs: */
1589	DBGFREG_MSR_IA32_APICBASE,
1590	DBGFREG_MSR_IA32_CR_PAT,
1591	DBGFREG_MSR_IA32_PERF_STATUS,
1592	DBGFREG_MSR_IA32_SYSENTER_CS,
1593	DBGFREG_MSR_IA32_SYSENTER_EIP,
1594	DBGFREG_MSR_IA32_SYSENTER_ESP,
1595	DBGFREG_MSR_IA32_TSC,
1596	DBGFREG_MSR_K6_EFER,
1597	DBGFREG_MSR_K6_STAR,
1598	DBGFREG_MSR_K8_CSTAR,
1599	DBGFREG_MSR_K8_FS_BASE,
1600	DBGFREG_MSR_K8_GS_BASE,
1601	DBGFREG_MSR_K8_KERNEL_GS_BASE,
1602	DBGFREG_MSR_K8_LSTAR,
1603	DBGFREG_MSR_K8_SF_MASK,
1604	DBGFREG_MSR_K8_TSC_AUX,
1605
1606	/** The number of registers to pass to DBGFR3RegQueryAll. */
1607	DBGFREG_ALL_COUNT,
1608
1609	/* Misc aliases that doesn't need be part of the 'all' query: */
1610	DBGFREG_AH = DBGFREG_ALL_COUNT,
1611	DBGFREG_CH,
1612	DBGFREG_DH,
1613	DBGFREG_BH,
1614	DBGFREG_GDTR,
1615	DBGFREG_IDTR,
1616
1617	/** The end of the registers. */
1618	DBGFREG_END,
1619	/** The usual 32-bit type hack. */
1620	DBGFREG_32BIT_HACK = 0x7fffffff
1621	} DBGFREG;
1622	/** Pointer to a register identifier. */
1623	typedef DBGFREG *PDBGFREG;
1624	/** Pointer to a const register identifier. */
1625	typedef DBGFREG const *PCDBGFREG;
1626
1627	/**
1628	* Register value type.
1629	*/
1630	typedef enum DBGFREGVALTYPE
1631	{
1632	DBGFREGVALTYPE_INVALID = 0,
1633	/** Unsigned 8-bit register value. */
1634	DBGFREGVALTYPE_U8,
1635	/** Unsigned 16-bit register value. */
1636	DBGFREGVALTYPE_U16,
1637	/** Unsigned 32-bit register value. */
1638	DBGFREGVALTYPE_U32,
1639	/** Unsigned 64-bit register value. */
1640	DBGFREGVALTYPE_U64,
1641	/** Unsigned 128-bit register value. */
1642	DBGFREGVALTYPE_U128,
1643	/** Long double register value. */
1644	DBGFREGVALTYPE_R80,
1645	/** Descriptor table register value. */
1646	DBGFREGVALTYPE_DTR,
1647	/** End of the valid register value types. */
1648	DBGFREGVALTYPE_END,
1649	/** The usual 32-bit type hack. */
1650	DBGFREGVALTYPE_32BIT_HACK = 0x7fffffff
1651	} DBGFREGVALTYPE;
1652	/** Pointer to a register value type. */
1653	typedef DBGFREGVALTYPE *PDBGFREGVALTYPE;
1654
1655	/**
1656	* A generic register value type.
1657	*/
1658	typedef union DBGFREGVAL
1659	{
1660	uint64_t au64[2]; /*< The 64-bit array view. First because of the initializer. /
1661	uint32_t au32[4]; /*< The 32-bit array view. /
1662	uint16_t au16[8]; /*< The 16-bit array view. /
1663	uint8_t au8[16]; /*< The 8-bit array view. /
1664
1665	uint8_t u8; /*< The 8-bit view. /
1666	uint16_t u16; /*< The 16-bit view. /
1667	uint32_t u32; /*< The 32-bit view. /
1668	uint64_t u64; /*< The 64-bit view. /
1669	RTUINT128U u128; /*< The 128-bit view. /
1670	RTFLOAT80U r80; /*< The 80-bit floating point view. /
1671	RTFLOAT80U2 r80Ex; /*< The 80-bit floating point view v2. /
1672	/** GDTR or LDTR (DBGFREGVALTYPE_DTR). */
1673	struct
1674	{
1675	/** The table address. */
1676	uint64_t u64Base;
1677	/** The table limit (length minus 1). */
1678	uint32_t u32Limit;
1679	} dtr;
1680
1681	RTUINT128U u;
1682	} DBGFREGVAL;
1683	/** Pointer to a generic register value type. */
1684	typedef DBGFREGVAL *PDBGFREGVAL;
1685	/** Pointer to a const generic register value type. */
1686	typedef DBGFREGVAL const *PCDBGFREGVAL;
1687
1688	/** Initialize a DBGFREGVAL variable to all zeros. */
1689	#define DBGFREGVAL_INITIALIZE_ZERO { { 0, 0 } }
1690	/** Initialize a DBGFREGVAL variable to all bits set . */
1691	#define DBGFREGVAL_INITIALIZE_FFFF { { UINT64_MAX, UINT64_MAX } }
1692
1693
1694	VMMDECL(ssize_t) DBGFR3RegFormatValue(char *pszBuf, size_t cbBuf, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType, bool fSpecial);
1695	VMMDECL(ssize_t) DBGFR3RegFormatValueEx(char *pszBuf, size_t cbBuf, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType,
1696	unsigned uBase, signed int cchWidth, signed int cchPrecision, uint32_t fFlags);
1697
1698	/**
1699	* Register sub-field descriptor.
1700	*/
1701	typedef struct DBGFREGSUBFIELD
1702	{
1703	/** The name of the sub-field. NULL is used to terminate the array. */
1704	const char *pszName;
1705	/** The index of the first bit. Ignored if pfnGet is set. */
1706	uint8_t iFirstBit;
1707	/** The number of bits. Mandatory. */
1708	uint8_t cBits;
1709	/** The shift count. Not applied when pfnGet is set, but used to
1710	* calculate the minimum type. */
1711	int8_t cShift;
1712	/** Sub-field flags, DBGFREGSUBFIELD_FLAGS_XXX. */
1713	uint8_t fFlags;
1714	/** Getter (optional).
1715	* @remarks Does not take the device lock or anything like that.
1716	*/
1717	DECLCALLBACKMEMBER(int, pfnGet)(void pvUser, struct DBGFREGSUBFIELD const pSubField, PRTUINT128U puValue);
1718	/** Setter (optional).
1719	* @remarks Does not take the device lock or anything like that.
1720	*/
1721	DECLCALLBACKMEMBER(int, pfnSet)(void pvUser, struct DBGFREGSUBFIELD const pSubField, RTUINT128U uValue, RTUINT128U fMask);
1722	} DBGFREGSUBFIELD;
1723	/** Pointer to a const register sub-field descriptor. */
1724	typedef DBGFREGSUBFIELD const *PCDBGFREGSUBFIELD;
1725
1726	/** @name DBGFREGSUBFIELD_FLAGS_XXX
1727	* @{ */
1728	/** The sub-field is read-only. */
1729	#define DBGFREGSUBFIELD_FLAGS_READ_ONLY UINT8_C(0x01)
1730	/** @} */
1731
1732	/** Macro for creating a read-write sub-field entry without getters. */
1733	#define DBGFREGSUBFIELD_RW(a_szName, a_iFirstBit, a_cBits, a_cShift) \
1734	{ a_szName, a_iFirstBit, a_cBits, a_cShift, 0 /fFlags/, NULL /pfnGet/, NULL /pfnSet/ }
1735	/** Macro for creating a read-write sub-field entry with getters. */
1736	#define DBGFREGSUBFIELD_RW_SG(a_szName, a_cBits, a_cShift, a_pfnGet, a_pfnSet) \
1737	{ a_szName, 0 /iFirstBit/, a_cBits, a_cShift, 0 /fFlags/, a_pfnGet, a_pfnSet }
1738	/** Macro for creating a read-only sub-field entry without getters. */
1739	#define DBGFREGSUBFIELD_RO(a_szName, a_iFirstBit, a_cBits, a_cShift) \
1740	{ a_szName, a_iFirstBit, a_cBits, a_cShift, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL /pfnGet/, NULL /pfnSet/ }
1741	/** Macro for creating a terminator sub-field entry. */
1742	#define DBGFREGSUBFIELD_TERMINATOR() \
1743	{ NULL, 0, 0, 0, 0, NULL, NULL }
1744
1745	/**
1746	* Register alias descriptor.
1747	*/
1748	typedef struct DBGFREGALIAS
1749	{
1750	/** The alias name. NULL is used to terminate the array. */
1751	const char *pszName;
1752	/** Set to a valid type if the alias has a different type. */
1753	DBGFREGVALTYPE enmType;
1754	} DBGFREGALIAS;
1755	/** Pointer to a const register alias descriptor. */
1756	typedef DBGFREGALIAS const *PCDBGFREGALIAS;
1757
1758	/**
1759	* Register descriptor.
1760	*/
1761	typedef struct DBGFREGDESC
1762	{
1763	/** The normal register name. */
1764	const char *pszName;
1765	/** The register identifier if this is a CPU register. */
1766	DBGFREG enmReg;
1767	/** The default register type. */
1768	DBGFREGVALTYPE enmType;
1769	/** Flags, see DBGFREG_FLAGS_XXX. */
1770	uint32_t fFlags;
1771	/** The internal register indicator.
1772	* For CPU registers this is the offset into the CPUMCTX structure,
1773	* thuse the 'off' prefix. */
1774	uint32_t offRegister;
1775	/** Getter.
1776	* @remarks Does not take the device lock or anything like that.
1777	*/
1778	DECLCALLBACKMEMBER(int, pfnGet)(void pvUser, struct DBGFREGDESC const pDesc, PDBGFREGVAL pValue);
1779	/** Setter.
1780	* @remarks Does not take the device lock or anything like that.
1781	*/
1782	DECLCALLBACKMEMBER(int, pfnSet)(void pvUser, struct DBGFREGDESC const pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask);
1783	/** Aliases (optional). */
1784	PCDBGFREGALIAS paAliases;
1785	/** Sub fields (optional). */
1786	PCDBGFREGSUBFIELD paSubFields;
1787	} DBGFREGDESC;
1788
1789	/** @name Macros for constructing DBGFREGDESC arrays.
1790	* @{ */
1791	#define DBGFREGDESC_RW(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet) \
1792	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, NULL /paAlises/, NULL /paSubFields/ }
1793	#define DBGFREGDESC_RO(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet) \
1794	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, NULL /paAlises/, NULL /paSubFields/ }
1795	#define DBGFREGDESC_RW_A(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases) \
1796	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, NULL /paSubFields/ }
1797	#define DBGFREGDESC_RO_A(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases) \
1798	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, NULL /paSubFields/ }
1799	#define DBGFREGDESC_RW_S(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paSubFields) \
1800	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, /paAliases/, a_paSubFields }
1801	#define DBGFREGDESC_RO_S(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paSubFields) \
1802	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, /paAliases/, a_paSubFields }
1803	#define DBGFREGDESC_RW_AS(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields) \
1804	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields }
1805	#define DBGFREGDESC_RO_AS(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields) \
1806	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields }
1807	#define DBGFREGDESC_TERMINATOR() \
1808	{ NULL, DBGFREG_END, DBGFREGVALTYPE_INVALID, 0, 0, NULL, NULL, NULL, NULL }
1809	/** @} */
1810
1811
1812	/** @name DBGFREG_FLAGS_XXX
1813	* @{ */
1814	/** The register is read-only. */
1815	#define DBGFREG_FLAGS_READ_ONLY RT_BIT_32(0)
1816	/** @} */
1817
1818	/**
1819	* Entry in a batch query or set operation.
1820	*/
1821	typedef struct DBGFREGENTRY
1822	{
1823	/** The register identifier. */
1824	DBGFREG enmReg;
1825	/** The size of the value in bytes. */
1826	DBGFREGVALTYPE enmType;
1827	/** The register value. The valid view is indicated by enmType. */
1828	DBGFREGVAL Val;
1829	} DBGFREGENTRY;
1830	/** Pointer to a register entry in a batch operation. */
1831	typedef DBGFREGENTRY *PDBGFREGENTRY;
1832	/** Pointer to a const register entry in a batch operation. */
1833	typedef DBGFREGENTRY const *PCDBGFREGENTRY;
1834
1835	/** Used with DBGFR3Reg* to indicate the hypervisor register set instead of the
1836	* guest. */
1837	#define DBGFREG_HYPER_VMCPUID UINT32_C(0x01000000)
1838
1839	VMMR3DECL(int) DBGFR3RegCpuQueryU8( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint8_t *pu8);
1840	VMMR3DECL(int) DBGFR3RegCpuQueryU16( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint16_t *pu16);
1841	VMMR3DECL(int) DBGFR3RegCpuQueryU32( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint32_t *pu32);
1842	VMMR3DECL(int) DBGFR3RegCpuQueryU64( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t *pu64);
1843	VMMR3DECL(int) DBGFR3RegCpuQueryU128(PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint128_t *pu128);
1844	VMMR3DECL(int) DBGFR3RegCpuQueryLrd( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, long double *plrd);
1845	VMMR3DECL(int) DBGFR3RegCpuQueryXdtr(PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t pu64Base, uint16_t pu16Limit);
1846	#if 0
1847	VMMR3DECL(int) DBGFR3RegCpuQueryBatch(PUVM pUVM,VMCPUID idCpu, PDBGFREGENTRY paRegs, size_t cRegs);
1848	VMMR3DECL(int) DBGFR3RegCpuQueryAll( PUVM pUVM, VMCPUID idCpu, PDBGFREGENTRY paRegs, size_t cRegs);
1849
1850	VMMR3DECL(int) DBGFR3RegCpuSetU8( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint8_t u8);
1851	VMMR3DECL(int) DBGFR3RegCpuSetU16( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint16_t u16);
1852	VMMR3DECL(int) DBGFR3RegCpuSetU32( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint32_t u32);
1853	VMMR3DECL(int) DBGFR3RegCpuSetU64( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t u64);
1854	VMMR3DECL(int) DBGFR3RegCpuSetU128( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint128_t u128);
1855	VMMR3DECL(int) DBGFR3RegCpuSetLrd( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, long double lrd);
1856	VMMR3DECL(int) DBGFR3RegCpuSetBatch( PUVM pUVM, VMCPUID idCpu, PCDBGFREGENTRY paRegs, size_t cRegs);
1857	#endif
1858
1859	VMMR3DECL(const char *) DBGFR3RegCpuName(PUVM pUVM, DBGFREG enmReg, DBGFREGVALTYPE enmType);
1860
1861	VMMR3_INT_DECL(int) DBGFR3RegRegisterCpu(PVM pVM, PVMCPU pVCpu, PCDBGFREGDESC paRegisters, bool fGuestRegs);
1862	VMMR3_INT_DECL(int) DBGFR3RegRegisterDevice(PVM pVM, PCDBGFREGDESC paRegisters, PPDMDEVINS pDevIns,
1863	const char *pszPrefix, uint32_t iInstance);
1864
1865	/**
1866	* Entry in a named batch query or set operation.
1867	*/
1868	typedef struct DBGFREGENTRYNM
1869	{
1870	/** The register name. */
1871	const char *pszName;
1872	/** The size of the value in bytes. */
1873	DBGFREGVALTYPE enmType;
1874	/** The register value. The valid view is indicated by enmType. */
1875	DBGFREGVAL Val;
1876	} DBGFREGENTRYNM;
1877	/** Pointer to a named register entry in a batch operation. */
1878	typedef DBGFREGENTRYNM *PDBGFREGENTRYNM;
1879	/** Pointer to a const named register entry in a batch operation. */
1880	typedef DBGFREGENTRYNM const *PCDBGFREGENTRYNM;
1881
1882	VMMR3DECL(int) DBGFR3RegNmValidate( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg);
1883
1884	VMMR3DECL(int) DBGFR3RegNmQuery( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PDBGFREGVAL pValue, PDBGFREGVALTYPE penmType);
1885	VMMR3DECL(int) DBGFR3RegNmQueryU8( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint8_t pu8);
1886	VMMR3DECL(int) DBGFR3RegNmQueryU16( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint16_t pu16);
1887	VMMR3DECL(int) DBGFR3RegNmQueryU32( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint32_t pu32);
1888	VMMR3DECL(int) DBGFR3RegNmQueryU64( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint64_t pu64);
1889	VMMR3DECL(int) DBGFR3RegNmQueryU128(PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PRTUINT128U pu128);
1890	/VMMR3DECL(int) DBGFR3RegNmQueryLrd( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, long double plrd);/
1891	VMMR3DECL(int) DBGFR3RegNmQueryXdtr(PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint64_t pu64Base, uint16_t *pu16Limit);
1892	VMMR3DECL(int) DBGFR3RegNmQueryBatch(PUVM pUVM,VMCPUID idDefCpu, PDBGFREGENTRYNM paRegs, size_t cRegs);
1893	VMMR3DECL(int) DBGFR3RegNmQueryAllCount(PUVM pUVM, size_t *pcRegs);
1894	VMMR3DECL(int) DBGFR3RegNmQueryAll( PUVM pUVM, PDBGFREGENTRYNM paRegs, size_t cRegs);
1895
1896	VMMR3DECL(int) DBGFR3RegNmSet( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType);
1897	VMMR3DECL(int) DBGFR3RegNmSetU8( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint8_t u8);
1898	VMMR3DECL(int) DBGFR3RegNmSetU16( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint16_t u16);
1899	VMMR3DECL(int) DBGFR3RegNmSetU32( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint32_t u32);
1900	VMMR3DECL(int) DBGFR3RegNmSetU64( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint64_t u64);
1901	VMMR3DECL(int) DBGFR3RegNmSetU128( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, RTUINT128U u128);
1902	VMMR3DECL(int) DBGFR3RegNmSetLrd( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, long double lrd);
1903	VMMR3DECL(int) DBGFR3RegNmSetBatch( PUVM pUVM, VMCPUID idDefCpu, PCDBGFREGENTRYNM paRegs, size_t cRegs);
1904
1905	/** @todo add enumeration methods. */
1906
1907	VMMR3DECL(int) DBGFR3RegPrintf( PUVM pUVM, VMCPUID idDefCpu, char pszBuf, size_t cbBuf, const char pszFormat, ...);
1908	VMMR3DECL(int) DBGFR3RegPrintfV(PUVM pUVM, VMCPUID idDefCpu, char pszBuf, size_t cbBuf, const char pszFormat, va_list va);
1909
1910
1911	/**
1912	* Guest OS digger interface identifier.
1913	*
1914	* This is for use together with PDBGFR3QueryInterface and is used to
1915	* obtain access to optional interfaces.
1916	*/
1917	typedef enum DBGFOSINTERFACE
1918	{
1919	/** The usual invalid entry. */
1920	DBGFOSINTERFACE_INVALID = 0,
1921	/** Process info. */
1922	DBGFOSINTERFACE_PROCESS,
1923	/** Thread info. */
1924	DBGFOSINTERFACE_THREAD,
1925	/** Kernel message log - DBGFOSIDMESG. */
1926	DBGFOSINTERFACE_DMESG,
1927	/** The end of the valid entries. */
1928	DBGFOSINTERFACE_END,
1929	/** The usual 32-bit type blowup. */
1930	DBGFOSINTERFACE_32BIT_HACK = 0x7fffffff
1931	} DBGFOSINTERFACE;
1932	/** Pointer to a Guest OS digger interface identifier. */
1933	typedef DBGFOSINTERFACE *PDBGFOSINTERFACE;
1934	/** Pointer to a const Guest OS digger interface identifier. */
1935	typedef DBGFOSINTERFACE const *PCDBGFOSINTERFACE;
1936
1937
1938	/**
1939	* Guest OS Digger Registration Record.
1940	*
1941	* This is used with the DBGFR3OSRegister() API.
1942	*/
1943	typedef struct DBGFOSREG
1944	{
1945	/** Magic value (DBGFOSREG_MAGIC). */
1946	uint32_t u32Magic;
1947	/** Flags. Reserved. */
1948	uint32_t fFlags;
1949	/** The size of the instance data. */
1950	uint32_t cbData;
1951	/** Operative System name. */
1952	char szName[24];
1953
1954	/**
1955	* Constructs the instance.
1956	*
1957	* @returns VBox status code.
1958	* @param pUVM The user mode VM handle.
1959	* @param pvData Pointer to the instance data.
1960	*/
1961	DECLCALLBACKMEMBER(int, pfnConstruct)(PUVM pUVM, void *pvData);
1962
1963	/**
1964	* Destroys the instance.
1965	*
1966	* @param pUVM The user mode VM handle.
1967	* @param pvData Pointer to the instance data.
1968	*/
1969	DECLCALLBACKMEMBER(void, pfnDestruct)(PUVM pUVM, void *pvData);
1970
1971	/**
1972	* Probes the guest memory for OS finger prints.
1973	*
1974	* No setup or so is performed, it will be followed by a call to pfnInit
1975	* or pfnRefresh that should take care of that.
1976	*
1977	* @returns true if is an OS handled by this module, otherwise false.
1978	* @param pUVM The user mode VM handle.
1979	* @param pvData Pointer to the instance data.
1980	*/
1981	DECLCALLBACKMEMBER(bool, pfnProbe)(PUVM pUVM, void *pvData);
1982
1983	/**
1984	* Initializes a fresly detected guest, loading symbols and such useful stuff.
1985	*
1986	* This is called after pfnProbe.
1987	*
1988	* @returns VBox status code.
1989	* @param pUVM The user mode VM handle.
1990	* @param pvData Pointer to the instance data.
1991	*/
1992	DECLCALLBACKMEMBER(int, pfnInit)(PUVM pUVM, void *pvData);
1993
1994	/**
1995	* Refreshes symbols and stuff following a redetection of the same OS.
1996	*
1997	* This is called after pfnProbe.
1998	*
1999	* @returns VBox status code.
2000	* @param pUVM The user mode VM handle.
2001	* @param pvData Pointer to the instance data.
2002	*/
2003	DECLCALLBACKMEMBER(int, pfnRefresh)(PUVM pUVM, void *pvData);
2004
2005	/**
2006	* Terminates an OS when a new (or none) OS has been detected,
2007	* and before destruction.
2008	*
2009	* This is called after pfnProbe and if needed before pfnDestruct.
2010	*
2011	* @param pUVM The user mode VM handle.
2012	* @param pvData Pointer to the instance data.
2013	*/
2014	DECLCALLBACKMEMBER(void, pfnTerm)(PUVM pUVM, void *pvData);
2015
2016	/**
2017	* Queries the version of the running OS.
2018	*
2019	* This is only called after pfnInit().
2020	*
2021	* @returns VBox status code.
2022	* @param pUVM The user mode VM handle.
2023	* @param pvData Pointer to the instance data.
2024	* @param pszVersion Where to store the version string.
2025	* @param cchVersion The size of the version string buffer.
2026	*/
2027	DECLCALLBACKMEMBER(int, pfnQueryVersion)(PUVM pUVM, void pvData, char pszVersion, size_t cchVersion);
2028
2029	/**
2030	* Queries the pointer to a interface.
2031	*
2032	* This is called after pfnProbe.
2033	*
2034	* The returned interface must be valid until pfnDestruct is called. Two calls
2035	* to this method with the same @a enmIf value must return the same pointer.
2036	*
2037	* @returns Pointer to the interface if available, NULL if not available.
2038	* @param pUVM The user mode VM handle.
2039	* @param pvData Pointer to the instance data.
2040	* @param enmIf The interface identifier.
2041	*/
2042	DECLCALLBACKMEMBER(void , pfnQueryInterface)(PUVM pUVM, void pvData, DBGFOSINTERFACE enmIf);
2043
2044	/** Trailing magic (DBGFOSREG_MAGIC). */
2045	uint32_t u32EndMagic;
2046	} DBGFOSREG;
2047	/** Pointer to a Guest OS digger registration record. */
2048	typedef DBGFOSREG *PDBGFOSREG;
2049	/** Pointer to a const Guest OS digger registration record. */
2050	typedef DBGFOSREG const *PCDBGFOSREG;
2051
2052	/** Magic value for DBGFOSREG::u32Magic and DBGFOSREG::u32EndMagic. (Hitomi Kanehara) */
2053	#define DBGFOSREG_MAGIC 0x19830808
2054
2055
2056	/**
2057	* Interface for querying kernel log messages (DBGFOSINTERFACE_DMESG).
2058	*/
2059	typedef struct DBGFOSIDMESG
2060	{
2061	/** Trailing magic (DBGFOSIDMESG_MAGIC). */
2062	uint32_t u32Magic;
2063
2064	/**
2065	* Query the kernel log.
2066	*
2067	* @returns VBox status code.
2068	* @retval VERR_NOT_FOUND if the messages could not be located.
2069	* @retval VERR_INVALID_STATE if the messages was found to have unknown/invalid
2070	* format.
2071	* @retval VERR_BUFFER_OVERFLOW if the buffer isn't large enough, pcbActual
2072	* will be set to the required buffer size. The buffer, however, will
2073	* be filled with as much data as it can hold (properly zero terminated
2074	* of course).
2075	*
2076	* @param pThis Pointer to the interface structure.
2077	* @param pUVM The user mode VM handle.
2078	* @param fFlags Flags reserved for future use, MBZ.
2079	* @param cMessages The number of messages to retrieve, counting from the
2080	* end of the log (i.e. like tail), use UINT32_MAX for all.
2081	* @param pszBuf The output buffer.
2082	* @param cbBuf The buffer size.
2083	* @param pcbActual Where to store the number of bytes actually returned,
2084	* including zero terminator. On VERR_BUFFER_OVERFLOW this
2085	* holds the necessary buffer size. Optional.
2086	*/
2087	DECLCALLBACKMEMBER(int, pfnQueryKernelLog)(struct DBGFOSIDMESG *pThis, PUVM pUVM, uint32_t fFlags, uint32_t cMessages,
2088	char pszBuf, size_t cbBuf, size_t pcbActual);
2089	/** Trailing magic (DBGFOSIDMESG_MAGIC). */
2090	uint32_t u32EndMagic;
2091	} DBGFOSIDMESG;
2092	/** Pointer to the interface for query kernel log messages (DBGFOSINTERFACE_DMESG). */
2093	typedef DBGFOSIDMESG *PDBGFOSIDMESG;
2094	/** Magic value for DBGFOSIDMESG::32Magic and DBGFOSIDMESG::u32EndMagic. (Kenazburo Oe) */
2095	#define DBGFOSIDMESG_MAGIC UINT32_C(0x19350131)
2096
2097
2098	VMMR3DECL(int) DBGFR3OSRegister(PUVM pUVM, PCDBGFOSREG pReg);
2099	VMMR3DECL(int) DBGFR3OSDeregister(PUVM pUVM, PCDBGFOSREG pReg);
2100	VMMR3DECL(int) DBGFR3OSDetect(PUVM pUVM, char *pszName, size_t cchName);
2101	VMMR3DECL(int) DBGFR3OSQueryNameAndVersion(PUVM pUVM, char pszName, size_t cchName, char pszVersion, size_t cchVersion);
2102	VMMR3DECL(void *) DBGFR3OSQueryInterface(PUVM pUVM, DBGFOSINTERFACE enmIf);
2103
2104
2105	VMMR3DECL(int) DBGFR3CoreWrite(PUVM pUVM, const char *pszFilename, bool fReplaceFile);
2106
2107
2108	#ifdef IN_RING3
2109	/** @defgroup grp_dbgf_plug_in The DBGF Plug-in Interface
2110	* @{
2111	*/
2112
2113	/** The plug-in module name prefix. */
2114	#define DBGF_PLUG_IN_PREFIX "DbgPlugIn"
2115
2116	/** The name of the plug-in entry point (FNDBGFPLUGIN) */
2117	#define DBGF_PLUG_IN_ENTRYPOINT "DbgPlugInEntry"
2118
2119	/**
2120	* DBGF plug-in operations.
2121	*/
2122	typedef enum DBGFPLUGINOP
2123	{
2124	/** The usual invalid first value. */
2125	DBGFPLUGINOP_INVALID,
2126	/** Initialize the plug-in for a VM, register all the stuff.
2127	* The plug-in will be unloaded on failure.
2128	* uArg: The full VirtualBox version, see VBox/version.h. */
2129	DBGFPLUGINOP_INIT,
2130	/** Terminate the plug-ing for a VM, deregister all the stuff.
2131	* The plug-in will be unloaded after this call regardless of the return
2132	* code. */
2133	DBGFPLUGINOP_TERM,
2134	/** The usual 32-bit hack. */
2135	DBGFPLUGINOP_32BIT_HACK = 0x7fffffff
2136	} DBGFPLUGINOP;
2137
2138	/**
2139	* DBGF plug-in main entry point.
2140	*
2141	* @returns VBox status code.
2142	*
2143	* @param enmOperation The operation.
2144	* @param pUVM The user mode VM handle. This may be NULL.
2145	* @param uArg Extra argument.
2146	*/
2147	typedef DECLCALLBACK(int) FNDBGFPLUGIN(DBGFPLUGINOP enmOperation, PUVM pUVM, uintptr_t uArg);
2148	/** Pointer to a FNDBGFPLUGIN. */
2149	typedef FNDBGFPLUGIN *PFNDBGFPLUGIN;
2150
2151	/** @copydoc FNDBGFPLUGIN */
2152	DECLEXPORT(int) DbgPlugInEntry(DBGFPLUGINOP enmOperation, PUVM pUVM, uintptr_t uArg);
2153
2154	VMMR3DECL(int) DBGFR3PlugInLoad(PUVM pUVM, const char pszPlugIn, char pszActual, size_t cbActual, PRTERRINFO pErrInfo);
2155	VMMR3DECL(int) DBGFR3PlugInUnload(PUVM pUVM, const char *pszName);
2156	VMMR3DECL(void) DBGFR3PlugInLoadAll(PUVM pUVM);
2157	VMMR3DECL(void) DBGFR3PlugInUnloadAll(PUVM pUVM);
2158
2159	/** @} */
2160	#endif /* IN_RING3 */
2161
2162
2163	/** @} */
2164
2165
2166	RT_C_DECLS_END
2167
2168	#endif
2169

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/vmm/dbgf.h@ 58938

Download in other formats: