dbgf.h@ 86704

Last change on this file since 86704 was 86704, checked in by vboxsync, 4 years ago
VMM/DBGF: Updates to the new breakpoint manager, L2 table management groundwork, bugref:9837
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 132.5 KB

Line
1	/** @file
2	* DBGF - Debugger Facility.
3	*/
4
5	/*
6	* Copyright (C) 2006-2020 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_INCLUDED_vmm_dbgf_h
27	#define VBOX_INCLUDED_vmm_dbgf_h
28	#ifndef RT_WITHOUT_PRAGMA_ONCE
29	# pragma once
30	#endif
31
32	#include <VBox/types.h>
33	#include <VBox/log.h> /* LOG_ENABLED */
34	#include <VBox/vmm/vmm.h>
35	#include <VBox/vmm/dbgfsel.h>
36
37	#include <iprt/stdarg.h>
38	#include <iprt/dbg.h>
39
40	RT_C_DECLS_BEGIN
41
42
43	/** @defgroup grp_dbgf The Debugger Facility API
44	* @ingroup grp_vmm
45	* @{
46	*/
47
48	#if defined(IN_RC) \|\| defined(IN_RING0)
49	/** @defgroup grp_dbgf_rz The RZ DBGF API
50	* @{
51	*/
52	VMMRZ_INT_DECL(int) DBGFRZTrap01Handler(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCUINTREG uDr6, bool fAltStepping);
53	VMMRZ_INT_DECL(int) DBGFRZTrap03Handler(PVMCC pVM, PVMCPUCC pVCpu, PCPUMCTXCORE pRegFrame);
54	/** @} */
55	#endif
56
57
58	/** @defgroup grp_dbgf_r0 The R0 DBGF API
59	* @{
60	*/
61	VMMR0_INT_DECL(void) DBGFR0InitPerVMData(PGVM pGVM);
62	VMMR0_INT_DECL(void) DBGFR0CleanupVM(PGVM pGVM);
63
64	/**
65	* Request buffer for DBGFR0TracerCreateReqHandler / VMMR0_DO_DBGF_TRACER_CREATE.
66	* @see DBGFR0TracerCreateReqHandler.
67	*/
68	typedef struct DBGFTRACERCREATEREQ
69	{
70	/** The header. */
71	SUPVMMR0REQHDR Hdr;
72	/** Out: Where to return the address of the ring-3 tracer instance. */
73	PDBGFTRACERINSR3 pTracerInsR3;
74
75	/** Number of bytes for the shared event ring buffer. */
76	uint32_t cbRingBuf;
77
78	/** Set if the raw-mode component is desired. */
79	bool fRCEnabled;
80	/** Explicit padding. */
81	bool afReserved[3];
82
83	} DBGFTRACERCREATEREQ;
84	/** Pointer to a DBGFR0TracerCreate / VMMR0_DO_DBGF_TRACER_CREATE request buffer. */
85	typedef DBGFTRACERCREATEREQ *PDBGFTRACERCREATEREQ;
86
87	VMMR0_INT_DECL(int) DBGFR0TracerCreateReqHandler(PGVM pGVM, PDBGFTRACERCREATEREQ pReq);
88
89	#ifdef VBOX_WITH_LOTS_OF_DBGF_BPS
90	/**
91	* Request buffer for DBGFR0BpInitReqHandler / VMMR0_DO_DBGF_BP_INIT.
92	* @see DBGFR0BpInitReqHandler.
93	*/
94	typedef struct DBGFBPINITREQ
95	{
96	/** The header. */
97	SUPVMMR0REQHDR Hdr;
98	/** Out: Ring-3 pointer of the L1 lookup table on success. */
99	R3PTRTYPE(volatile uint32_t *) paBpLocL1R3;
100	} DBGFBPINITREQ;
101	/** Pointer to a DBGFR0BpInitReqHandler / VMMR0_DO_DBGF_BP_INIT request buffer. */
102	typedef DBGFBPINITREQ *PDBGFBPINITREQ;
103
104	VMMR0_INT_DECL(int) DBGFR0BpInitReqHandler(PGVM pGVM, PDBGFBPINITREQ pReq);
105
106	/**
107	* Request buffer for DBGFR0BpChunkAllocReqHandler / VMMR0_DO_DBGF_CHUNK_ALLOC.
108	* @see DBGFR0BpChunkAllocReqHandler.
109	*/
110	typedef struct DBGFBPCHUNKALLOCREQ
111	{
112	/** The header. */
113	SUPVMMR0REQHDR Hdr;
114	/** Out: Ring-3 pointer of the chunk base on success. */
115	R3PTRTYPE(void *) pChunkBaseR3;
116
117	/** The chunk ID to allocate. */
118	uint32_t idChunk;
119	} DBGFBPCHUNKALLOCREQ;
120	/** Pointer to a DBGFR0BpChunkAllocReqHandler / VMMR0_DO_DBGF_CHUNK_ALLOC request buffer. */
121	typedef DBGFBPCHUNKALLOCREQ *PDBGFBPCHUNKALLOCREQ;
122
123	VMMR0_INT_DECL(int) DBGFR0BpChunkAllocReqHandler(PGVM pGVM, PDBGFBPCHUNKALLOCREQ pReq);
124
125	/**
126	* Request buffer for DBGFR0BpL2TblChunkAllocReqHandler / VMMR0_DO_DBGF_L2_TBL_CHUNK_ALLOC.
127	* @see DBGFR0BpL2TblChunkAllocReqHandler.
128	*/
129	typedef struct DBGFBPL2TBLCHUNKALLOCREQ
130	{
131	/** The header. */
132	SUPVMMR0REQHDR Hdr;
133	/** Out: Ring-3 pointer of the chunk base on success. */
134	R3PTRTYPE(void *) pChunkBaseR3;
135
136	/** The chunk ID to allocate. */
137	uint32_t idChunk;
138	} DBGFBPL2TBLCHUNKALLOCREQ;
139	/** Pointer to a DBGFR0BpChunkAllocReqHandler / VMMR0_DO_DBGF_L2_TBL_CHUNK_ALLOC request buffer. */
140	typedef DBGFBPL2TBLCHUNKALLOCREQ *PDBGFBPL2TBLCHUNKALLOCREQ;
141
142	VMMR0_INT_DECL(int) DBGFR0BpL2TblChunkAllocReqHandler(PGVM pGVM, PDBGFBPL2TBLCHUNKALLOCREQ pReq);
143	#endif
144	/** @} */
145
146
147	#ifdef IN_RING3
148
149	/**
150	* Mixed address.
151	*/
152	typedef struct DBGFADDRESS
153	{
154	/** The flat address. */
155	RTGCUINTPTR FlatPtr;
156	/** The selector offset address. */
157	RTGCUINTPTR off;
158	/** The selector. DBGF_SEL_FLAT is a legal value. */
159	RTSEL Sel;
160	/** Flags describing further details about the address. */
161	uint16_t fFlags;
162	} DBGFADDRESS;
163	/** Pointer to a mixed address. */
164	typedef DBGFADDRESS *PDBGFADDRESS;
165	/** Pointer to a const mixed address. */
166	typedef const DBGFADDRESS *PCDBGFADDRESS;
167
168	/** @name DBGFADDRESS Flags.
169	* @{ */
170	/** A 16:16 far address. */
171	#define DBGFADDRESS_FLAGS_FAR16 0
172	/** A 16:32 far address. */
173	#define DBGFADDRESS_FLAGS_FAR32 1
174	/** A 16:64 far address. */
175	#define DBGFADDRESS_FLAGS_FAR64 2
176	/** A flat address. */
177	#define DBGFADDRESS_FLAGS_FLAT 3
178	/** A physical address. */
179	#define DBGFADDRESS_FLAGS_PHYS 4
180	/** A ring-0 host address (internal use only). */
181	#define DBGFADDRESS_FLAGS_RING0 5
182	/** The address type mask. */
183	#define DBGFADDRESS_FLAGS_TYPE_MASK 7
184
185	/** Set if the address is valid. */
186	#define DBGFADDRESS_FLAGS_VALID RT_BIT(3)
187
188	/** Checks if the mixed address is flat or not. */
189	#define DBGFADDRESS_IS_FLAT(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FLAT )
190	/** Checks if the mixed address is flat or not. */
191	#define DBGFADDRESS_IS_PHYS(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_PHYS )
192	/** Checks if the mixed address is far 16:16 or not. */
193	#define DBGFADDRESS_IS_FAR16(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR16 )
194	/** Checks if the mixed address is far 16:32 or not. */
195	#define DBGFADDRESS_IS_FAR32(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR32 )
196	/** Checks if the mixed address is far 16:64 or not. */
197	#define DBGFADDRESS_IS_FAR64(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_FAR64 )
198	/** Checks if the mixed address is any kind of far address. */
199	#define DBGFADDRESS_IS_FAR(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) <= DBGFADDRESS_FLAGS_FAR64 )
200	/** Checks if the mixed address host context ring-0 (special). */
201	#define DBGFADDRESS_IS_R0_HC(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) == DBGFADDRESS_FLAGS_RING0 )
202	/** Checks if the mixed address a virtual guest context address (incl HMA). */
203	#define DBGFADDRESS_IS_VIRT_GC(pAddress) ( ((pAddress)->fFlags & DBGFADDRESS_FLAGS_TYPE_MASK) <= DBGFADDRESS_FLAGS_FLAT )
204	/** Checks if the mixed address is valid. */
205	#define DBGFADDRESS_IS_VALID(pAddress) RT_BOOL((pAddress)->fFlags & DBGFADDRESS_FLAGS_VALID)
206	/** @} */
207
208	VMMR3DECL(int) DBGFR3AddrFromSelOff(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddress, RTSEL Sel, RTUINTPTR off);
209	VMMR3DECL(int) DBGFR3AddrFromSelInfoOff(PUVM pUVM, PDBGFADDRESS pAddress, PCDBGFSELINFO pSelInfo, RTUINTPTR off);
210	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrFromFlat(PUVM pUVM, PDBGFADDRESS pAddress, RTGCUINTPTR FlatPtr);
211	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrFromPhys(PUVM pUVM, PDBGFADDRESS pAddress, RTGCPHYS PhysAddr);
212	VMMR3_INT_DECL(PDBGFADDRESS) DBGFR3AddrFromHostR0(PDBGFADDRESS pAddress, RTR0UINTPTR R0Ptr);
213	VMMR3DECL(bool) DBGFR3AddrIsValid(PUVM pUVM, PCDBGFADDRESS pAddress);
214	VMMR3DECL(int) DBGFR3AddrToPhys(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, PRTGCPHYS pGCPhys);
215	VMMR3DECL(int) DBGFR3AddrToHostPhys(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddress, PRTHCPHYS pHCPhys);
216	VMMR3DECL(int) DBGFR3AddrToVolatileR3Ptr(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddress, bool fReadOnly, void **ppvR3Ptr);
217	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrAdd(PDBGFADDRESS pAddress, RTGCUINTPTR uAddend);
218	VMMR3DECL(PDBGFADDRESS) DBGFR3AddrSub(PDBGFADDRESS pAddress, RTGCUINTPTR uSubtrahend);
219
220	#endif /* IN_RING3 */
221
222
223
224	/**
225	* VMM Debug Event Type.
226	*/
227	typedef enum DBGFEVENTTYPE
228	{
229	/** Halt completed.
230	* This notifies that a halt command have been successfully completed.
231	*/
232	DBGFEVENT_HALT_DONE = 0,
233	/** Detach completed.
234	* This notifies that the detach command have been successfully completed.
235	*/
236	DBGFEVENT_DETACH_DONE,
237	/** The command from the debugger is not recognized.
238	* This means internal error or half implemented features.
239	*/
240	DBGFEVENT_INVALID_COMMAND,
241
242	/** Fatal error.
243	* This notifies a fatal error in the VMM and that the debugger get's a
244	* chance to first hand information about the the problem.
245	*/
246	DBGFEVENT_FATAL_ERROR,
247	/** Breakpoint Hit.
248	* This notifies that a breakpoint installed by the debugger was hit. The
249	* identifier of the breakpoint can be found in the DBGFEVENT::u::Bp::iBp member.
250	*/
251	DBGFEVENT_BREAKPOINT,
252	/** I/O port breakpoint.
253	* @todo not yet implemented. */
254	DBGFEVENT_BREAKPOINT_IO,
255	/** MMIO breakpoint.
256	* @todo not yet implemented. */
257	DBGFEVENT_BREAKPOINT_MMIO,
258	/** Breakpoint Hit in the Hypervisor.
259	* This notifies that a breakpoint installed by the debugger was hit. The
260	* identifier of the breakpoint can be found in the DBGFEVENT::u::Bp::iBp member.
261	* @todo raw-mode: remove this
262	*/
263	DBGFEVENT_BREAKPOINT_HYPER,
264	/** Assertion in the Hypervisor (breakpoint instruction).
265	* This notifies that a breakpoint instruction was hit in the hypervisor context.
266	*/
267	DBGFEVENT_ASSERTION_HYPER,
268	/** Single Stepped.
269	* This notifies that a single step operation was completed.
270	*/
271	DBGFEVENT_STEPPED,
272	/** Single Stepped.
273	* This notifies that a hypervisor single step operation was completed.
274	*/
275	DBGFEVENT_STEPPED_HYPER,
276	/** The developer have used the DBGFSTOP macro or the PDMDeviceDBGFSTOP function
277	* to bring up the debugger at a specific place.
278	*/
279	DBGFEVENT_DEV_STOP,
280	/** The VM is powering off.
281	* When this notification is received, the debugger thread should detach ASAP.
282	*/
283	DBGFEVENT_POWERING_OFF,
284
285	/** Hardware Interrupt break.
286	* @todo not yet implemented. */
287	DBGFEVENT_INTERRUPT_HARDWARE,
288	/** Software Interrupt break.
289	* @todo not yet implemented. */
290	DBGFEVENT_INTERRUPT_SOFTWARE,
291
292	/** The first selectable event.
293	* Whether the debugger wants or doesn't want these events can be configured
294	* via DBGFR3xxx and queried via DBGFR3yyy. */
295	DBGFEVENT_FIRST_SELECTABLE,
296	/** Tripple fault. */
297	DBGFEVENT_TRIPLE_FAULT = DBGFEVENT_FIRST_SELECTABLE,
298
299	/** @name Exception events
300	* The exception events normally represents guest exceptions, but depending on
301	* the execution mode some virtualization exceptions may occure (no nested
302	* paging, raw-mode, ++). When necessary, we will request additional VM exits.
303	* @{ */
304	DBGFEVENT_XCPT_FIRST, /*< The first exception event. /
305	DBGFEVENT_XCPT_DE /*< 0x00 - \#DE - Fault - NoErr - Integer divide error (zero/overflow). /
306	= DBGFEVENT_XCPT_FIRST,
307	DBGFEVENT_XCPT_DB, /*< 0x01 - \#DB - trap/fault - NoErr - debug event. /
308	DBGFEVENT_XCPT_02, /*< 0x02 - Reserved for NMI, see interrupt events. /
309	DBGFEVENT_XCPT_BP, /*< 0x03 - \#BP - Trap - NoErr - Breakpoint, INT 3 instruction. /
310	DBGFEVENT_XCPT_OF, /*< 0x04 - \#OF - Trap - NoErr - Overflow, INTO instruction. /
311	DBGFEVENT_XCPT_BR, /*< 0x05 - \#BR - Fault - NoErr - BOUND Range Exceeded, BOUND instruction. /
312	DBGFEVENT_XCPT_UD, /*< 0x06 - \#UD - Fault - NoErr - Undefined(/Invalid) Opcode. /
313	DBGFEVENT_XCPT_NM, /*< 0x07 - \#NM - Fault - NoErr - Device not available, FP or (F)WAIT instruction. /
314	DBGFEVENT_XCPT_DF, /*< 0x08 - \#DF - Abort - Err=0 - Double fault. /
315	DBGFEVENT_XCPT_09, /*< 0x09 - Int9 - Fault - NoErr - Coprocessor Segment Overrun (obsolete). /
316	DBGFEVENT_XCPT_TS, /*< 0x0a - \#TS - Fault - ErrCd - Invalid TSS, Taskswitch or TSS access. /
317	DBGFEVENT_XCPT_NP, /*< 0x0b - \#NP - Fault - ErrCd - Segment not present. /
318	DBGFEVENT_XCPT_SS, /*< 0x0c - \#SS - Fault - ErrCd - Stack-Segment fault. /
319	DBGFEVENT_XCPT_GP, /*< 0x0d - \#GP - Fault - ErrCd - General protection fault. /
320	DBGFEVENT_XCPT_PF, /*< 0x0e - \#PF - Fault - ErrCd - Page fault. - interrupt gate!!! /
321	DBGFEVENT_XCPT_0f, /*< 0x0f - Rsvd - Resvd - Resvd - Intel Reserved. /
322	DBGFEVENT_XCPT_MF, /*< 0x10 - \#MF - Fault - NoErr - x86 FPU Floating-Point Error (Math fault), FP or (F)WAIT instruction. /
323	DBGFEVENT_XCPT_AC, /*< 0x11 - \#AC - Fault - Err=0 - Alignment Check. /
324	DBGFEVENT_XCPT_MC, /*< 0x12 - \#MC - Abort - NoErr - Machine Check. /
325	DBGFEVENT_XCPT_XF, /*< 0x13 - \#XF - Fault - NoErr - SIMD Floating-Point Exception. /
326	DBGFEVENT_XCPT_VE, /*< 0x14 - \#VE - Fault - Noerr - Virtualization exception. /
327	DBGFEVENT_XCPT_15, /*< 0x15 - Intel Reserved. /
328	DBGFEVENT_XCPT_16, /*< 0x16 - Intel Reserved. /
329	DBGFEVENT_XCPT_17, /*< 0x17 - Intel Reserved. /
330	DBGFEVENT_XCPT_18, /*< 0x18 - Intel Reserved. /
331	DBGFEVENT_XCPT_19, /*< 0x19 - Intel Reserved. /
332	DBGFEVENT_XCPT_1a, /*< 0x1a - Intel Reserved. /
333	DBGFEVENT_XCPT_1b, /*< 0x1b - Intel Reserved. /
334	DBGFEVENT_XCPT_1c, /*< 0x1c - Intel Reserved. /
335	DBGFEVENT_XCPT_1d, /*< 0x1d - Intel Reserved. /
336	DBGFEVENT_XCPT_SX, /*< 0x1e - \#SX - Fault - ErrCd - Security Exception. /
337	DBGFEVENT_XCPT_1f, /*< 0x1f - Intel Reserved. /
338	DBGFEVENT_XCPT_LAST /*< The last exception event. /
339	= DBGFEVENT_XCPT_1f,
340	/** @} */
341
342	/** @name Instruction events
343	* The instruction events exerts all possible effort to intercept the
344	* relevant instructions. However, in some execution modes we won't be able
345	* to catch them. So it goes.
346	* @{ */
347	DBGFEVENT_INSTR_FIRST, /*< The first VM instruction event. /
348	DBGFEVENT_INSTR_HALT /*< Instruction: HALT /
349	= DBGFEVENT_INSTR_FIRST,
350	DBGFEVENT_INSTR_MWAIT, /*< Instruction: MWAIT /
351	DBGFEVENT_INSTR_MONITOR, /*< Instruction: MONITOR /
352	DBGFEVENT_INSTR_CPUID, /*< Instruction: CPUID (missing stuff in raw-mode). /
353	DBGFEVENT_INSTR_INVD, /*< Instruction: INVD /
354	DBGFEVENT_INSTR_WBINVD, /*< Instruction: WBINVD /
355	DBGFEVENT_INSTR_INVLPG, /*< Instruction: INVLPG /
356	DBGFEVENT_INSTR_RDTSC, /*< Instruction: RDTSC /
357	DBGFEVENT_INSTR_RDTSCP, /*< Instruction: RDTSCP /
358	DBGFEVENT_INSTR_RDPMC, /*< Instruction: RDPMC /
359	DBGFEVENT_INSTR_RDMSR, /*< Instruction: RDMSR /
360	DBGFEVENT_INSTR_WRMSR, /*< Instruction: WRMSR /
361	DBGFEVENT_INSTR_CRX_READ, /*< Instruction: CRx read instruction (missing smsw in raw-mode, and reads in general in VT-x). /
362	DBGFEVENT_INSTR_CRX_WRITE, /*< Instruction: CRx write /
363	DBGFEVENT_INSTR_DRX_READ, /*< Instruction: DRx read /
364	DBGFEVENT_INSTR_DRX_WRITE, /*< Instruction: DRx write /
365	DBGFEVENT_INSTR_PAUSE, /*< Instruction: PAUSE instruction (not in raw-mode). /
366	DBGFEVENT_INSTR_XSETBV, /*< Instruction: XSETBV /
367	DBGFEVENT_INSTR_SIDT, /*< Instruction: SIDT /
368	DBGFEVENT_INSTR_LIDT, /*< Instruction: LIDT /
369	DBGFEVENT_INSTR_SGDT, /*< Instruction: SGDT /
370	DBGFEVENT_INSTR_LGDT, /*< Instruction: LGDT /
371	DBGFEVENT_INSTR_SLDT, /*< Instruction: SLDT /
372	DBGFEVENT_INSTR_LLDT, /*< Instruction: LLDT /
373	DBGFEVENT_INSTR_STR, /*< Instruction: STR /
374	DBGFEVENT_INSTR_LTR, /*< Instruction: LTR /
375	DBGFEVENT_INSTR_GETSEC, /*< Instruction: GETSEC /
376	DBGFEVENT_INSTR_RSM, /*< Instruction: RSM /
377	DBGFEVENT_INSTR_RDRAND, /*< Instruction: RDRAND /
378	DBGFEVENT_INSTR_RDSEED, /*< Instruction: RDSEED /
379	DBGFEVENT_INSTR_XSAVES, /*< Instruction: XSAVES /
380	DBGFEVENT_INSTR_XRSTORS, /*< Instruction: XRSTORS /
381	DBGFEVENT_INSTR_VMM_CALL, /*< Instruction: VMCALL (intel) or VMMCALL (AMD) /
382	DBGFEVENT_INSTR_LAST_COMMON /*< Instruction: the last common event. /
383	= DBGFEVENT_INSTR_VMM_CALL,
384	DBGFEVENT_INSTR_VMX_FIRST, /*< Instruction: VT-x - First. /
385	DBGFEVENT_INSTR_VMX_VMCLEAR /*< Instruction: VT-x VMCLEAR /
386	= DBGFEVENT_INSTR_VMX_FIRST,
387	DBGFEVENT_INSTR_VMX_VMLAUNCH, /*< Instruction: VT-x VMLAUNCH /
388	DBGFEVENT_INSTR_VMX_VMPTRLD, /*< Instruction: VT-x VMPTRLD /
389	DBGFEVENT_INSTR_VMX_VMPTRST, /*< Instruction: VT-x VMPTRST /
390	DBGFEVENT_INSTR_VMX_VMREAD, /*< Instruction: VT-x VMREAD /
391	DBGFEVENT_INSTR_VMX_VMRESUME, /*< Instruction: VT-x VMRESUME /
392	DBGFEVENT_INSTR_VMX_VMWRITE, /*< Instruction: VT-x VMWRITE /
393	DBGFEVENT_INSTR_VMX_VMXOFF, /*< Instruction: VT-x VMXOFF /
394	DBGFEVENT_INSTR_VMX_VMXON, /*< Instruction: VT-x VMXON /
395	DBGFEVENT_INSTR_VMX_VMFUNC, /*< Instruction: VT-x VMFUNC /
396	DBGFEVENT_INSTR_VMX_INVEPT, /*< Instruction: VT-x INVEPT /
397	DBGFEVENT_INSTR_VMX_INVVPID, /*< Instruction: VT-x INVVPID /
398	DBGFEVENT_INSTR_VMX_INVPCID, /*< Instruction: VT-x INVPCID /
399	DBGFEVENT_INSTR_VMX_LAST /*< Instruction: VT-x - Last. /
400	= DBGFEVENT_INSTR_VMX_INVPCID,
401	DBGFEVENT_INSTR_SVM_FIRST, /*< Instruction: AMD-V - first /
402	DBGFEVENT_INSTR_SVM_VMRUN /*< Instruction: AMD-V VMRUN /
403	= DBGFEVENT_INSTR_SVM_FIRST,
404	DBGFEVENT_INSTR_SVM_VMLOAD, /*< Instruction: AMD-V VMLOAD /
405	DBGFEVENT_INSTR_SVM_VMSAVE, /*< Instruction: AMD-V VMSAVE /
406	DBGFEVENT_INSTR_SVM_STGI, /*< Instruction: AMD-V STGI /
407	DBGFEVENT_INSTR_SVM_CLGI, /*< Instruction: AMD-V CLGI /
408	DBGFEVENT_INSTR_SVM_LAST /*< Instruction: The last ADM-V VM exit event. /
409	= DBGFEVENT_INSTR_SVM_CLGI,
410	DBGFEVENT_INSTR_LAST /*< Instruction: The last instruction event. /
411	= DBGFEVENT_INSTR_SVM_LAST,
412	/** @} */
413
414
415	/** @name VM exit events.
416	* VM exits events for VT-x and AMD-V execution mode. Many of the VM exits
417	* behind these events are also directly translated into instruction events, but
418	* the difference here is that the exit events will not try provoke the exits.
419	* @{ */
420	DBGFEVENT_EXIT_FIRST, /*< The first VM exit event. /
421	DBGFEVENT_EXIT_TASK_SWITCH /*< Exit: Task switch. /
422	= DBGFEVENT_EXIT_FIRST,
423	DBGFEVENT_EXIT_HALT, /*< Exit: HALT instruction. /
424	DBGFEVENT_EXIT_MWAIT, /*< Exit: MWAIT instruction. /
425	DBGFEVENT_EXIT_MONITOR, /*< Exit: MONITOR instruction. /
426	DBGFEVENT_EXIT_CPUID, /*< Exit: CPUID instruction (missing stuff in raw-mode). /
427	DBGFEVENT_EXIT_INVD, /*< Exit: INVD instruction. /
428	DBGFEVENT_EXIT_WBINVD, /*< Exit: WBINVD instruction. /
429	DBGFEVENT_EXIT_INVLPG, /*< Exit: INVLPG instruction. /
430	DBGFEVENT_EXIT_RDTSC, /*< Exit: RDTSC instruction. /
431	DBGFEVENT_EXIT_RDTSCP, /*< Exit: RDTSCP instruction. /
432	DBGFEVENT_EXIT_RDPMC, /*< Exit: RDPMC instruction. /
433	DBGFEVENT_EXIT_RDMSR, /*< Exit: RDMSR instruction. /
434	DBGFEVENT_EXIT_WRMSR, /*< Exit: WRMSR instruction. /
435	DBGFEVENT_EXIT_CRX_READ, /*< Exit: CRx read instruction (missing smsw in raw-mode, and reads in general in VT-x). /
436	DBGFEVENT_EXIT_CRX_WRITE, /*< Exit: CRx write instruction. /
437	DBGFEVENT_EXIT_DRX_READ, /*< Exit: DRx read instruction. /
438	DBGFEVENT_EXIT_DRX_WRITE, /*< Exit: DRx write instruction. /
439	DBGFEVENT_EXIT_PAUSE, /*< Exit: PAUSE instruction (not in raw-mode). /
440	DBGFEVENT_EXIT_XSETBV, /*< Exit: XSETBV instruction. /
441	DBGFEVENT_EXIT_SIDT, /*< Exit: SIDT instruction. /
442	DBGFEVENT_EXIT_LIDT, /*< Exit: LIDT instruction. /
443	DBGFEVENT_EXIT_SGDT, /*< Exit: SGDT instruction. /
444	DBGFEVENT_EXIT_LGDT, /*< Exit: LGDT instruction. /
445	DBGFEVENT_EXIT_SLDT, /*< Exit: SLDT instruction. /
446	DBGFEVENT_EXIT_LLDT, /*< Exit: LLDT instruction. /
447	DBGFEVENT_EXIT_STR, /*< Exit: STR instruction. /
448	DBGFEVENT_EXIT_LTR, /*< Exit: LTR instruction. /
449	DBGFEVENT_EXIT_GETSEC, /*< Exit: GETSEC instruction. /
450	DBGFEVENT_EXIT_RSM, /*< Exit: RSM instruction. /
451	DBGFEVENT_EXIT_RDRAND, /*< Exit: RDRAND instruction. /
452	DBGFEVENT_EXIT_RDSEED, /*< Exit: RDSEED instruction. /
453	DBGFEVENT_EXIT_XSAVES, /*< Exit: XSAVES instruction. /
454	DBGFEVENT_EXIT_XRSTORS, /*< Exit: XRSTORS instruction. /
455	DBGFEVENT_EXIT_VMM_CALL, /*< Exit: VMCALL (intel) or VMMCALL (AMD) instruction. /
456	DBGFEVENT_EXIT_LAST_COMMON /*< Exit: the last common event. /
457	= DBGFEVENT_EXIT_VMM_CALL,
458	DBGFEVENT_EXIT_VMX_FIRST, /*< Exit: VT-x - First. /
459	DBGFEVENT_EXIT_VMX_VMCLEAR /*< Exit: VT-x VMCLEAR instruction. /
460	= DBGFEVENT_EXIT_VMX_FIRST,
461	DBGFEVENT_EXIT_VMX_VMLAUNCH, /*< Exit: VT-x VMLAUNCH instruction. /
462	DBGFEVENT_EXIT_VMX_VMPTRLD, /*< Exit: VT-x VMPTRLD instruction. /
463	DBGFEVENT_EXIT_VMX_VMPTRST, /*< Exit: VT-x VMPTRST instruction. /
464	DBGFEVENT_EXIT_VMX_VMREAD, /*< Exit: VT-x VMREAD instruction. /
465	DBGFEVENT_EXIT_VMX_VMRESUME, /*< Exit: VT-x VMRESUME instruction. /
466	DBGFEVENT_EXIT_VMX_VMWRITE, /*< Exit: VT-x VMWRITE instruction. /
467	DBGFEVENT_EXIT_VMX_VMXOFF, /*< Exit: VT-x VMXOFF instruction. /
468	DBGFEVENT_EXIT_VMX_VMXON, /*< Exit: VT-x VMXON instruction. /
469	DBGFEVENT_EXIT_VMX_VMFUNC, /*< Exit: VT-x VMFUNC instruction. /
470	DBGFEVENT_EXIT_VMX_INVEPT, /*< Exit: VT-x INVEPT instruction. /
471	DBGFEVENT_EXIT_VMX_INVVPID, /*< Exit: VT-x INVVPID instruction. /
472	DBGFEVENT_EXIT_VMX_INVPCID, /*< Exit: VT-x INVPCID instruction. /
473	DBGFEVENT_EXIT_VMX_EPT_VIOLATION, /*< Exit: VT-x EPT violation. /
474	DBGFEVENT_EXIT_VMX_EPT_MISCONFIG, /*< Exit: VT-x EPT misconfiguration. /
475	DBGFEVENT_EXIT_VMX_VAPIC_ACCESS, /*< Exit: VT-x Virtual APIC page access. /
476	DBGFEVENT_EXIT_VMX_VAPIC_WRITE, /*< Exit: VT-x Virtual APIC write. /
477	DBGFEVENT_EXIT_VMX_LAST /*< Exit: VT-x - Last. /
478	= DBGFEVENT_EXIT_VMX_VAPIC_WRITE,
479	DBGFEVENT_EXIT_SVM_FIRST, /*< Exit: AMD-V - first /
480	DBGFEVENT_EXIT_SVM_VMRUN /*< Exit: AMD-V VMRUN instruction. /
481	= DBGFEVENT_EXIT_SVM_FIRST,
482	DBGFEVENT_EXIT_SVM_VMLOAD, /*< Exit: AMD-V VMLOAD instruction. /
483	DBGFEVENT_EXIT_SVM_VMSAVE, /*< Exit: AMD-V VMSAVE instruction. /
484	DBGFEVENT_EXIT_SVM_STGI, /*< Exit: AMD-V STGI instruction. /
485	DBGFEVENT_EXIT_SVM_CLGI, /*< Exit: AMD-V CLGI instruction. /
486	DBGFEVENT_EXIT_SVM_LAST /*< Exit: The last ADM-V VM exit event. /
487	= DBGFEVENT_EXIT_SVM_CLGI,
488	DBGFEVENT_EXIT_LAST /*< Exit: The last VM exit event. /
489	= DBGFEVENT_EXIT_SVM_LAST,
490	/** @} */
491
492
493	/** Access to an unassigned I/O port.
494	* @todo not yet implemented. */
495	DBGFEVENT_IOPORT_UNASSIGNED,
496	/** Access to an unused I/O port on a device.
497	* @todo not yet implemented. */
498	DBGFEVENT_IOPORT_UNUSED,
499	/** Unassigned memory event.
500	* @todo not yet implemented. */
501	DBGFEVENT_MEMORY_UNASSIGNED,
502	/** Attempt to write to unshadowed ROM.
503	* @todo not yet implemented. */
504	DBGFEVENT_MEMORY_ROM_WRITE,
505
506	/** Windows guest reported BSOD via hyperv MSRs. */
507	DBGFEVENT_BSOD_MSR,
508	/** Windows guest reported BSOD via EFI variables. */
509	DBGFEVENT_BSOD_EFI,
510	/** Windows guest reported BSOD via VMMDev. */
511	DBGFEVENT_BSOD_VMMDEV,
512
513	/** End of valid event values. */
514	DBGFEVENT_END,
515	/** The usual 32-bit hack. */
516	DBGFEVENT_32BIT_HACK = 0x7fffffff
517	} DBGFEVENTTYPE;
518	AssertCompile(DBGFEVENT_XCPT_LAST - DBGFEVENT_XCPT_FIRST == 0x1f);
519
520	/**
521	* The context of an event.
522	*/
523	typedef enum DBGFEVENTCTX
524	{
525	/** The usual invalid entry. */
526	DBGFEVENTCTX_INVALID = 0,
527	/** Raw mode. */
528	DBGFEVENTCTX_RAW,
529	/** Recompiled mode. */
530	DBGFEVENTCTX_REM,
531	/** VMX / AVT mode. */
532	DBGFEVENTCTX_HM,
533	/** Hypervisor context. */
534	DBGFEVENTCTX_HYPER,
535	/** Other mode */
536	DBGFEVENTCTX_OTHER,
537
538	/** The usual 32-bit hack */
539	DBGFEVENTCTX_32BIT_HACK = 0x7fffffff
540	} DBGFEVENTCTX;
541
542	/**
543	* VMM Debug Event.
544	*/
545	typedef struct DBGFEVENT
546	{
547	/** Type. */
548	DBGFEVENTTYPE enmType;
549	/** Context */
550	DBGFEVENTCTX enmCtx;
551	/** The vCPU/EMT which generated the event. */
552	VMCPUID idCpu;
553	/** Reserved. */
554	uint32_t uReserved;
555	/** Type specific data. */
556	union
557	{
558	/** Fatal error details. */
559	struct
560	{
561	/** The GC return code. */
562	int rc;
563	} FatalError;
564
565	/** Source location. */
566	struct
567	{
568	/** File name. */
569	R3PTRTYPE(const char *) pszFile;
570	/** Function name. */
571	R3PTRTYPE(const char *) pszFunction;
572	/** Message. */
573	R3PTRTYPE(const char *) pszMessage;
574	/** Line number. */
575	unsigned uLine;
576	} Src;
577
578	/** Assertion messages. */
579	struct
580	{
581	/** The first message. */
582	R3PTRTYPE(const char *) pszMsg1;
583	/** The second message. */
584	R3PTRTYPE(const char *) pszMsg2;
585	} Assert;
586
587	/** Breakpoint. */
588	struct DBGFEVENTBP
589	{
590	#ifndef VBOX_WITH_LOTS_OF_DBGF_BPS
591	/** The identifier of the breakpoint which was hit. */
592	RTUINT iBp;
593	#else
594	/** The handle of the breakpoint which was hit. */
595	DBGFBP hBp;
596	#endif
597	} Bp;
598
599	/** Generic debug event. */
600	struct DBGFEVENTGENERIC
601	{
602	/** Number of arguments. */
603	uint8_t cArgs;
604	/** Alignment padding. */
605	uint8_t uPadding[7];
606	/** Arguments. */
607	uint64_t auArgs[5];
608	} Generic;
609
610	/** Padding for ensuring that the structure is 8 byte aligned. */
611	uint64_t au64Padding[6];
612	} u;
613	} DBGFEVENT;
614	AssertCompileSizeAlignment(DBGFEVENT, 8);
615	AssertCompileSize(DBGFEVENT, 64);
616	/** Pointer to VMM Debug Event. */
617	typedef DBGFEVENT *PDBGFEVENT;
618	/** Pointer to const VMM Debug Event. */
619	typedef const DBGFEVENT *PCDBGFEVENT;
620
621	#ifdef IN_RING3 /* The event API only works in ring-3. */
622
623	/** @def DBGFSTOP
624	* Stops the debugger raising a DBGFEVENT_DEVELOPER_STOP event.
625	*
626	* @returns VBox status code which must be propagated up to EM if not VINF_SUCCESS.
627	* @param pVM The cross context VM structure.
628	*/
629	# ifdef VBOX_STRICT
630	# define DBGFSTOP(pVM) DBGFR3EventSrc(pVM, DBGFEVENT_DEV_STOP, __FILE__, __LINE__, __PRETTY_FUNCTION__, NULL)
631	# else
632	# define DBGFSTOP(pVM) VINF_SUCCESS
633	# endif
634
635	VMMR3_INT_DECL(int) DBGFR3Init(PVM pVM);
636	VMMR3_INT_DECL(int) DBGFR3Term(PVM pVM);
637	VMMR3DECL(void) DBGFR3TermUVM(PUVM pUVM);
638	VMMR3_INT_DECL(void) DBGFR3PowerOff(PVM pVM);
639	VMMR3_INT_DECL(void) DBGFR3Relocate(PVM pVM, RTGCINTPTR offDelta);
640
641	VMMR3_INT_DECL(int) DBGFR3VMMForcedAction(PVM pVM, PVMCPU pVCpu);
642	VMMR3_INT_DECL(VBOXSTRICTRC) DBGFR3EventHandlePending(PVM pVM, PVMCPU pVCpu);
643	VMMR3DECL(int) DBGFR3Event(PVM pVM, DBGFEVENTTYPE enmEvent);
644	VMMR3DECL(int) DBGFR3EventSrc(PVM pVM, DBGFEVENTTYPE enmEvent, const char *pszFile, unsigned uLine,
645	const char pszFunction, const char pszFormat, ...) RT_IPRT_FORMAT_ATTR_MAYBE_NULL(6, 7);
646	VMMR3DECL(int) DBGFR3EventSrcV(PVM pVM, DBGFEVENTTYPE enmEvent, const char *pszFile, unsigned uLine,
647	const char pszFunction, const char pszFormat, va_list args) RT_IPRT_FORMAT_ATTR_MAYBE_NULL(6, 0);
648	VMMR3_INT_DECL(int) DBGFR3EventAssertion(PVM pVM, DBGFEVENTTYPE enmEvent, const char pszMsg1, const char pszMsg2);
649	VMMR3_INT_DECL(int) DBGFR3EventBreakpoint(PVM pVM, DBGFEVENTTYPE enmEvent);
650
651	VMMR3_INT_DECL(int) DBGFR3PrgStep(PVMCPU pVCpu);
652
653	VMMR3DECL(int) DBGFR3Attach(PUVM pUVM);
654	VMMR3DECL(int) DBGFR3Detach(PUVM pUVM);
655	VMMR3DECL(int) DBGFR3EventWait(PUVM pUVM, RTMSINTERVAL cMillies, PDBGFEVENT pEvent);
656	VMMR3DECL(int) DBGFR3Halt(PUVM pUVM, VMCPUID idCpu);
657	VMMR3DECL(bool) DBGFR3IsHalted(PUVM pUVM, VMCPUID idCpu);
658	VMMR3DECL(int) DBGFR3QueryWaitable(PUVM pUVM);
659	VMMR3DECL(int) DBGFR3Resume(PUVM pUVM, VMCPUID idCpu);
660	VMMR3DECL(int) DBGFR3InjectNMI(PUVM pUVM, VMCPUID idCpu);
661	VMMR3DECL(int) DBGFR3Step(PUVM pUVM, VMCPUID idCpu);
662	VMMR3DECL(int) DBGFR3StepEx(PUVM pUVM, VMCPUID idCpu, uint32_t fFlags, PCDBGFADDRESS pStopPcAddr,
663	PCDBGFADDRESS pStopPopAddr, RTGCUINTPTR cbStopPop, uint32_t cMaxSteps);
664
665	/** @name DBGF_STEP_F_XXX - Flags for DBGFR3StepEx.
666	*
667	* @note The stop filters are not applied to the starting instruction.
668	*
669	* @{ */
670	/** Step into CALL, INT, SYSCALL and SYSENTER instructions. */
671	#define DBGF_STEP_F_INTO RT_BIT_32(0)
672	/** Step over CALL, INT, SYSCALL and SYSENTER instruction when considering
673	* what's "next". */
674	#define DBGF_STEP_F_OVER RT_BIT_32(1)
675
676	/** Stop on the next CALL, INT, SYSCALL, SYSENTER instruction. */
677	#define DBGF_STEP_F_STOP_ON_CALL RT_BIT_32(8)
678	/** Stop on the next RET, IRET, SYSRET, SYSEXIT instruction. */
679	#define DBGF_STEP_F_STOP_ON_RET RT_BIT_32(9)
680	/** Stop after the next RET, IRET, SYSRET, SYSEXIT instruction. */
681	#define DBGF_STEP_F_STOP_AFTER_RET RT_BIT_32(10)
682	/** Stop on the given address.
683	* The comparison will be made using effective (flat) addresses. */
684	#define DBGF_STEP_F_STOP_ON_ADDRESS RT_BIT_32(11)
685	/** Stop when the stack pointer pops to or past the given address.
686	* The comparison will be made using effective (flat) addresses. */
687	#define DBGF_STEP_F_STOP_ON_STACK_POP RT_BIT_32(12)
688	/** Mask of stop filter flags. */
689	#define DBGF_STEP_F_STOP_FILTER_MASK UINT32_C(0x00001f00)
690
691	/** Mask of valid flags. */
692	#define DBGF_STEP_F_VALID_MASK UINT32_C(0x00001f03)
693	/** @} */
694
695	/**
696	* Event configuration array element, see DBGFR3EventConfigEx.
697	*/
698	typedef struct DBGFEVENTCONFIG
699	{
700	/** The event to configure */
701	DBGFEVENTTYPE enmType;
702	/** The new state. */
703	bool fEnabled;
704	/** Unused. */
705	uint8_t abUnused[3];
706	} DBGFEVENTCONFIG;
707	/** Pointer to an event config. */
708	typedef DBGFEVENTCONFIG *PDBGFEVENTCONFIG;
709	/** Pointer to a const event config. */
710	typedef const DBGFEVENTCONFIG *PCDBGFEVENTCONFIG;
711
712	VMMR3DECL(int) DBGFR3EventConfigEx(PUVM pUVM, PCDBGFEVENTCONFIG paConfigs, size_t cConfigs);
713	VMMR3DECL(int) DBGFR3EventConfig(PUVM pUVM, DBGFEVENTTYPE enmEvent, bool fEnabled);
714	VMMR3DECL(bool) DBGFR3EventIsEnabled(PUVM pUVM, DBGFEVENTTYPE enmEvent);
715	VMMR3DECL(int) DBGFR3EventQuery(PUVM pUVM, PDBGFEVENTCONFIG paConfigs, size_t cConfigs);
716
717	/** @name DBGFINTERRUPTSTATE_XXX - interrupt break state.
718	* @{ */
719	#define DBGFINTERRUPTSTATE_DISABLED 0
720	#define DBGFINTERRUPTSTATE_ENABLED 1
721	#define DBGFINTERRUPTSTATE_DONT_TOUCH 2
722	/** @} */
723
724	/**
725	* Interrupt break state configuration entry.
726	*/
727	typedef struct DBGFINTERRUPTCONFIG
728	{
729	/** The interrupt number. */
730	uint8_t iInterrupt;
731	/** The hardware interrupt state (DBGFINTERRUPTSTATE_XXX). */
732	uint8_t enmHardState;
733	/** The software interrupt state (DBGFINTERRUPTSTATE_XXX). */
734	uint8_t enmSoftState;
735	} DBGFINTERRUPTCONFIG;
736	/** Pointer to an interrupt break state config entyr. */
737	typedef DBGFINTERRUPTCONFIG *PDBGFINTERRUPTCONFIG;
738	/** Pointer to a const interrupt break state config entyr. */
739	typedef DBGFINTERRUPTCONFIG const *PCDBGFINTERRUPTCONFIG;
740
741	VMMR3DECL(int) DBGFR3InterruptConfigEx(PUVM pUVM, PCDBGFINTERRUPTCONFIG paConfigs, size_t cConfigs);
742	VMMR3DECL(int) DBGFR3InterruptHardwareConfig(PUVM pUVM, uint8_t iInterrupt, bool fEnabled);
743	VMMR3DECL(int) DBGFR3InterruptSoftwareConfig(PUVM pUVM, uint8_t iInterrupt, bool fEnabled);
744	VMMR3DECL(int) DBGFR3InterruptHardwareIsEnabled(PUVM pUVM, uint8_t iInterrupt);
745	VMMR3DECL(int) DBGFR3InterruptSoftwareIsEnabled(PUVM pUVM, uint8_t iInterrupt);
746
747	#endif /* IN_RING3 */
748
749	/** @def DBGF_IS_EVENT_ENABLED
750	* Checks if a selectable debug event is enabled or not (fast).
751	*
752	* @returns true/false.
753	* @param a_pVM Pointer to the cross context VM structure.
754	* @param a_enmEvent The selectable event to check.
755	* @remarks Only for use internally in the VMM. Use DBGFR3EventIsEnabled elsewhere.
756	*/
757	#if defined(VBOX_STRICT) && defined(RT_COMPILER_SUPPORTS_LAMBDA)
758	# define DBGF_IS_EVENT_ENABLED(a_pVM, a_enmEvent) \
759	([](PVM a_pLambdaVM, DBGFEVENTTYPE a_enmLambdaEvent) -> bool { \
760	Assert( a_enmLambdaEvent >= DBGFEVENT_FIRST_SELECTABLE \
761	\|\| a_enmLambdaEvent == DBGFEVENT_INTERRUPT_HARDWARE \
762	\|\| a_enmLambdaEvent == DBGFEVENT_INTERRUPT_SOFTWARE); \
763	Assert(a_enmLambdaEvent < DBGFEVENT_END); \
764	return ASMBitTest(&a_pLambdaVM->dbgf.ro.bmSelectedEvents, a_enmLambdaEvent); \
765	}(a_pVM, a_enmEvent))
766	#elif defined(VBOX_STRICT) && defined(__GNUC__)
767	# define DBGF_IS_EVENT_ENABLED(a_pVM, a_enmEvent) \
768	__extension__ ({ \
769	Assert( (a_enmEvent) >= DBGFEVENT_FIRST_SELECTABLE \
770	\|\| (a_enmEvent) == DBGFEVENT_INTERRUPT_HARDWARE \
771	\|\| (a_enmEvent) == DBGFEVENT_INTERRUPT_SOFTWARE); \
772	Assert((a_enmEvent) < DBGFEVENT_END); \
773	ASMBitTest(&(a_pVM)->dbgf.ro.bmSelectedEvents, (a_enmEvent)); \
774	})
775	#else
776	# define DBGF_IS_EVENT_ENABLED(a_pVM, a_enmEvent) \
777	ASMBitTest(&(a_pVM)->dbgf.ro.bmSelectedEvents, (a_enmEvent))
778	#endif
779
780
781	/** @def DBGF_IS_HARDWARE_INT_ENABLED
782	* Checks if hardware interrupt interception is enabled or not for an interrupt.
783	*
784	* @returns true/false.
785	* @param a_pVM Pointer to the cross context VM structure.
786	* @param a_iInterrupt Interrupt to check.
787	* @remarks Only for use internally in the VMM. Use
788	* DBGFR3InterruptHardwareIsEnabled elsewhere.
789	*/
790	#define DBGF_IS_HARDWARE_INT_ENABLED(a_pVM, a_iInterrupt) \
791	ASMBitTest(&(a_pVM)->dbgf.ro.bmHardIntBreakpoints, (uint8_t)(a_iInterrupt))
792
793	/** @def DBGF_IS_SOFTWARE_INT_ENABLED
794	* Checks if software interrupt interception is enabled or not for an interrupt.
795	*
796	* @returns true/false.
797	* @param a_pVM Pointer to the cross context VM structure.
798	* @param a_iInterrupt Interrupt to check.
799	* @remarks Only for use internally in the VMM. Use
800	* DBGFR3InterruptSoftwareIsEnabled elsewhere.
801	*/
802	#define DBGF_IS_SOFTWARE_INT_ENABLED(a_pVM, a_iInterrupt) \
803	ASMBitTest(&(a_pVM)->dbgf.ro.bmSoftIntBreakpoints, (uint8_t)(a_iInterrupt))
804
805
806
807	/** Breakpoint type. */
808	typedef enum DBGFBPTYPE
809	{
810	#ifndef VBOX_WITH_LOTS_OF_DBGF_BPS
811	/** Free breakpoint entry. */
812	DBGFBPTYPE_FREE = 0,
813	#else
814	/** Invalid breakpoint type. */
815	DBGFBPTYPE_INVALID = 0,
816	#endif
817	/** Debug register. */
818	DBGFBPTYPE_REG,
819	/** INT 3 instruction. */
820	DBGFBPTYPE_INT3,
821	#ifndef VBOX_WITH_LOTS_OF_DBGF_BPS
822	/** Recompiler. */
823	DBGFBPTYPE_REM,
824	#endif
825	/** Port I/O breakpoint. */
826	DBGFBPTYPE_PORT_IO,
827	/** Memory mapped I/O breakpoint. */
828	DBGFBPTYPE_MMIO,
829	/** ensure 32-bit size. */
830	DBGFBPTYPE_32BIT_HACK = 0x7fffffff
831	} DBGFBPTYPE;
832
833
834	/** @name DBGFBPIOACCESS_XXX - I/O (port + mmio) access types.
835	* @{ */
836	/** Byte sized read accesses. */
837	#define DBGFBPIOACCESS_READ_BYTE UINT32_C(0x00000001)
838	/** Word sized accesses. */
839	#define DBGFBPIOACCESS_READ_WORD UINT32_C(0x00000002)
840	/** Double word sized accesses. */
841	#define DBGFBPIOACCESS_READ_DWORD UINT32_C(0x00000004)
842	/** Quad word sized accesses - not available for I/O ports. */
843	#define DBGFBPIOACCESS_READ_QWORD UINT32_C(0x00000008)
844	/** Other sized accesses - not available for I/O ports. */
845	#define DBGFBPIOACCESS_READ_OTHER UINT32_C(0x00000010)
846	/** Read mask. */
847	#define DBGFBPIOACCESS_READ_MASK UINT32_C(0x0000001f)
848
849	/** Byte sized write accesses. */
850	#define DBGFBPIOACCESS_WRITE_BYTE UINT32_C(0x00000100)
851	/** Word sized write accesses. */
852	#define DBGFBPIOACCESS_WRITE_WORD UINT32_C(0x00000200)
853	/** Double word sized write accesses. */
854	#define DBGFBPIOACCESS_WRITE_DWORD UINT32_C(0x00000400)
855	/** Quad word sized write accesses - not available for I/O ports. */
856	#define DBGFBPIOACCESS_WRITE_QWORD UINT32_C(0x00000800)
857	/** Other sized write accesses - not available for I/O ports. */
858	#define DBGFBPIOACCESS_WRITE_OTHER UINT32_C(0x00001000)
859	/** Write mask. */
860	#define DBGFBPIOACCESS_WRITE_MASK UINT32_C(0x00001f00)
861
862	/** All kind of access (read, write, all sizes). */
863	#define DBGFBPIOACCESS_ALL UINT32_C(0x00001f1f)
864
865	/** The acceptable mask for I/O ports. */
866	#define DBGFBPIOACCESS_VALID_MASK_PORT_IO UINT32_C(0x00000303)
867	/** The acceptable mask for MMIO. */
868	#define DBGFBPIOACCESS_VALID_MASK_MMIO UINT32_C(0x00001f1f)
869	/** @} */
870
871	#ifdef VBOX_WITH_LOTS_OF_DBGF_BPS
872	/**
873	* The visible breakpoint state (read-only).
874	*/
875	typedef struct DBGFBPPUB
876	{
877	/** The number of breakpoint hits. */
878	uint64_t cHits;
879	/** The hit number which starts to trigger the breakpoint. */
880	uint64_t iHitTrigger;
881	/** The hit number which stops triggering the breakpoint (disables it).
882	* Use ~(uint64_t)0 if it should never stop. */
883	uint64_t iHitDisable;
884	/** The breakpoint owner handle (a nil owner defers the breakpoint to the
885	* debugger). */
886	DBGFBPOWNER hOwner;
887	/** Breakpoint type and flags, see DBGFBPTYPE for type and DBGF_BP_F_XXX for flags.
888	* Needs to be smashed together to be able to stay in the size limits. */
889	uint32_t fFlagsAndType;
890
891	/** Union of type specific data. */
892	union
893	{
894	/** The flat GC address breakpoint address for REG and INT3 breakpoints. */
895	RTGCUINTPTR GCPtr;
896
897	/** Debug register data. */
898	struct DBGFBPREG
899	{
900	/** The flat GC address of the breakpoint. */
901	RTGCUINTPTR GCPtr;
902	/** The debug register number. */
903	uint8_t iReg;
904	/** The access type (one of the X86_DR7_RW_* value). */
905	uint8_t fType;
906	/** The access size. */
907	uint8_t cb;
908	} Reg;
909
910	/** INT3 breakpoint data. */
911	struct DBGFBPINT3
912	{
913	/** The flat GC address of the breakpoint. */
914	RTGCUINTPTR GCPtr;
915	/** The physical address of the breakpoint. */
916	RTGCPHYS PhysAddr;
917	/** The byte value we replaced by the INT 3 instruction. */
918	uint8_t bOrg;
919	} Int3;
920
921	/** I/O port breakpoint data. */
922	struct DBGFBPPORTIO
923	{
924	/** The first port. */
925	RTIOPORT uPort;
926	/** The number of ports. */
927	RTIOPORT cPorts;
928	/** Valid DBGFBPIOACCESS_XXX selection, max DWORD size. */
929	uint32_t fAccess;
930	} PortIo;
931
932	/** Memory mapped I/O breakpoint data. */
933	struct DBGFBPMMIO
934	{
935	/** The first MMIO address. */
936	RTGCPHYS PhysAddr;
937	/** The size of the MMIO range in bytes. */
938	uint32_t cb;
939	/** Valid DBGFBPIOACCESS_XXX selection, max QWORD size. */
940	uint32_t fAccess;
941	} Mmio;
942
943	/** Padding to the anticipated size. */
944	uint64_t u64Padding[2];
945	} u;
946	} DBGFBPPUB;
947	AssertCompileSize(DBGFBPPUB, 64 - 8);
948	AssertCompileMembersAtSameOffset(DBGFBPPUB, u.GCPtr, DBGFBPPUB, u.Reg.GCPtr);
949	AssertCompileMembersAtSameOffset(DBGFBPPUB, u.GCPtr, DBGFBPPUB, u.Int3.GCPtr);
950
951	/** Pointer to the visible breakpoint state. */
952	typedef DBGFBPPUB *PDBGFBPPUB;
953	/** Pointer to a const visible breakpoint state. */
954	typedef const DBGFBPPUB *PCDBGFBPPUB;
955
956	/** Sets the DBGFPUB::fFlagsAndType member. */
957	#define DBGF_BP_PUB_SET_FLAGS_AND_TYPE(a_enmType, a_fFlags) ((uint32_t)(a_enmType) \| (a_fFlags))
958	/** Returns the type of the DBGFPUB::fFlagsAndType member. */
959	#define DBGF_BP_PUB_GET_TYPE(a_fFlagsAndType) ((DBGFBPTYPE)((a_fFlagsAndType) & (UINT32_C(0x7fffffff))))
960	/** Returns the enabled status of DBGFPUB::fFlagsAndType member. */
961	#define DBGF_BP_PUB_IS_ENABLED(a_fFlagsAndType) RT_BOOL((DBGFBPTYPE)((a_fFlagsAndType) & DBGF_BP_F_ENABLED))
962
963	/** @name Possible DBGFBPPUB::fFlagsAndType flags.
964	* @{ */
965	/** Default flags. */
966	#define DBGF_BP_F_DEFAULT 0
967	/** Flag whether the breakpoint is enabled currently. */
968	#define DBGF_BP_F_ENABLED RT_BIT_32(31)
969	/** @} */
970
971
972	/**
973	* Breakpoint hit handler.
974	*
975	* @returns Strict VBox status code.
976	* @retval VINF_SUCCESS if the breakpoint was handled and guest execution can resume.
977	* @retval VINF_DBGF_BP_HALT if guest execution should be stopped and the debugger should be invoked.
978	*
979	* @param pVM The cross-context VM structure pointer.
980	* @param idCpu ID of the vCPU triggering the breakpoint.
981	* @param pvUserBp User argument of the set breakpoint.
982	* @param hBp The breakpoint handle.
983	* @param pBpPub Pointer to the readonly public state of the breakpoint.
984	*
985	* @remarks The handler is called on the EMT of vCPU triggering the breakpoint and no locks are held.
986	* @remarks Any status code returned other than the ones mentioned will send the VM straight into a
987	* guru meditation.
988	*/
989	typedef DECLCALLBACKTYPE(VBOXSTRICTRC, FNDBGFBPHIT,(PVM pVM, VMCPUID idCpu, void *pvUserBp, DBGFBP hBp, PCDBGFBPPUB pBpPub));
990	/** Pointer to a FNDBGFBPHIT(). */
991	typedef FNDBGFBPHIT *PFNDBGFBPHIT;
992
993
994	#ifdef IN_RING3
995	/** @defgroup grp_dbgf_bp_r3 The DBGF Breakpoint Host Context Ring-3 API
996	* @{ */
997	VMMR3DECL(int) DBGFR3BpOwnerCreate(PUVM pUVM, PFNDBGFBPHIT pfnBpHit, PDBGFBPOWNER phBpOwner);
998	VMMR3DECL(int) DBGFR3BpOwnerDestroy(PUVM pUVM, DBGFBPOWNER hBpOwner);
999
1000	VMMR3DECL(int) DBGFR3BpSetInt3(PUVM pUVM, VMCPUID idSrcCpu, PCDBGFADDRESS pAddress,
1001	uint64_t iHitTrigger, uint64_t iHitDisable, PDBGFBP phBp);
1002	VMMR3DECL(int) DBGFR3BpSetInt3Ex(PUVM pUVM, DBGFBPOWNER hOwner, void *pvUser,
1003	VMCPUID idSrcCpu, PCDBGFADDRESS pAddress,
1004	uint64_t iHitTrigger, uint64_t iHitDisable, PDBGFBP phBp);
1005	VMMR3DECL(int) DBGFR3BpSetReg(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger,
1006	uint64_t iHitDisable, uint8_t fType, uint8_t cb, PDBGFBP phBp);
1007	VMMR3DECL(int) DBGFR3BpSetRegEx(PUVM pUVM, DBGFBPOWNER hOwner, void *pvUser,
1008	PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable,
1009	uint8_t fType, uint8_t cb, PDBGFBP phBp);
1010	VMMR3DECL(int) DBGFR3BpSetREM(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger,
1011	uint64_t iHitDisable, PDBGFBP phBp);
1012	VMMR3DECL(int) DBGFR3BpSetPortIo(PUVM pUVM, RTIOPORT uPort, RTIOPORT cPorts, uint32_t fAccess,
1013	uint64_t iHitTrigger, uint64_t iHitDisable, PDBGFBP phBp);
1014	VMMR3DECL(int) DBGFR3BpSetPortIoEx(PUVM pUVM, DBGFBPOWNER hOwner, void *pvUser,
1015	RTIOPORT uPort, RTIOPORT cPorts, uint32_t fAccess,
1016	uint64_t iHitTrigger, uint64_t iHitDisable, PDBGFBP phBp);
1017	VMMR3DECL(int) DBGFR3BpSetMmio(PUVM pUVM, RTGCPHYS GCPhys, uint32_t cb, uint32_t fAccess,
1018	uint64_t iHitTrigger, uint64_t iHitDisable, PDBGFBP phBp);
1019	VMMR3DECL(int) DBGFR3BpSetMmioEx(PUVM pUVM, DBGFBPOWNER hOwner, void *pvUser,
1020	RTGCPHYS GCPhys, uint32_t cb, uint32_t fAccess,
1021	uint64_t iHitTrigger, uint64_t iHitDisable, PDBGFBP phBp);
1022	VMMR3DECL(int) DBGFR3BpClear(PUVM pUVM, DBGFBP hBp);
1023	VMMR3DECL(int) DBGFR3BpEnable(PUVM pUVM, DBGFBP hBp);
1024	VMMR3DECL(int) DBGFR3BpDisable(PUVM pUVM, DBGFBP hBp);
1025
1026	/**
1027	* Breakpoint enumeration callback function.
1028	*
1029	* @returns VBox status code.
1030	* The enumeration stops on failure status and VINF_CALLBACK_RETURN.
1031	* @param pUVM The user mode VM handle.
1032	* @param pvUser The user argument.
1033	* @param hBp The breakpoint handle.
1034	* @param pBp Pointer to the public breakpoint information. (readonly)
1035	*/
1036	typedef DECLCALLBACKTYPE(int, FNDBGFBPENUM,(PUVM pUVM, void *pvUser, DBGFBP hBp, PCDBGFBPPUB pBpPub));
1037	/** Pointer to a breakpoint enumeration callback function. */
1038	typedef FNDBGFBPENUM *PFNDBGFBPENUM;
1039
1040	VMMR3DECL(int) DBGFR3BpEnum(PUVM pUVM, PFNDBGFBPENUM pfnCallback, void *pvUser);
1041	/** @} */
1042	#endif /* !IN_RING3 */
1043
1044
1045	#if defined(IN_RING0) \|\| defined(DOXYGEN_RUNNING)
1046	/** @defgroup grp_dbgf_bp_r0 The DBGF Breakpoint Host Context Ring-0 API
1047	* @{ */
1048	VMMR0_INT_DECL(void) DBGFR0InitPerVMData(PGVM pGVM);
1049	VMMR0_INT_DECL(void) DBGFR0CleanupVM(PGVM pGVM);
1050
1051	VMMR0_INT_DECL(int) DBGFR0BpOwnerSetUpContext(PGVM pGVM, DBGFBPOWNER hBpOwner, PFNDBGFBPHIT pfnBpHit);
1052	VMMR0_INT_DECL(int) DBGFR0BpOwnerDestroyContext(PGVM pGVM, DBGFBPOWNER hBpOwner);
1053
1054	VMMR0_INT_DECL(int) DBGFR0BpSetUpContext(PGVM pGVM, DBGFBP hBp, void *pvUser);
1055	VMMR0_INT_DECL(int) DBGFR0BpDestroyContext(PGVM pGVM, DBGFBP hBp);
1056	/** @} */
1057	#endif /* IN_RING0 \|\| DOXYGEN_RUNNING */
1058
1059	#else /* !VBOX_WITH_LOTS_OF_DBGF_BPS */
1060	/**
1061	* A Breakpoint.
1062	*/
1063	typedef struct DBGFBP
1064	{
1065	/** The number of breakpoint hits. */
1066	uint64_t cHits;
1067	/** The hit number which starts to trigger the breakpoint. */
1068	uint64_t iHitTrigger;
1069	/** The hit number which stops triggering the breakpoint (disables it).
1070	* Use ~(uint64_t)0 if it should never stop. */
1071	uint64_t iHitDisable;
1072	/** The breakpoint id. */
1073	uint16_t iBp;
1074	/** The breakpoint status - enabled or disabled. */
1075	bool fEnabled;
1076	/** The breakpoint type. */
1077	DBGFBPTYPE enmType;
1078
1079	/** Union of type specific data. */
1080	union
1081	{
1082	/** The flat GC address breakpoint address for REG, INT3 and REM breakpoints. */
1083	RTGCUINTPTR GCPtr;
1084
1085	/** Debug register data. */
1086	struct DBGFBPREG
1087	{
1088	/** The flat GC address of the breakpoint. */
1089	RTGCUINTPTR GCPtr;
1090	/** The debug register number. */
1091	uint8_t iReg;
1092	/** The access type (one of the X86_DR7_RW_* value). */
1093	uint8_t fType;
1094	/** The access size. */
1095	uint8_t cb;
1096	} Reg;
1097
1098	/** INT3 breakpoint data. */
1099	struct DBGFBPINT3
1100	{
1101	/** The flat GC address of the breakpoint. */
1102	RTGCUINTPTR GCPtr;
1103	/** The physical address of the breakpoint. */
1104	RTGCPHYS PhysAddr;
1105	/** The byte value we replaced by the INT 3 instruction. */
1106	uint8_t bOrg;
1107	} Int3;
1108
1109	/** Recompiler breakpoint data. */
1110	struct DBGFBPREM
1111	{
1112	/** The flat GC address of the breakpoint.
1113	* (PC register value?) */
1114	RTGCUINTPTR GCPtr;
1115	} Rem;
1116
1117	/** I/O port breakpoint data. */
1118	struct DBGFBPPORTIO
1119	{
1120	/** The first port. */
1121	RTIOPORT uPort;
1122	/** The number of ports. */
1123	RTIOPORT cPorts;
1124	/** Valid DBGFBPIOACCESS_XXX selection, max DWORD size. */
1125	uint32_t fAccess;
1126	} PortIo;
1127
1128	/** Memory mapped I/O breakpoint data. */
1129	struct DBGFBPMMIO
1130	{
1131	/** The first MMIO address. */
1132	RTGCPHYS PhysAddr;
1133	/** The size of the MMIO range in bytes. */
1134	uint32_t cb;
1135	/** Valid DBGFBPIOACCESS_XXX selection, max DWORD size. */
1136	uint32_t fAccess;
1137	} Mmio;
1138
1139	/** Paddind to ensure that the size is identical on win32 and linux. */
1140	uint64_t u64Padding[3];
1141	} u;
1142	} DBGFBP;
1143	AssertCompileMembersAtSameOffset(DBGFBP, u.GCPtr, DBGFBP, u.Reg.GCPtr);
1144	AssertCompileMembersAtSameOffset(DBGFBP, u.GCPtr, DBGFBP, u.Int3.GCPtr);
1145	AssertCompileMembersAtSameOffset(DBGFBP, u.GCPtr, DBGFBP, u.Rem.GCPtr);
1146
1147	/** Pointer to a breakpoint. */
1148	typedef DBGFBP *PDBGFBP;
1149	/** Pointer to a const breakpoint. */
1150	typedef const DBGFBP *PCDBGFBP;
1151
1152	# ifdef IN_RING3 /* The breakpoint management API is only available in ring-3. */
1153	VMMR3DECL(int) DBGFR3BpSetInt3(PUVM pUVM, VMCPUID idSrcCpu, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
1154	VMMR3DECL(int) DBGFR3BpSetReg(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable,
1155	uint8_t fType, uint8_t cb, uint32_t *piBp);
1156	VMMR3DECL(int) DBGFR3BpSetREM(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
1157	VMMR3DECL(int) DBGFR3BpSetPortIo(PUVM pUVM, RTIOPORT uPort, RTIOPORT cPorts, uint32_t fAccess,
1158	uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
1159	VMMR3DECL(int) DBGFR3BpSetMmio(PUVM pUVM, RTGCPHYS GCPhys, uint32_t cb, uint32_t fAccess,
1160	uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
1161	VMMR3DECL(int) DBGFR3BpClear(PUVM pUVM, uint32_t iBp);
1162	VMMR3DECL(int) DBGFR3BpEnable(PUVM pUVM, uint32_t iBp);
1163	VMMR3DECL(int) DBGFR3BpDisable(PUVM pUVM, uint32_t iBp);
1164
1165	/**
1166	* Breakpoint enumeration callback function.
1167	*
1168	* @returns VBox status code.
1169	* The enumeration stops on failure status and VINF_CALLBACK_RETURN.
1170	* @param pUVM The user mode VM handle.
1171	* @param pvUser The user argument.
1172	* @param pBp Pointer to the breakpoint information. (readonly)
1173	*/
1174	typedef DECLCALLBACKTYPE(int, FNDBGFBPENUM,(PUVM pUVM, void *pvUser, PCDBGFBP pBp));
1175	/** Pointer to a breakpoint enumeration callback function. */
1176	typedef FNDBGFBPENUM *PFNDBGFBPENUM;
1177
1178	VMMR3DECL(int) DBGFR3BpEnum(PUVM pUVM, PFNDBGFBPENUM pfnCallback, void *pvUser);
1179	# endif /* IN_RING3 */
1180	#endif /* !VBOX_WITH_LOTS_OF_DBGF_BPS */
1181
1182	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR7(PVM pVM);
1183	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR0(PVM pVM);
1184	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR1(PVM pVM);
1185	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR2(PVM pVM);
1186	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR3(PVM pVM);
1187	VMM_INT_DECL(bool) DBGFBpIsHwArmed(PVM pVM);
1188	VMM_INT_DECL(bool) DBGFBpIsHwIoArmed(PVM pVM);
1189	VMM_INT_DECL(bool) DBGFBpIsInt3Armed(PVM pVM);
1190	VMM_INT_DECL(bool) DBGFIsStepping(PVMCPU pVCpu);
1191	VMM_INT_DECL(VBOXSTRICTRC) DBGFBpCheckIo(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, RTIOPORT uIoPort, uint8_t cbValue);
1192	VMM_INT_DECL(VBOXSTRICTRC) DBGFEventGenericWithArgs(PVM pVM, PVMCPU pVCpu, DBGFEVENTTYPE enmEvent, DBGFEVENTCTX enmCtx,
1193	unsigned cArgs, ...);
1194
1195
1196	#ifdef IN_RING3 /* The CPU mode API only works in ring-3. */
1197	VMMR3DECL(CPUMMODE) DBGFR3CpuGetMode(PUVM pUVM, VMCPUID idCpu);
1198	VMMR3DECL(VMCPUID) DBGFR3CpuGetCount(PUVM pUVM);
1199	VMMR3DECL(bool) DBGFR3CpuIsIn64BitCode(PUVM pUVM, VMCPUID idCpu);
1200	VMMR3DECL(bool) DBGFR3CpuIsInV86Code(PUVM pUVM, VMCPUID idCpu);
1201	VMMR3DECL(const char *) DBGFR3CpuGetState(PUVM pUVM, VMCPUID idCpu);
1202	#endif
1203
1204
1205
1206	#ifdef IN_RING3 /* The info callbacks API only works in ring-3. */
1207
1208	struct RTGETOPTSTATE;
1209	union RTGETOPTUNION;
1210
1211	/**
1212	* Info helper callback structure.
1213	*/
1214	typedef struct DBGFINFOHLP
1215	{
1216	/**
1217	* Print formatted string.
1218	*
1219	* @param pHlp Pointer to this structure.
1220	* @param pszFormat The format string.
1221	* @param ... Arguments.
1222	*/
1223	DECLCALLBACKMEMBER(void, pfnPrintf,(PCDBGFINFOHLP pHlp, const char *pszFormat, ...)) RT_IPRT_FORMAT_ATTR(2, 3);
1224
1225	/**
1226	* Print formatted string.
1227	*
1228	* @param pHlp Pointer to this structure.
1229	* @param pszFormat The format string.
1230	* @param args Argument list.
1231	*/
1232	DECLCALLBACKMEMBER(void, pfnPrintfV,(PCDBGFINFOHLP pHlp, const char *pszFormat, va_list args)) RT_IPRT_FORMAT_ATTR(2, 0);
1233
1234	/**
1235	* Report getopt parsing trouble
1236	*
1237	* @param pHlp Pointer to this structure.
1238	* @param rc The RTGetOpt return value.
1239	* @param pValueUnion The value union.
1240	* @param pState The getopt state.
1241	*/
1242	DECLCALLBACKMEMBER(void, pfnGetOptError,(PCDBGFINFOHLP pHlp, int rc, union RTGETOPTUNION *pValueUnion,
1243	struct RTGETOPTSTATE *pState));
1244	} DBGFINFOHLP;
1245
1246
1247	/**
1248	* Info handler, device version.
1249	*
1250	* @param pDevIns The device instance which registered the info.
1251	* @param pHlp Callback functions for doing output.
1252	* @param pszArgs Argument string. Optional and specific to the handler.
1253	*/
1254	typedef DECLCALLBACKTYPE(void, FNDBGFHANDLERDEV,(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs));
1255	/** Pointer to a FNDBGFHANDLERDEV function. */
1256	typedef FNDBGFHANDLERDEV *PFNDBGFHANDLERDEV;
1257
1258	/**
1259	* Info handler, driver version.
1260	*
1261	* @param pDrvIns The driver instance which registered the info.
1262	* @param pHlp Callback functions for doing output.
1263	* @param pszArgs Argument string. Optional and specific to the handler.
1264	*/
1265	typedef DECLCALLBACKTYPE(void, FNDBGFHANDLERDRV,(PPDMDRVINS pDrvIns, PCDBGFINFOHLP pHlp, const char *pszArgs));
1266	/** Pointer to a FNDBGFHANDLERDRV function. */
1267	typedef FNDBGFHANDLERDRV *PFNDBGFHANDLERDRV;
1268
1269	/**
1270	* Info handler, internal version.
1271	*
1272	* @param pVM The cross context VM structure.
1273	* @param pHlp Callback functions for doing output.
1274	* @param pszArgs Argument string. Optional and specific to the handler.
1275	*/
1276	typedef DECLCALLBACKTYPE(void, FNDBGFHANDLERINT,(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs));
1277	/** Pointer to a FNDBGFHANDLERINT function. */
1278	typedef FNDBGFHANDLERINT *PFNDBGFHANDLERINT;
1279
1280	/**
1281	* Info handler, external version.
1282	*
1283	* @param pvUser User argument.
1284	* @param pHlp Callback functions for doing output.
1285	* @param pszArgs Argument string. Optional and specific to the handler.
1286	*/
1287	typedef DECLCALLBACKTYPE(void, FNDBGFHANDLEREXT,(void pvUser, PCDBGFINFOHLP pHlp, const char pszArgs));
1288	/** Pointer to a FNDBGFHANDLEREXT function. */
1289	typedef FNDBGFHANDLEREXT *PFNDBGFHANDLEREXT;
1290
1291	/**
1292	* Info handler, device version with argv.
1293	*
1294	* @param pDevIns The device instance which registered the info.
1295	* @param pHlp Callback functions for doing output.
1296	* @param cArgs Number of arguments.
1297	* @param papszArgs Argument vector.
1298	*/
1299	typedef DECLCALLBACKTYPE(void, FNDBGFINFOARGVDEV,(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, int cArgs, char **papszArgs));
1300	/** Pointer to a FNDBGFINFOARGVDEV function. */
1301	typedef FNDBGFINFOARGVDEV *PFNDBGFINFOARGVDEV;
1302
1303	/**
1304	* Info handler, USB device version with argv.
1305	*
1306	* @param pUsbIns The USB device instance which registered the info.
1307	* @param pHlp Callback functions for doing output.
1308	* @param cArgs Number of arguments.
1309	* @param papszArgs Argument vector.
1310	*/
1311	typedef DECLCALLBACKTYPE(void, FNDBGFINFOARGVUSB,(PPDMUSBINS pUsbIns, PCDBGFINFOHLP pHlp, int cArgs, char **papszArgs));
1312	/** Pointer to a FNDBGFINFOARGVUSB function. */
1313	typedef FNDBGFINFOARGVUSB *PFNDBGFINFOARGVUSB;
1314
1315	/**
1316	* Info handler, driver version with argv.
1317	*
1318	* @param pDrvIns The driver instance which registered the info.
1319	* @param pHlp Callback functions for doing output.
1320	* @param cArgs Number of arguments.
1321	* @param papszArgs Argument vector.
1322	*/
1323	typedef DECLCALLBACKTYPE(void, FNDBGFINFOARGVDRV,(PPDMDRVINS pDrvIns, PCDBGFINFOHLP pHlp, int cArgs, char **papszArgs));
1324	/** Pointer to a FNDBGFINFOARGVDRV function. */
1325	typedef FNDBGFINFOARGVDRV *PFNDBGFINFOARGVDRV;
1326
1327	/**
1328	* Info handler, internal version with argv.
1329	*
1330	* @param pVM The cross context VM structure.
1331	* @param pHlp Callback functions for doing output.
1332	* @param cArgs Number of arguments.
1333	* @param papszArgs Argument vector.
1334	*/
1335	typedef DECLCALLBACKTYPE(void, FNDBGFINFOARGVINT,(PVM pVM, PCDBGFINFOHLP pHlp, int cArgs, char **papszArgs));
1336	/** Pointer to a FNDBGFINFOARGVINT function. */
1337	typedef FNDBGFINFOARGVINT *PFNDBGFINFOARGVINT;
1338
1339	/**
1340	* Info handler, external version with argv.
1341	*
1342	* @param pvUser User argument.
1343	* @param pHlp Callback functions for doing output.
1344	* @param cArgs Number of arguments.
1345	* @param papszArgs Argument vector.
1346	*/
1347	typedef DECLCALLBACKTYPE(void, FNDBGFINFOARGVEXT,(void pvUser, PCDBGFINFOHLP pHlp, int cArgs, char *papszArgs));
1348	/** Pointer to a FNDBGFINFOARGVEXT function. */
1349	typedef FNDBGFINFOARGVEXT *PFNDBGFINFOARGVEXT;
1350
1351
1352	/** @name Flags for the info registration functions.
1353	* @{ */
1354	/** The handler must run on the EMT. */
1355	#define DBGFINFO_FLAGS_RUN_ON_EMT RT_BIT(0)
1356	/** Call on all EMTs when a specific isn't specified. */
1357	#define DBGFINFO_FLAGS_ALL_EMTS RT_BIT(1)
1358	/** @} */
1359
1360	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDevice(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERDEV pfnHandler, PPDMDEVINS pDevIns);
1361	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDriver(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler, PPDMDRVINS pDrvIns);
1362	VMMR3_INT_DECL(int) DBGFR3InfoRegisterInternal(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERINT pfnHandler);
1363	VMMR3_INT_DECL(int) DBGFR3InfoRegisterInternalEx(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERINT pfnHandler, uint32_t fFlags);
1364	VMMR3DECL(int) DBGFR3InfoRegisterExternal(PUVM pUVM, const char pszName, const char pszDesc, PFNDBGFHANDLEREXT pfnHandler, void *pvUser);
1365
1366	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDeviceArgv(PVM pVM, const char pszName, const char pszDesc, PFNDBGFINFOARGVDEV pfnHandler, PPDMDEVINS pDevIns);
1367	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDriverArgv(PVM pVM, const char pszName, const char pszDesc, PFNDBGFINFOARGVDRV pfnHandler, PPDMDRVINS pDrvIns);
1368	VMMR3_INT_DECL(int) DBGFR3InfoRegisterUsbArgv(PVM pVM, const char pszName, const char pszDesc, PFNDBGFINFOARGVUSB pfnHandler, PPDMUSBINS pUsbIns);
1369	VMMR3_INT_DECL(int) DBGFR3InfoRegisterInternalArgv(PVM pVM, const char pszName, const char pszDesc, PFNDBGFINFOARGVINT pfnHandler, uint32_t fFlags);
1370	VMMR3DECL(int) DBGFR3InfoRegisterExternalArgv(PUVM pUVM, const char pszName, const char pszDesc, PFNDBGFINFOARGVEXT pfnHandler, void *pvUser);
1371
1372	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char *pszName);
1373	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName);
1374	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterUsb(PVM pVM, PPDMUSBINS pDrvIns, const char *pszName);
1375	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterInternal(PVM pVM, const char *pszName);
1376	VMMR3DECL(int) DBGFR3InfoDeregisterExternal(PUVM pUVM, const char *pszName);
1377
1378	VMMR3DECL(int) DBGFR3Info(PUVM pUVM, const char pszName, const char pszArgs, PCDBGFINFOHLP pHlp);
1379	VMMR3DECL(int) DBGFR3InfoEx(PUVM pUVM, VMCPUID idCpu, const char pszName, const char pszArgs, PCDBGFINFOHLP pHlp);
1380	VMMR3DECL(int) DBGFR3InfoLogRel(PUVM pUVM, const char pszName, const char pszArgs);
1381	VMMR3DECL(int) DBGFR3InfoStdErr(PUVM pUVM, const char pszName, const char pszArgs);
1382	VMMR3_INT_DECL(int) DBGFR3InfoMulti(PVM pVM, const char pszIncludePat, const char pszExcludePat,
1383	const char *pszSepFmt, PCDBGFINFOHLP pHlp);
1384
1385	/** @def DBGFR3_INFO_LOG
1386	* Display a piece of info writing to the log if enabled.
1387	*
1388	* This is for execution on EMTs and will only show the items on the calling
1389	* EMT. This is to avoid deadlocking against other CPUs if a rendezvous is
1390	* initiated in parallel to this call. (Besides, nobody really wants or need
1391	* info for the other EMTs when using this macro.)
1392	*
1393	* @param a_pVM The shared VM handle.
1394	* @param a_pVCpu The cross context per CPU structure of the calling EMT.
1395	* @param a_pszName The identifier of the info to display.
1396	* @param a_pszArgs Arguments to the info handler.
1397	*/
1398	#ifdef LOG_ENABLED
1399	# define DBGFR3_INFO_LOG(a_pVM, a_pVCpu, a_pszName, a_pszArgs) \
1400	do { \
1401	if (LogIsEnabled()) \
1402	DBGFR3InfoEx((a_pVM)->pUVM, (a_pVCpu)->idCpu, a_pszName, a_pszArgs, NULL); \
1403	} while (0)
1404	#else
1405	# define DBGFR3_INFO_LOG(a_pVM, a_pVCpu, a_pszName, a_pszArgs) do { } while (0)
1406	#endif
1407
1408	/** @def DBGFR3_INFO_LOG_SAFE
1409	* Display a piece of info (rendezvous safe) writing to the log if enabled.
1410	*
1411	* @param a_pVM The shared VM handle.
1412	* @param a_pszName The identifier of the info to display.
1413	* @param a_pszArgs Arguments to the info handler.
1414	*
1415	* @remarks Use DBGFR3_INFO_LOG where ever possible!
1416	*/
1417	#ifdef LOG_ENABLED
1418	# define DBGFR3_INFO_LOG_SAFE(a_pVM, a_pszName, a_pszArgs) \
1419	do { \
1420	if (LogIsEnabled()) \
1421	DBGFR3Info((a_pVM)->pUVM, a_pszName, a_pszArgs, NULL); \
1422	} while (0)
1423	#else
1424	# define DBGFR3_INFO_LOG_SAFE(a_pVM, a_pszName, a_pszArgs) do { } while (0)
1425	#endif
1426
1427	/**
1428	* Enumeration callback for use with DBGFR3InfoEnum.
1429	*
1430	* @returns VBox status code.
1431	* A status code indicating failure will end the enumeration
1432	* and DBGFR3InfoEnum will return with that status code.
1433	* @param pUVM The user mode VM handle.
1434	* @param pszName Info identifier name.
1435	* @param pszDesc The description.
1436	*/
1437	typedef DECLCALLBACKTYPE(int, FNDBGFINFOENUM,(PUVM pUVM, const char pszName, const char pszDesc, void *pvUser));
1438	/** Pointer to a FNDBGFINFOENUM function. */
1439	typedef FNDBGFINFOENUM *PFNDBGFINFOENUM;
1440
1441	VMMR3DECL(int) DBGFR3InfoEnum(PUVM pUVM, PFNDBGFINFOENUM pfnCallback, void *pvUser);
1442	VMMR3DECL(PCDBGFINFOHLP) DBGFR3InfoLogHlp(void);
1443	VMMR3DECL(PCDBGFINFOHLP) DBGFR3InfoLogRelHlp(void);
1444	VMMR3DECL(void) DBGFR3InfoGenricGetOptError(PCDBGFINFOHLP pHlp, int rc, union RTGETOPTUNION *pValueUnion,
1445	struct RTGETOPTSTATE *pState);
1446
1447	#endif /* IN_RING3 */
1448
1449
1450	#ifdef IN_RING3 /* The log contrl API only works in ring-3. */
1451	VMMR3DECL(int) DBGFR3LogModifyGroups(PUVM pUVM, const char *pszGroupSettings);
1452	VMMR3DECL(int) DBGFR3LogModifyFlags(PUVM pUVM, const char *pszFlagSettings);
1453	VMMR3DECL(int) DBGFR3LogModifyDestinations(PUVM pUVM, const char *pszDestSettings);
1454	#endif /* IN_RING3 */
1455
1456	#ifdef IN_RING3 /* The debug information management APIs only works in ring-3. */
1457
1458	/** Max length (including '\\0') of a symbol name. */
1459	#define DBGF_SYMBOL_NAME_LENGTH 512
1460
1461	/**
1462	* Debug symbol.
1463	*/
1464	typedef struct DBGFSYMBOL
1465	{
1466	/** Symbol value (address). */
1467	RTGCUINTPTR Value;
1468	/** Symbol size. */
1469	uint32_t cb;
1470	/** Symbol Flags. (reserved). */
1471	uint32_t fFlags;
1472	/** Symbol name. */
1473	char szName[DBGF_SYMBOL_NAME_LENGTH];
1474	} DBGFSYMBOL;
1475	/** Pointer to debug symbol. */
1476	typedef DBGFSYMBOL *PDBGFSYMBOL;
1477	/** Pointer to const debug symbol. */
1478	typedef const DBGFSYMBOL *PCDBGFSYMBOL;
1479
1480	/**
1481	* Debug line number information.
1482	*/
1483	typedef struct DBGFLINE
1484	{
1485	/** Address. */
1486	RTGCUINTPTR Address;
1487	/** Line number. */
1488	uint32_t uLineNo;
1489	/** Filename. */
1490	char szFilename[260];
1491	} DBGFLINE;
1492	/** Pointer to debug line number. */
1493	typedef DBGFLINE *PDBGFLINE;
1494	/** Pointer to const debug line number. */
1495	typedef const DBGFLINE *PCDBGFLINE;
1496
1497	/** @name Address spaces aliases.
1498	* @{ */
1499	/** The guest global address space. */
1500	#define DBGF_AS_GLOBAL ((RTDBGAS)-1)
1501	/** The guest kernel address space.
1502	* This is usually resolves to the same as DBGF_AS_GLOBAL. */
1503	#define DBGF_AS_KERNEL ((RTDBGAS)-2)
1504	/** The physical address space. */
1505	#define DBGF_AS_PHYS ((RTDBGAS)-3)
1506	/** Raw-mode context. */
1507	#define DBGF_AS_RC ((RTDBGAS)-4)
1508	/** Ring-0 context. */
1509	#define DBGF_AS_R0 ((RTDBGAS)-5)
1510	/** Raw-mode context and then global guest context.
1511	* When used for looking up information, it works as if the call was first made
1512	* with DBGF_AS_RC and then on failure with DBGF_AS_GLOBAL. When called for
1513	* making address space changes, it works as if DBGF_AS_RC was used. */
1514	#define DBGF_AS_RC_AND_GC_GLOBAL ((RTDBGAS)-6)
1515
1516	/** The first special one. */
1517	#define DBGF_AS_FIRST DBGF_AS_RC_AND_GC_GLOBAL
1518	/** The last special one. */
1519	#define DBGF_AS_LAST DBGF_AS_GLOBAL
1520	#endif
1521	/** The number of special address space handles. */
1522	#define DBGF_AS_COUNT (6U)
1523	#ifdef IN_RING3
1524	/** Converts an alias handle to an array index. */
1525	#define DBGF_AS_ALIAS_2_INDEX(hAlias) \
1526	( (uintptr_t)(hAlias) - (uintptr_t)DBGF_AS_FIRST )
1527	/** Predicat macro that check if the specified handle is an alias. */
1528	#define DBGF_AS_IS_ALIAS(hAlias) \
1529	( DBGF_AS_ALIAS_2_INDEX(hAlias) < DBGF_AS_COUNT )
1530	/** Predicat macro that check if the specified alias is a fixed one or not. */
1531	#define DBGF_AS_IS_FIXED_ALIAS(hAlias) \
1532	( DBGF_AS_ALIAS_2_INDEX(hAlias) < (uintptr_t)DBGF_AS_PHYS - (uintptr_t)DBGF_AS_FIRST + 1U )
1533
1534	/** @} */
1535
1536	VMMR3DECL(RTDBGCFG) DBGFR3AsGetConfig(PUVM pUVM);
1537
1538	VMMR3DECL(int) DBGFR3AsAdd(PUVM pUVM, RTDBGAS hDbgAs, RTPROCESS ProcId);
1539	VMMR3DECL(int) DBGFR3AsDelete(PUVM pUVM, RTDBGAS hDbgAs);
1540	VMMR3DECL(int) DBGFR3AsSetAlias(PUVM pUVM, RTDBGAS hAlias, RTDBGAS hAliasFor);
1541	VMMR3DECL(RTDBGAS) DBGFR3AsResolve(PUVM pUVM, RTDBGAS hAlias);
1542	VMMR3DECL(RTDBGAS) DBGFR3AsResolveAndRetain(PUVM pUVM, RTDBGAS hAlias);
1543	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByName(PUVM pUVM, const char *pszName);
1544	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByPid(PUVM pUVM, RTPROCESS ProcId);
1545
1546	VMMR3DECL(int) DBGFR3AsLoadImage(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName,
1547	RTLDRARCH enmArch, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags);
1548	VMMR3DECL(int) DBGFR3AsLoadMap(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, RTGCUINTPTR uSubtrahend, uint32_t fFlags);
1549	VMMR3DECL(int) DBGFR3AsLinkModule(PUVM pUVM, RTDBGAS hDbgAs, RTDBGMOD hMod, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags);
1550	VMMR3DECL(int) DBGFR3AsUnlinkModuleByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszModName);
1551
1552	VMMR3DECL(int) DBGFR3AsSymbolByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1553	PRTGCINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
1554	VMMR3DECL(PRTDBGSYMBOL) DBGFR3AsSymbolByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t Flags,
1555	PRTGCINTPTR poffDisp, PRTDBGMOD phMod);
1556	VMMR3DECL(int) DBGFR3AsSymbolByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
1557
1558	VMMR3DECL(int) DBGFR3AsLineByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1559	PRTGCINTPTR poffDisp, PRTDBGLINE pLine, PRTDBGMOD phMod);
1560	VMMR3DECL(PRTDBGLINE) DBGFR3AsLineByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1561	PRTGCINTPTR poffDisp, PRTDBGMOD phMod);
1562
1563	/** @name DBGFMOD_PE_F_XXX - flags for
1564	* @{ */
1565	/** NT 3.1 images were a little different, so make allowances for that. */
1566	#define DBGFMODINMEM_F_PE_NT31 RT_BIT_32(0)
1567	/** No container fallback. */
1568	#define DBGFMODINMEM_F_NO_CONTAINER_FALLBACK RT_BIT_32(1)
1569	/** No in-memory reader fallback. */
1570	#define DBGFMODINMEM_F_NO_READER_FALLBACK RT_BIT_32(2)
1571	/** Valid flags. */
1572	#define DBGFMODINMEM_F_VALID_MASK UINT32_C(0x00000007)
1573	/** @} */
1574	VMMR3DECL(int) DBGFR3ModInMem(PUVM pUVM, PCDBGFADDRESS pImageAddr, uint32_t fFlags, const char *pszName,
1575	const char *pszFilename, RTLDRARCH enmArch, uint32_t cbImage,
1576	PRTDBGMOD phDbgMod, PRTERRINFO pErrInfo);
1577
1578	#endif /* IN_RING3 */
1579
1580	#ifdef IN_RING3 /* The stack API only works in ring-3. */
1581
1582	/** Pointer to stack frame info. */
1583	typedef struct DBGFSTACKFRAME *PDBGFSTACKFRAME;
1584	/** Pointer to const stack frame info. */
1585	typedef struct DBGFSTACKFRAME const *PCDBGFSTACKFRAME;
1586	/**
1587	* Info about a stack frame.
1588	*/
1589	typedef struct DBGFSTACKFRAME
1590	{
1591	/** Frame number. */
1592	uint32_t iFrame;
1593	/** Frame flags (DBGFSTACKFRAME_FLAGS_XXX). */
1594	uint32_t fFlags;
1595	/** The stack address of the frame.
1596	* The off member is [e\|r]sp and the Sel member is ss. */
1597	DBGFADDRESS AddrStack;
1598	/** The program counter (PC) address of the frame.
1599	* The off member is [e\|r]ip and the Sel member is cs. */
1600	DBGFADDRESS AddrPC;
1601	/** Pointer to the symbol nearest the program counter (PC). NULL if not found. */
1602	PRTDBGSYMBOL pSymPC;
1603	/** Pointer to the linenumber nearest the program counter (PC). NULL if not found. */
1604	PRTDBGLINE pLinePC;
1605	/** The frame address.
1606	* The off member is [e\|r]bp and the Sel member is ss. */
1607	DBGFADDRESS AddrFrame;
1608	/** The way this frame returns to the next one. */
1609	RTDBGRETURNTYPE enmReturnType;
1610
1611	/** The way the next frame returns.
1612	* Only valid when DBGFSTACKFRAME_FLAGS_UNWIND_INFO_RET is set. */
1613	RTDBGRETURNTYPE enmReturnFrameReturnType;
1614	/** The return frame address.
1615	* The off member is [e\|r]bp and the Sel member is ss. */
1616	DBGFADDRESS AddrReturnFrame;
1617	/** The return stack address.
1618	* The off member is [e\|r]sp and the Sel member is ss. */
1619	DBGFADDRESS AddrReturnStack;
1620
1621	/** The program counter (PC) address which the frame returns to.
1622	* The off member is [e\|r]ip and the Sel member is cs. */
1623	DBGFADDRESS AddrReturnPC;
1624	/** Pointer to the symbol nearest the return PC. NULL if not found. */
1625	PRTDBGSYMBOL pSymReturnPC;
1626	/** Pointer to the linenumber nearest the return PC. NULL if not found. */
1627	PRTDBGLINE pLineReturnPC;
1628
1629	/** 32-bytes of stack arguments. */
1630	union
1631	{
1632	/** 64-bit view */
1633	uint64_t au64[4];
1634	/** 32-bit view */
1635	uint32_t au32[8];
1636	/** 16-bit view */
1637	uint16_t au16[16];
1638	/** 8-bit view */
1639	uint8_t au8[32];
1640	} Args;
1641
1642	/** Number of registers values we can be sure about.
1643	* @note This is generally zero in the first frame. */
1644	uint32_t cSureRegs;
1645	/** Registers we can be sure about (length given by cSureRegs). */
1646	struct DBGFREGVALEX *paSureRegs;
1647
1648	/** Pointer to the next frame.
1649	* Might not be used in some cases, so consider it internal. */
1650	PCDBGFSTACKFRAME pNextInternal;
1651	/** Pointer to the first frame.
1652	* Might not be used in some cases, so consider it internal. */
1653	PCDBGFSTACKFRAME pFirstInternal;
1654	} DBGFSTACKFRAME;
1655
1656	/** @name DBGFSTACKFRAME_FLAGS_XXX - DBGFSTACKFRAME Flags.
1657	* @{ */
1658	/** This is the last stack frame we can read.
1659	* This flag is not set if the walk stop because of max dept or recursion. */
1660	# define DBGFSTACKFRAME_FLAGS_LAST RT_BIT(1)
1661	/** This is the last record because we detected a loop. */
1662	# define DBGFSTACKFRAME_FLAGS_LOOP RT_BIT(2)
1663	/** This is the last record because we reached the maximum depth. */
1664	# define DBGFSTACKFRAME_FLAGS_MAX_DEPTH RT_BIT(3)
1665	/** 16-bit frame. */
1666	# define DBGFSTACKFRAME_FLAGS_16BIT RT_BIT(4)
1667	/** 32-bit frame. */
1668	# define DBGFSTACKFRAME_FLAGS_32BIT RT_BIT(5)
1669	/** 64-bit frame. */
1670	# define DBGFSTACKFRAME_FLAGS_64BIT RT_BIT(6)
1671	/** Real mode or V86 frame. */
1672	# define DBGFSTACKFRAME_FLAGS_REAL_V86 RT_BIT(7)
1673	/** Is a trap frame (NT term). */
1674	# define DBGFSTACKFRAME_FLAGS_TRAP_FRAME RT_BIT(8)
1675
1676	/** Used Odd/even heuristics for far/near return. */
1677	# define DBGFSTACKFRAME_FLAGS_USED_ODD_EVEN RT_BIT(29)
1678	/** Set if we used unwind info to construct the frame. (Kind of internal.) */
1679	# define DBGFSTACKFRAME_FLAGS_USED_UNWIND_INFO RT_BIT(30)
1680	/** Internal: Unwind info used for the return frame. */
1681	# define DBGFSTACKFRAME_FLAGS_UNWIND_INFO_RET RT_BIT(31)
1682	/** @} */
1683
1684	/** @name DBGFCODETYPE
1685	* @{ */
1686	typedef enum DBGFCODETYPE
1687	{
1688	/** The usual invalid 0 value. */
1689	DBGFCODETYPE_INVALID = 0,
1690	/** Stack walk for guest code. */
1691	DBGFCODETYPE_GUEST,
1692	/** Stack walk for hypervisor code. */
1693	DBGFCODETYPE_HYPER,
1694	/** Stack walk for ring 0 code. */
1695	DBGFCODETYPE_RING0,
1696	/** The usual 32-bit blowup. */
1697	DBGFCODETYPE_32BIT_HACK = 0x7fffffff
1698	} DBGFCODETYPE;
1699	/** @} */
1700
1701	VMMR3DECL(int) DBGFR3StackWalkBegin(PUVM pUVM, VMCPUID idCpu, DBGFCODETYPE enmCodeType,
1702	PCDBGFSTACKFRAME *ppFirstFrame);
1703	VMMR3DECL(int) DBGFR3StackWalkBeginEx(PUVM pUVM, VMCPUID idCpu, DBGFCODETYPE enmCodeType, PCDBGFADDRESS pAddrFrame,
1704	PCDBGFADDRESS pAddrStack,PCDBGFADDRESS pAddrPC,
1705	RTDBGRETURNTYPE enmReturnType, PCDBGFSTACKFRAME *ppFirstFrame);
1706	VMMR3DECL(PCDBGFSTACKFRAME) DBGFR3StackWalkNext(PCDBGFSTACKFRAME pCurrent);
1707	VMMR3DECL(void) DBGFR3StackWalkEnd(PCDBGFSTACKFRAME pFirstFrame);
1708
1709	#endif /* IN_RING3 */
1710
1711
1712	#ifdef IN_RING3 /* The disassembly API only works in ring-3. */
1713
1714	/** @name Flags to pass to DBGFR3DisasInstrEx().
1715	* @{ */
1716	/** Disassemble the current guest instruction, with annotations. */
1717	#define DBGF_DISAS_FLAGS_CURRENT_GUEST RT_BIT(0)
1718	/** No annotations for current context. */
1719	#define DBGF_DISAS_FLAGS_NO_ANNOTATION RT_BIT(2)
1720	/** No symbol lookup. */
1721	#define DBGF_DISAS_FLAGS_NO_SYMBOLS RT_BIT(3)
1722	/** No instruction bytes. */
1723	#define DBGF_DISAS_FLAGS_NO_BYTES RT_BIT(4)
1724	/** No address in the output. */
1725	#define DBGF_DISAS_FLAGS_NO_ADDRESS RT_BIT(5)
1726	/** Disassemble original unpatched bytes (PATM). */
1727	#define DBGF_DISAS_FLAGS_UNPATCHED_BYTES RT_BIT(7)
1728	/** Annotate patched instructions. */
1729	#define DBGF_DISAS_FLAGS_ANNOTATE_PATCHED RT_BIT(8)
1730	/** Disassemble in the default mode of the specific context. */
1731	#define DBGF_DISAS_FLAGS_DEFAULT_MODE UINT32_C(0x00000000)
1732	/** Disassemble in 16-bit mode. */
1733	#define DBGF_DISAS_FLAGS_16BIT_MODE UINT32_C(0x10000000)
1734	/** Disassemble in 16-bit mode with real mode address translation. */
1735	#define DBGF_DISAS_FLAGS_16BIT_REAL_MODE UINT32_C(0x20000000)
1736	/** Disassemble in 32-bit mode. */
1737	#define DBGF_DISAS_FLAGS_32BIT_MODE UINT32_C(0x30000000)
1738	/** Disassemble in 64-bit mode. */
1739	#define DBGF_DISAS_FLAGS_64BIT_MODE UINT32_C(0x40000000)
1740	/** The disassembly mode mask. */
1741	#define DBGF_DISAS_FLAGS_MODE_MASK UINT32_C(0x70000000)
1742	/** Mask containing the valid flags. */
1743	#define DBGF_DISAS_FLAGS_VALID_MASK UINT32_C(0x700001ff)
1744	/** @} */
1745
1746	/** Special flat selector. */
1747	#define DBGF_SEL_FLAT 1
1748
1749	VMMR3DECL(int) DBGFR3DisasInstrEx(PUVM pUVM, VMCPUID idCpu, RTSEL Sel, RTGCPTR GCPtr, uint32_t fFlags,
1750	char pszOutput, uint32_t cbOutput, uint32_t pcbInstr);
1751	VMMR3_INT_DECL(int) DBGFR3DisasInstrCurrent(PVMCPU pVCpu, char *pszOutput, uint32_t cbOutput);
1752	VMMR3DECL(int) DBGFR3DisasInstrCurrentLogInternal(PVMCPU pVCpu, const char *pszPrefix);
1753
1754	/** @def DBGFR3_DISAS_INSTR_CUR_LOG
1755	* Disassembles the current guest context instruction and writes it to the log.
1756	* All registers and data will be displayed. Addresses will be attempted resolved to symbols.
1757	*/
1758	#ifdef LOG_ENABLED
1759	# define DBGFR3_DISAS_INSTR_CUR_LOG(pVCpu, pszPrefix) \
1760	do { \
1761	if (LogIsEnabled()) \
1762	DBGFR3DisasInstrCurrentLogInternal(pVCpu, pszPrefix); \
1763	} while (0)
1764	#else
1765	# define DBGFR3_DISAS_INSTR_CUR_LOG(pVCpu, pszPrefix) do { } while (0)
1766	#endif
1767
1768	VMMR3DECL(int) DBGFR3DisasInstrLogInternal(PVMCPU pVCpu, RTSEL Sel, RTGCPTR GCPtr, const char *pszPrefix);
1769
1770	/** @def DBGFR3_DISAS_INSTR_LOG
1771	* Disassembles the specified guest context instruction and writes it to the log.
1772	* Addresses will be attempted resolved to symbols.
1773	* @thread Any EMT.
1774	*/
1775	# ifdef LOG_ENABLED
1776	# define DBGFR3_DISAS_INSTR_LOG(pVCpu, Sel, GCPtr, pszPrefix) \
1777	do { \
1778	if (LogIsEnabled()) \
1779	DBGFR3DisasInstrLogInternal(pVCpu, Sel, GCPtr, pszPrefix); \
1780	} while (0)
1781	# else
1782	# define DBGFR3_DISAS_INSTR_LOG(pVCpu, Sel, GCPtr, pszPrefix) do { } while (0)
1783	# endif
1784	#endif
1785
1786
1787	#ifdef IN_RING3
1788	VMMR3DECL(int) DBGFR3MemScan(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, RTGCUINTPTR cbRange, RTGCUINTPTR uAlign,
1789	const void *pvNeedle, size_t cbNeedle, PDBGFADDRESS pHitAddress);
1790	VMMR3DECL(int) DBGFR3MemRead(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, void *pvBuf, size_t cbRead);
1791	VMMR3DECL(int) DBGFR3MemReadString(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, char *pszBuf, size_t cbBuf);
1792	VMMR3DECL(int) DBGFR3MemWrite(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, void const *pvBuf, size_t cbRead);
1793	#endif
1794
1795
1796	/** @name Flags for DBGFR3PagingDumpEx, PGMR3DumpHierarchyHCEx and
1797	* PGMR3DumpHierarchyGCEx
1798	* @{ */
1799	/** The CR3 from the current CPU state. */
1800	#define DBGFPGDMP_FLAGS_CURRENT_CR3 RT_BIT_32(0)
1801	/** The current CPU paging mode (PSE, PAE, LM, EPT, NX). */
1802	#define DBGFPGDMP_FLAGS_CURRENT_MODE RT_BIT_32(1)
1803	/** Whether PSE is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1804	* Same value as X86_CR4_PSE. */
1805	#define DBGFPGDMP_FLAGS_PSE RT_BIT_32(4) /* */
1806	/** Whether PAE is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1807	* Same value as X86_CR4_PAE. */
1808	#define DBGFPGDMP_FLAGS_PAE RT_BIT_32(5) /* */
1809	/** Whether LME is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1810	* Same value as MSR_K6_EFER_LME. */
1811	#define DBGFPGDMP_FLAGS_LME RT_BIT_32(8)
1812	/** Whether nested paging is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE). */
1813	#define DBGFPGDMP_FLAGS_NP RT_BIT_32(9)
1814	/** Whether extended nested page tables are enabled
1815	* (!DBGFPGDMP_FLAGS_CURRENT_STATE). */
1816	#define DBGFPGDMP_FLAGS_EPT RT_BIT_32(10)
1817	/** Whether no-execution is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
1818	* Same value as MSR_K6_EFER_NXE. */
1819	#define DBGFPGDMP_FLAGS_NXE RT_BIT_32(11)
1820	/** Whether to print the CR3. */
1821	#define DBGFPGDMP_FLAGS_PRINT_CR3 RT_BIT_32(27)
1822	/** Whether to print the header. */
1823	#define DBGFPGDMP_FLAGS_HEADER RT_BIT_32(28)
1824	/** Whether to dump additional page information. */
1825	#define DBGFPGDMP_FLAGS_PAGE_INFO RT_BIT_32(29)
1826	/** Dump the shadow tables if set.
1827	* Cannot be used together with DBGFPGDMP_FLAGS_GUEST. */
1828	#define DBGFPGDMP_FLAGS_SHADOW RT_BIT_32(30)
1829	/** Dump the guest tables if set.
1830	* Cannot be used together with DBGFPGDMP_FLAGS_SHADOW. */
1831	#define DBGFPGDMP_FLAGS_GUEST RT_BIT_32(31)
1832	/** Mask of valid bits. */
1833	#define DBGFPGDMP_FLAGS_VALID_MASK UINT32_C(0xf8000f33)
1834	/** The mask of bits controlling the paging mode. */
1835	#define DBGFPGDMP_FLAGS_MODE_MASK UINT32_C(0x00000f32)
1836	/** @} */
1837	VMMDECL(int) DBGFR3PagingDumpEx(PUVM pUVM, VMCPUID idCpu, uint32_t fFlags, uint64_t cr3, uint64_t u64FirstAddr,
1838	uint64_t u64LastAddr, uint32_t cMaxDepth, PCDBGFINFOHLP pHlp);
1839
1840
1841	/** @name DBGFR3SelQueryInfo flags.
1842	* @{ */
1843	/** Get the info from the guest descriptor table.
1844	* @note This is more or less a given now when raw-mode was kicked out. */
1845	#define DBGFSELQI_FLAGS_DT_GUEST UINT32_C(0)
1846	/** If currently executing in in 64-bit mode, blow up data selectors. */
1847	#define DBGFSELQI_FLAGS_DT_ADJ_64BIT_MODE UINT32_C(2)
1848	/** @} */
1849	VMMR3DECL(int) DBGFR3SelQueryInfo(PUVM pUVM, VMCPUID idCpu, RTSEL Sel, uint32_t fFlags, PDBGFSELINFO pSelInfo);
1850
1851
1852	/**
1853	* Register identifiers.
1854	*/
1855	typedef enum DBGFREG
1856	{
1857	/* General purpose registers: */
1858	DBGFREG_AL = 0,
1859	DBGFREG_AX = DBGFREG_AL,
1860	DBGFREG_EAX = DBGFREG_AL,
1861	DBGFREG_RAX = DBGFREG_AL,
1862
1863	DBGFREG_CL,
1864	DBGFREG_CX = DBGFREG_CL,
1865	DBGFREG_ECX = DBGFREG_CL,
1866	DBGFREG_RCX = DBGFREG_CL,
1867
1868	DBGFREG_DL,
1869	DBGFREG_DX = DBGFREG_DL,
1870	DBGFREG_EDX = DBGFREG_DL,
1871	DBGFREG_RDX = DBGFREG_DL,
1872
1873	DBGFREG_BL,
1874	DBGFREG_BX = DBGFREG_BL,
1875	DBGFREG_EBX = DBGFREG_BL,
1876	DBGFREG_RBX = DBGFREG_BL,
1877
1878	DBGFREG_SPL,
1879	DBGFREG_SP = DBGFREG_SPL,
1880	DBGFREG_ESP = DBGFREG_SPL,
1881	DBGFREG_RSP = DBGFREG_SPL,
1882
1883	DBGFREG_BPL,
1884	DBGFREG_BP = DBGFREG_BPL,
1885	DBGFREG_EBP = DBGFREG_BPL,
1886	DBGFREG_RBP = DBGFREG_BPL,
1887
1888	DBGFREG_SIL,
1889	DBGFREG_SI = DBGFREG_SIL,
1890	DBGFREG_ESI = DBGFREG_SIL,
1891	DBGFREG_RSI = DBGFREG_SIL,
1892
1893	DBGFREG_DIL,
1894	DBGFREG_DI = DBGFREG_DIL,
1895	DBGFREG_EDI = DBGFREG_DIL,
1896	DBGFREG_RDI = DBGFREG_DIL,
1897
1898	DBGFREG_R8,
1899	DBGFREG_R8B = DBGFREG_R8,
1900	DBGFREG_R8W = DBGFREG_R8,
1901	DBGFREG_R8D = DBGFREG_R8,
1902
1903	DBGFREG_R9,
1904	DBGFREG_R9B = DBGFREG_R9,
1905	DBGFREG_R9W = DBGFREG_R9,
1906	DBGFREG_R9D = DBGFREG_R9,
1907
1908	DBGFREG_R10,
1909	DBGFREG_R10B = DBGFREG_R10,
1910	DBGFREG_R10W = DBGFREG_R10,
1911	DBGFREG_R10D = DBGFREG_R10,
1912
1913	DBGFREG_R11,
1914	DBGFREG_R11B = DBGFREG_R11,
1915	DBGFREG_R11W = DBGFREG_R11,
1916	DBGFREG_R11D = DBGFREG_R11,
1917
1918	DBGFREG_R12,
1919	DBGFREG_R12B = DBGFREG_R12,
1920	DBGFREG_R12W = DBGFREG_R12,
1921	DBGFREG_R12D = DBGFREG_R12,
1922
1923	DBGFREG_R13,
1924	DBGFREG_R13B = DBGFREG_R13,
1925	DBGFREG_R13W = DBGFREG_R13,
1926	DBGFREG_R13D = DBGFREG_R13,
1927
1928	DBGFREG_R14,
1929	DBGFREG_R14B = DBGFREG_R14,
1930	DBGFREG_R14W = DBGFREG_R14,
1931	DBGFREG_R14D = DBGFREG_R14,
1932
1933	DBGFREG_R15,
1934	DBGFREG_R15B = DBGFREG_R15,
1935	DBGFREG_R15W = DBGFREG_R15,
1936	DBGFREG_R15D = DBGFREG_R15,
1937
1938	/* Segments and other special registers: */
1939	DBGFREG_CS,
1940	DBGFREG_CS_ATTR,
1941	DBGFREG_CS_BASE,
1942	DBGFREG_CS_LIMIT,
1943
1944	DBGFREG_DS,
1945	DBGFREG_DS_ATTR,
1946	DBGFREG_DS_BASE,
1947	DBGFREG_DS_LIMIT,
1948
1949	DBGFREG_ES,
1950	DBGFREG_ES_ATTR,
1951	DBGFREG_ES_BASE,
1952	DBGFREG_ES_LIMIT,
1953
1954	DBGFREG_FS,
1955	DBGFREG_FS_ATTR,
1956	DBGFREG_FS_BASE,
1957	DBGFREG_FS_LIMIT,
1958
1959	DBGFREG_GS,
1960	DBGFREG_GS_ATTR,
1961	DBGFREG_GS_BASE,
1962	DBGFREG_GS_LIMIT,
1963
1964	DBGFREG_SS,
1965	DBGFREG_SS_ATTR,
1966	DBGFREG_SS_BASE,
1967	DBGFREG_SS_LIMIT,
1968
1969	DBGFREG_IP,
1970	DBGFREG_EIP = DBGFREG_IP,
1971	DBGFREG_RIP = DBGFREG_IP,
1972
1973	DBGFREG_FLAGS,
1974	DBGFREG_EFLAGS = DBGFREG_FLAGS,
1975	DBGFREG_RFLAGS = DBGFREG_FLAGS,
1976
1977	/* FPU: */
1978	DBGFREG_FCW,
1979	DBGFREG_FSW,
1980	DBGFREG_FTW,
1981	DBGFREG_FOP,
1982	DBGFREG_FPUIP,
1983	DBGFREG_FPUCS,
1984	DBGFREG_FPUDP,
1985	DBGFREG_FPUDS,
1986	DBGFREG_MXCSR,
1987	DBGFREG_MXCSR_MASK,
1988
1989	DBGFREG_ST0,
1990	DBGFREG_ST1,
1991	DBGFREG_ST2,
1992	DBGFREG_ST3,
1993	DBGFREG_ST4,
1994	DBGFREG_ST5,
1995	DBGFREG_ST6,
1996	DBGFREG_ST7,
1997
1998	DBGFREG_MM0,
1999	DBGFREG_MM1,
2000	DBGFREG_MM2,
2001	DBGFREG_MM3,
2002	DBGFREG_MM4,
2003	DBGFREG_MM5,
2004	DBGFREG_MM6,
2005	DBGFREG_MM7,
2006
2007	/* SSE: */
2008	DBGFREG_XMM0,
2009	DBGFREG_XMM1,
2010	DBGFREG_XMM2,
2011	DBGFREG_XMM3,
2012	DBGFREG_XMM4,
2013	DBGFREG_XMM5,
2014	DBGFREG_XMM6,
2015	DBGFREG_XMM7,
2016	DBGFREG_XMM8,
2017	DBGFREG_XMM9,
2018	DBGFREG_XMM10,
2019	DBGFREG_XMM11,
2020	DBGFREG_XMM12,
2021	DBGFREG_XMM13,
2022	DBGFREG_XMM14,
2023	DBGFREG_XMM15,
2024	/** @todo add XMM aliases. */
2025
2026	/* AVX: */
2027	DBGFREG_YMM0,
2028	DBGFREG_YMM1,
2029	DBGFREG_YMM2,
2030	DBGFREG_YMM3,
2031	DBGFREG_YMM4,
2032	DBGFREG_YMM5,
2033	DBGFREG_YMM6,
2034	DBGFREG_YMM7,
2035	DBGFREG_YMM8,
2036	DBGFREG_YMM9,
2037	DBGFREG_YMM10,
2038	DBGFREG_YMM11,
2039	DBGFREG_YMM12,
2040	DBGFREG_YMM13,
2041	DBGFREG_YMM14,
2042	DBGFREG_YMM15,
2043
2044	/* System registers: */
2045	DBGFREG_GDTR_BASE,
2046	DBGFREG_GDTR_LIMIT,
2047	DBGFREG_IDTR_BASE,
2048	DBGFREG_IDTR_LIMIT,
2049	DBGFREG_LDTR,
2050	DBGFREG_LDTR_ATTR,
2051	DBGFREG_LDTR_BASE,
2052	DBGFREG_LDTR_LIMIT,
2053	DBGFREG_TR,
2054	DBGFREG_TR_ATTR,
2055	DBGFREG_TR_BASE,
2056	DBGFREG_TR_LIMIT,
2057
2058	DBGFREG_CR0,
2059	DBGFREG_CR2,
2060	DBGFREG_CR3,
2061	DBGFREG_CR4,
2062	DBGFREG_CR8,
2063
2064	DBGFREG_DR0,
2065	DBGFREG_DR1,
2066	DBGFREG_DR2,
2067	DBGFREG_DR3,
2068	DBGFREG_DR6,
2069	DBGFREG_DR7,
2070
2071	/* MSRs: */
2072	DBGFREG_MSR_IA32_APICBASE,
2073	DBGFREG_MSR_IA32_CR_PAT,
2074	DBGFREG_MSR_IA32_PERF_STATUS,
2075	DBGFREG_MSR_IA32_SYSENTER_CS,
2076	DBGFREG_MSR_IA32_SYSENTER_EIP,
2077	DBGFREG_MSR_IA32_SYSENTER_ESP,
2078	DBGFREG_MSR_IA32_TSC,
2079	DBGFREG_MSR_K6_EFER,
2080	DBGFREG_MSR_K6_STAR,
2081	DBGFREG_MSR_K8_CSTAR,
2082	DBGFREG_MSR_K8_FS_BASE,
2083	DBGFREG_MSR_K8_GS_BASE,
2084	DBGFREG_MSR_K8_KERNEL_GS_BASE,
2085	DBGFREG_MSR_K8_LSTAR,
2086	DBGFREG_MSR_K8_SF_MASK,
2087	DBGFREG_MSR_K8_TSC_AUX,
2088
2089	/** The number of registers to pass to DBGFR3RegQueryAll. */
2090	DBGFREG_ALL_COUNT,
2091
2092	/* Misc aliases that doesn't need be part of the 'all' query: */
2093	DBGFREG_AH = DBGFREG_ALL_COUNT,
2094	DBGFREG_CH,
2095	DBGFREG_DH,
2096	DBGFREG_BH,
2097	DBGFREG_GDTR,
2098	DBGFREG_IDTR,
2099
2100	/** The end of the registers. */
2101	DBGFREG_END,
2102	/** The usual 32-bit type hack. */
2103	DBGFREG_32BIT_HACK = 0x7fffffff
2104	} DBGFREG;
2105	/** Pointer to a register identifier. */
2106	typedef DBGFREG *PDBGFREG;
2107	/** Pointer to a const register identifier. */
2108	typedef DBGFREG const *PCDBGFREG;
2109
2110	/**
2111	* Register value type.
2112	*/
2113	typedef enum DBGFREGVALTYPE
2114	{
2115	DBGFREGVALTYPE_INVALID = 0,
2116	/** Unsigned 8-bit register value. */
2117	DBGFREGVALTYPE_U8,
2118	/** Unsigned 16-bit register value. */
2119	DBGFREGVALTYPE_U16,
2120	/** Unsigned 32-bit register value. */
2121	DBGFREGVALTYPE_U32,
2122	/** Unsigned 64-bit register value. */
2123	DBGFREGVALTYPE_U64,
2124	/** Unsigned 128-bit register value. */
2125	DBGFREGVALTYPE_U128,
2126	/** Unsigned 256-bit register value. */
2127	DBGFREGVALTYPE_U256,
2128	/** Unsigned 512-bit register value. */
2129	DBGFREGVALTYPE_U512,
2130	/** Long double register value. */
2131	DBGFREGVALTYPE_R80,
2132	/** Descriptor table register value. */
2133	DBGFREGVALTYPE_DTR,
2134	/** End of the valid register value types. */
2135	DBGFREGVALTYPE_END,
2136	/** The usual 32-bit type hack. */
2137	DBGFREGVALTYPE_32BIT_HACK = 0x7fffffff
2138	} DBGFREGVALTYPE;
2139	/** Pointer to a register value type. */
2140	typedef DBGFREGVALTYPE *PDBGFREGVALTYPE;
2141
2142	/**
2143	* A generic register value type.
2144	*/
2145	typedef union DBGFREGVAL
2146	{
2147	uint64_t au64[8]; /*< The 64-bit array view. First because of the initializer. /
2148	uint32_t au32[16]; /*< The 32-bit array view. /
2149	uint16_t au16[32]; /*< The 16-bit array view. /
2150	uint8_t au8[64]; /*< The 8-bit array view. /
2151
2152	uint8_t u8; /*< The 8-bit view. /
2153	uint16_t u16; /*< The 16-bit view. /
2154	uint32_t u32; /*< The 32-bit view. /
2155	uint64_t u64; /*< The 64-bit view. /
2156	RTUINT128U u128; /*< The 128-bit view. /
2157	RTUINT256U u256; /*< The 256-bit view. /
2158	RTUINT512U u512; /*< The 512-bit view. /
2159	RTFLOAT80U r80; /*< The 80-bit floating point view. /
2160	RTFLOAT80U2 r80Ex; /*< The 80-bit floating point view v2. /
2161	/** GDTR or LDTR (DBGFREGVALTYPE_DTR). */
2162	struct
2163	{
2164	/** The table address. */
2165	uint64_t u64Base;
2166	/** The table limit (length minus 1). */
2167	uint32_t u32Limit; /*< @todo Limit should be uint16_t /
2168	} dtr;
2169	} DBGFREGVAL;
2170	/** Pointer to a generic register value type. */
2171	typedef DBGFREGVAL *PDBGFREGVAL;
2172	/** Pointer to a const generic register value type. */
2173	typedef DBGFREGVAL const *PCDBGFREGVAL;
2174
2175	/** Initialize a DBGFREGVAL variable to all zeros. */
2176	#define DBGFREGVAL_INITIALIZE_ZERO { { 0, 0, 0, 0, 0, 0, 0, 0 } }
2177	/** Initialize a DBGFREGVAL variable to all bits set . */
2178	#define DBGFREGVAL_INITIALIZE_FFFF { { UINT64_MAX, UINT64_MAX, UINT64_MAX, UINT64_MAX, UINT64_MAX, UINT64_MAX, UINT64_MAX, UINT64_MAX } }
2179
2180	/**
2181	* Extended register value, including register ID and type.
2182	*
2183	* This is currently only used by the stack walker.
2184	*/
2185	typedef struct DBGFREGVALEX
2186	{
2187	/** The register value. */
2188	DBGFREGVAL Value;
2189	/** The register value type. */
2190	DBGFREGVALTYPE enmType;
2191	/** The register ID, DBGFREG_END if not applicable. */
2192	DBGFREG enmReg;
2193	/** Pointer to read-only register name string if no register ID could be found. */
2194	const char *pszName;
2195	} DBGFREGVALEX;
2196	/** Pointer to an extended register value struct. */
2197	typedef DBGFREGVALEX *PDBGFREGVALEX;
2198	/** Pointer to a const extended register value struct. */
2199	typedef DBGFREGVALEX const *PCDBGFREGVALEX;
2200
2201
2202	VMMDECL(ssize_t) DBGFR3RegFormatValue(char *pszBuf, size_t cbBuf, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType, bool fSpecial);
2203	VMMDECL(ssize_t) DBGFR3RegFormatValueEx(char *pszBuf, size_t cbBuf, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType,
2204	unsigned uBase, signed int cchWidth, signed int cchPrecision, uint32_t fFlags);
2205
2206	/**
2207	* Register sub-field descriptor.
2208	*/
2209	typedef struct DBGFREGSUBFIELD
2210	{
2211	/** The name of the sub-field. NULL is used to terminate the array. */
2212	const char *pszName;
2213	/** The index of the first bit. Ignored if pfnGet is set. */
2214	uint8_t iFirstBit;
2215	/** The number of bits. Mandatory. */
2216	uint8_t cBits;
2217	/** The shift count. Not applied when pfnGet is set, but used to
2218	* calculate the minimum type. */
2219	int8_t cShift;
2220	/** Sub-field flags, DBGFREGSUBFIELD_FLAGS_XXX. */
2221	uint8_t fFlags;
2222	/** Getter (optional).
2223	* @remarks Does not take the device lock or anything like that.
2224	*/
2225	DECLCALLBACKMEMBER(int, pfnGet,(void pvUser, struct DBGFREGSUBFIELD const pSubField, PRTUINT128U puValue));
2226	/** Setter (optional).
2227	* @remarks Does not take the device lock or anything like that.
2228	*/
2229	DECLCALLBACKMEMBER(int, pfnSet,(void pvUser, struct DBGFREGSUBFIELD const pSubField, RTUINT128U uValue, RTUINT128U fMask));
2230	} DBGFREGSUBFIELD;
2231	/** Pointer to a const register sub-field descriptor. */
2232	typedef DBGFREGSUBFIELD const *PCDBGFREGSUBFIELD;
2233
2234	/** @name DBGFREGSUBFIELD_FLAGS_XXX
2235	* @{ */
2236	/** The sub-field is read-only. */
2237	#define DBGFREGSUBFIELD_FLAGS_READ_ONLY UINT8_C(0x01)
2238	/** @} */
2239
2240	/** Macro for creating a read-write sub-field entry without getters. */
2241	#define DBGFREGSUBFIELD_RW(a_szName, a_iFirstBit, a_cBits, a_cShift) \
2242	{ a_szName, a_iFirstBit, a_cBits, a_cShift, 0 /fFlags/, NULL /pfnGet/, NULL /pfnSet/ }
2243	/** Macro for creating a read-write sub-field entry with getters. */
2244	#define DBGFREGSUBFIELD_RW_SG(a_szName, a_cBits, a_cShift, a_pfnGet, a_pfnSet) \
2245	{ a_szName, 0 /iFirstBit/, a_cBits, a_cShift, 0 /fFlags/, a_pfnGet, a_pfnSet }
2246	/** Macro for creating a read-only sub-field entry without getters. */
2247	#define DBGFREGSUBFIELD_RO(a_szName, a_iFirstBit, a_cBits, a_cShift) \
2248	{ a_szName, a_iFirstBit, a_cBits, a_cShift, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL /pfnGet/, NULL /pfnSet/ }
2249	/** Macro for creating a terminator sub-field entry. */
2250	#define DBGFREGSUBFIELD_TERMINATOR() \
2251	{ NULL, 0, 0, 0, 0, NULL, NULL }
2252
2253	/**
2254	* Register alias descriptor.
2255	*/
2256	typedef struct DBGFREGALIAS
2257	{
2258	/** The alias name. NULL is used to terminate the array. */
2259	const char *pszName;
2260	/** Set to a valid type if the alias has a different type. */
2261	DBGFREGVALTYPE enmType;
2262	} DBGFREGALIAS;
2263	/** Pointer to a const register alias descriptor. */
2264	typedef DBGFREGALIAS const *PCDBGFREGALIAS;
2265
2266	/**
2267	* Register descriptor.
2268	*/
2269	typedef struct DBGFREGDESC
2270	{
2271	/** The normal register name. */
2272	const char *pszName;
2273	/** The register identifier if this is a CPU register. */
2274	DBGFREG enmReg;
2275	/** The default register type. */
2276	DBGFREGVALTYPE enmType;
2277	/** Flags, see DBGFREG_FLAGS_XXX. */
2278	uint32_t fFlags;
2279	/** The internal register indicator.
2280	* For CPU registers this is the offset into the CPUMCTX structure,
2281	* thuse the 'off' prefix. */
2282	uint32_t offRegister;
2283	/** Getter.
2284	* @remarks Does not take the device lock or anything like that.
2285	*/
2286	DECLCALLBACKMEMBER(int, pfnGet,(void pvUser, struct DBGFREGDESC const pDesc, PDBGFREGVAL pValue));
2287	/** Setter.
2288	* @remarks Does not take the device lock or anything like that.
2289	*/
2290	DECLCALLBACKMEMBER(int, pfnSet,(void pvUser, struct DBGFREGDESC const pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask));
2291	/** Aliases (optional). */
2292	PCDBGFREGALIAS paAliases;
2293	/** Sub fields (optional). */
2294	PCDBGFREGSUBFIELD paSubFields;
2295	} DBGFREGDESC;
2296
2297	/** @name Macros for constructing DBGFREGDESC arrays.
2298	* @{ */
2299	#define DBGFREGDESC_RW(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet) \
2300	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, NULL /paAlises/, NULL /paSubFields/ }
2301	#define DBGFREGDESC_RO(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet) \
2302	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, NULL /paAlises/, NULL /paSubFields/ }
2303	#define DBGFREGDESC_RW_A(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases) \
2304	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, NULL /paSubFields/ }
2305	#define DBGFREGDESC_RO_A(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases) \
2306	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, NULL /paSubFields/ }
2307	#define DBGFREGDESC_RW_S(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paSubFields) \
2308	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, /paAliases/, a_paSubFields }
2309	#define DBGFREGDESC_RO_S(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paSubFields) \
2310	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, /paAliases/, a_paSubFields }
2311	#define DBGFREGDESC_RW_AS(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields) \
2312	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields }
2313	#define DBGFREGDESC_RO_AS(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields) \
2314	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields }
2315	#define DBGFREGDESC_TERMINATOR() \
2316	{ NULL, DBGFREG_END, DBGFREGVALTYPE_INVALID, 0, 0, NULL, NULL, NULL, NULL }
2317	/** @} */
2318
2319
2320	/** @name DBGFREG_FLAGS_XXX
2321	* @{ */
2322	/** The register is read-only. */
2323	#define DBGFREG_FLAGS_READ_ONLY RT_BIT_32(0)
2324	/** @} */
2325
2326	/**
2327	* Entry in a batch query or set operation.
2328	*/
2329	typedef struct DBGFREGENTRY
2330	{
2331	/** The register identifier. */
2332	DBGFREG enmReg;
2333	/** The size of the value in bytes. */
2334	DBGFREGVALTYPE enmType;
2335	/** The register value. The valid view is indicated by enmType. */
2336	DBGFREGVAL Val;
2337	} DBGFREGENTRY;
2338	/** Pointer to a register entry in a batch operation. */
2339	typedef DBGFREGENTRY *PDBGFREGENTRY;
2340	/** Pointer to a const register entry in a batch operation. */
2341	typedef DBGFREGENTRY const *PCDBGFREGENTRY;
2342
2343	/** Used with DBGFR3Reg* to indicate the hypervisor register set instead of the
2344	* guest. */
2345	#define DBGFREG_HYPER_VMCPUID UINT32_C(0x01000000)
2346
2347	VMMR3DECL(int) DBGFR3RegCpuQueryU8( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint8_t *pu8);
2348	VMMR3DECL(int) DBGFR3RegCpuQueryU16( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint16_t *pu16);
2349	VMMR3DECL(int) DBGFR3RegCpuQueryU32( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint32_t *pu32);
2350	VMMR3DECL(int) DBGFR3RegCpuQueryU64( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t *pu64);
2351	VMMR3DECL(int) DBGFR3RegCpuQueryU128(PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint128_t *pu128);
2352	VMMR3DECL(int) DBGFR3RegCpuQueryLrd( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, long double *plrd);
2353	VMMR3DECL(int) DBGFR3RegCpuQueryXdtr(PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t pu64Base, uint16_t pu16Limit);
2354	#if 0
2355	VMMR3DECL(int) DBGFR3RegCpuQueryBatch(PUVM pUVM,VMCPUID idCpu, PDBGFREGENTRY paRegs, size_t cRegs);
2356	VMMR3DECL(int) DBGFR3RegCpuQueryAll( PUVM pUVM, VMCPUID idCpu, PDBGFREGENTRY paRegs, size_t cRegs);
2357
2358	VMMR3DECL(int) DBGFR3RegCpuSetU8( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint8_t u8);
2359	VMMR3DECL(int) DBGFR3RegCpuSetU16( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint16_t u16);
2360	VMMR3DECL(int) DBGFR3RegCpuSetU32( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint32_t u32);
2361	VMMR3DECL(int) DBGFR3RegCpuSetU64( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t u64);
2362	VMMR3DECL(int) DBGFR3RegCpuSetU128( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint128_t u128);
2363	VMMR3DECL(int) DBGFR3RegCpuSetLrd( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, long double lrd);
2364	VMMR3DECL(int) DBGFR3RegCpuSetBatch( PUVM pUVM, VMCPUID idCpu, PCDBGFREGENTRY paRegs, size_t cRegs);
2365	#endif
2366
2367	VMMR3DECL(const char *) DBGFR3RegCpuName(PUVM pUVM, DBGFREG enmReg, DBGFREGVALTYPE enmType);
2368
2369	VMMR3_INT_DECL(int) DBGFR3RegRegisterCpu(PVM pVM, PVMCPU pVCpu, PCDBGFREGDESC paRegisters, bool fGuestRegs);
2370	VMMR3_INT_DECL(int) DBGFR3RegRegisterDevice(PVM pVM, PCDBGFREGDESC paRegisters, PPDMDEVINS pDevIns,
2371	const char *pszPrefix, uint32_t iInstance);
2372
2373	/**
2374	* Entry in a named batch query or set operation.
2375	*/
2376	typedef struct DBGFREGENTRYNM
2377	{
2378	/** The register name. */
2379	const char *pszName;
2380	/** The size of the value in bytes. */
2381	DBGFREGVALTYPE enmType;
2382	/** The register value. The valid view is indicated by enmType. */
2383	DBGFREGVAL Val;
2384	} DBGFREGENTRYNM;
2385	/** Pointer to a named register entry in a batch operation. */
2386	typedef DBGFREGENTRYNM *PDBGFREGENTRYNM;
2387	/** Pointer to a const named register entry in a batch operation. */
2388	typedef DBGFREGENTRYNM const *PCDBGFREGENTRYNM;
2389
2390	VMMR3DECL(int) DBGFR3RegNmValidate( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg);
2391
2392	VMMR3DECL(int) DBGFR3RegNmQuery( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PDBGFREGVAL pValue, PDBGFREGVALTYPE penmType);
2393	VMMR3DECL(int) DBGFR3RegNmQueryU8( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint8_t pu8);
2394	VMMR3DECL(int) DBGFR3RegNmQueryU16( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint16_t pu16);
2395	VMMR3DECL(int) DBGFR3RegNmQueryU32( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint32_t pu32);
2396	VMMR3DECL(int) DBGFR3RegNmQueryU64( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint64_t pu64);
2397	VMMR3DECL(int) DBGFR3RegNmQueryU128(PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PRTUINT128U pu128);
2398	/VMMR3DECL(int) DBGFR3RegNmQueryLrd( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, long double plrd);/
2399	VMMR3DECL(int) DBGFR3RegNmQueryXdtr(PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint64_t pu64Base, uint16_t *pu16Limit);
2400	VMMR3DECL(int) DBGFR3RegNmQueryBatch(PUVM pUVM,VMCPUID idDefCpu, PDBGFREGENTRYNM paRegs, size_t cRegs);
2401	VMMR3DECL(int) DBGFR3RegNmQueryAllCount(PUVM pUVM, size_t *pcRegs);
2402	VMMR3DECL(int) DBGFR3RegNmQueryAll( PUVM pUVM, PDBGFREGENTRYNM paRegs, size_t cRegs);
2403
2404	VMMR3DECL(int) DBGFR3RegNmSet( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType);
2405	VMMR3DECL(int) DBGFR3RegNmSetU8( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint8_t u8);
2406	VMMR3DECL(int) DBGFR3RegNmSetU16( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint16_t u16);
2407	VMMR3DECL(int) DBGFR3RegNmSetU32( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint32_t u32);
2408	VMMR3DECL(int) DBGFR3RegNmSetU64( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint64_t u64);
2409	VMMR3DECL(int) DBGFR3RegNmSetU128( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, RTUINT128U u128);
2410	VMMR3DECL(int) DBGFR3RegNmSetLrd( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, long double lrd);
2411	VMMR3DECL(int) DBGFR3RegNmSetBatch( PUVM pUVM, VMCPUID idDefCpu, PCDBGFREGENTRYNM paRegs, size_t cRegs);
2412
2413	/** @todo add enumeration methods. */
2414
2415	VMMR3DECL(int) DBGFR3RegPrintf( PUVM pUVM, VMCPUID idDefCpu, char pszBuf, size_t cbBuf, const char pszFormat, ...);
2416	VMMR3DECL(int) DBGFR3RegPrintfV(PUVM pUVM, VMCPUID idDefCpu, char pszBuf, size_t cbBuf, const char pszFormat, va_list va);
2417
2418
2419	#ifdef IN_RING3
2420
2421	/**
2422	* Guest OS digger interface identifier.
2423	*
2424	* This is for use together with PDBGFR3QueryInterface and is used to
2425	* obtain access to optional interfaces.
2426	*/
2427	typedef enum DBGFOSINTERFACE
2428	{
2429	/** The usual invalid entry. */
2430	DBGFOSINTERFACE_INVALID = 0,
2431	/** Process info. */
2432	DBGFOSINTERFACE_PROCESS,
2433	/** Thread info. */
2434	DBGFOSINTERFACE_THREAD,
2435	/** Kernel message log - DBGFOSIDMESG. */
2436	DBGFOSINTERFACE_DMESG,
2437	/** Windows NT specifics (for the communication with the KD debugger stub). */
2438	DBGFOSINTERFACE_WINNT,
2439	/** The end of the valid entries. */
2440	DBGFOSINTERFACE_END,
2441	/** The usual 32-bit type blowup. */
2442	DBGFOSINTERFACE_32BIT_HACK = 0x7fffffff
2443	} DBGFOSINTERFACE;
2444	/** Pointer to a Guest OS digger interface identifier. */
2445	typedef DBGFOSINTERFACE *PDBGFOSINTERFACE;
2446	/** Pointer to a const Guest OS digger interface identifier. */
2447	typedef DBGFOSINTERFACE const *PCDBGFOSINTERFACE;
2448
2449
2450	/**
2451	* Guest OS Digger Registration Record.
2452	*
2453	* This is used with the DBGFR3OSRegister() API.
2454	*/
2455	typedef struct DBGFOSREG
2456	{
2457	/** Magic value (DBGFOSREG_MAGIC). */
2458	uint32_t u32Magic;
2459	/** Flags. Reserved. */
2460	uint32_t fFlags;
2461	/** The size of the instance data. */
2462	uint32_t cbData;
2463	/** Operative System name. */
2464	char szName[24];
2465
2466	/**
2467	* Constructs the instance.
2468	*
2469	* @returns VBox status code.
2470	* @param pUVM The user mode VM handle.
2471	* @param pvData Pointer to the instance data.
2472	*/
2473	DECLCALLBACKMEMBER(int, pfnConstruct,(PUVM pUVM, void *pvData));
2474
2475	/**
2476	* Destroys the instance.
2477	*
2478	* @param pUVM The user mode VM handle.
2479	* @param pvData Pointer to the instance data.
2480	*/
2481	DECLCALLBACKMEMBER(void, pfnDestruct,(PUVM pUVM, void *pvData));
2482
2483	/**
2484	* Probes the guest memory for OS finger prints.
2485	*
2486	* No setup or so is performed, it will be followed by a call to pfnInit
2487	* or pfnRefresh that should take care of that.
2488	*
2489	* @returns true if is an OS handled by this module, otherwise false.
2490	* @param pUVM The user mode VM handle.
2491	* @param pvData Pointer to the instance data.
2492	*/
2493	DECLCALLBACKMEMBER(bool, pfnProbe,(PUVM pUVM, void *pvData));
2494
2495	/**
2496	* Initializes a fresly detected guest, loading symbols and such useful stuff.
2497	*
2498	* This is called after pfnProbe.
2499	*
2500	* @returns VBox status code.
2501	* @param pUVM The user mode VM handle.
2502	* @param pvData Pointer to the instance data.
2503	*/
2504	DECLCALLBACKMEMBER(int, pfnInit,(PUVM pUVM, void *pvData));
2505
2506	/**
2507	* Refreshes symbols and stuff following a redetection of the same OS.
2508	*
2509	* This is called after pfnProbe.
2510	*
2511	* @returns VBox status code.
2512	* @param pUVM The user mode VM handle.
2513	* @param pvData Pointer to the instance data.
2514	*/
2515	DECLCALLBACKMEMBER(int, pfnRefresh,(PUVM pUVM, void *pvData));
2516
2517	/**
2518	* Terminates an OS when a new (or none) OS has been detected,
2519	* and before destruction.
2520	*
2521	* This is called after pfnProbe and if needed before pfnDestruct.
2522	*
2523	* @param pUVM The user mode VM handle.
2524	* @param pvData Pointer to the instance data.
2525	*/
2526	DECLCALLBACKMEMBER(void, pfnTerm,(PUVM pUVM, void *pvData));
2527
2528	/**
2529	* Queries the version of the running OS.
2530	*
2531	* This is only called after pfnInit().
2532	*
2533	* @returns VBox status code.
2534	* @param pUVM The user mode VM handle.
2535	* @param pvData Pointer to the instance data.
2536	* @param pszVersion Where to store the version string.
2537	* @param cchVersion The size of the version string buffer.
2538	*/
2539	DECLCALLBACKMEMBER(int, pfnQueryVersion,(PUVM pUVM, void pvData, char pszVersion, size_t cchVersion));
2540
2541	/**
2542	* Queries the pointer to a interface.
2543	*
2544	* This is called after pfnProbe.
2545	*
2546	* The returned interface must be valid until pfnDestruct is called. Two calls
2547	* to this method with the same @a enmIf value must return the same pointer.
2548	*
2549	* @returns Pointer to the interface if available, NULL if not available.
2550	* @param pUVM The user mode VM handle.
2551	* @param pvData Pointer to the instance data.
2552	* @param enmIf The interface identifier.
2553	*/
2554	DECLCALLBACKMEMBER(void , pfnQueryInterface,(PUVM pUVM, void pvData, DBGFOSINTERFACE enmIf));
2555
2556	/**
2557	* Stack unwind assist callback.
2558	*
2559	* This is only called after pfnInit().
2560	*
2561	* @returns VBox status code (allocation error or something of similar fatality).
2562	* @param pUVM The user mode VM handle.
2563	* @param pvData Pointer to the instance data.
2564	* @param idCpu The CPU that's unwinding it's stack.
2565	* @param pFrame The current frame. Okay to modify it a little.
2566	* @param pState The unwind state. Okay to modify it.
2567	* @param pInitialCtx The initial register context.
2568	* @param hAs The address space being used for the unwind.
2569	* @param puScratch Scratch area (initialized to zero, no dtor).
2570	*/
2571	DECLCALLBACKMEMBER(int, pfnStackUnwindAssist,(PUVM pUVM, void *pvData, VMCPUID idCpu, PDBGFSTACKFRAME pFrame,
2572	PRTDBGUNWINDSTATE pState, PCCPUMCTX pInitialCtx, RTDBGAS hAs,
2573	uint64_t *puScratch));
2574
2575	/** Trailing magic (DBGFOSREG_MAGIC). */
2576	uint32_t u32EndMagic;
2577	} DBGFOSREG;
2578	/** Pointer to a Guest OS digger registration record. */
2579	typedef DBGFOSREG *PDBGFOSREG;
2580	/** Pointer to a const Guest OS digger registration record. */
2581	typedef DBGFOSREG const *PCDBGFOSREG;
2582
2583	/** Magic value for DBGFOSREG::u32Magic and DBGFOSREG::u32EndMagic. (Hitomi Kanehara) */
2584	#define DBGFOSREG_MAGIC 0x19830808
2585
2586
2587	/**
2588	* Interface for querying kernel log messages (DBGFOSINTERFACE_DMESG).
2589	*/
2590	typedef struct DBGFOSIDMESG
2591	{
2592	/** Trailing magic (DBGFOSIDMESG_MAGIC). */
2593	uint32_t u32Magic;
2594
2595	/**
2596	* Query the kernel log.
2597	*
2598	* @returns VBox status code.
2599	* @retval VERR_NOT_FOUND if the messages could not be located.
2600	* @retval VERR_INVALID_STATE if the messages was found to have unknown/invalid
2601	* format.
2602	* @retval VERR_BUFFER_OVERFLOW if the buffer isn't large enough, pcbActual
2603	* will be set to the required buffer size. The buffer, however, will
2604	* be filled with as much data as it can hold (properly zero terminated
2605	* of course).
2606	*
2607	* @param pThis Pointer to the interface structure.
2608	* @param pUVM The user mode VM handle.
2609	* @param fFlags Flags reserved for future use, MBZ.
2610	* @param cMessages The number of messages to retrieve, counting from the
2611	* end of the log (i.e. like tail), use UINT32_MAX for all.
2612	* @param pszBuf The output buffer.
2613	* @param cbBuf The buffer size.
2614	* @param pcbActual Where to store the number of bytes actually returned,
2615	* including zero terminator. On VERR_BUFFER_OVERFLOW this
2616	* holds the necessary buffer size. Optional.
2617	*/
2618	DECLCALLBACKMEMBER(int, pfnQueryKernelLog,(struct DBGFOSIDMESG *pThis, PUVM pUVM, uint32_t fFlags, uint32_t cMessages,
2619	char pszBuf, size_t cbBuf, size_t pcbActual));
2620	/** Trailing magic (DBGFOSIDMESG_MAGIC). */
2621	uint32_t u32EndMagic;
2622	} DBGFOSIDMESG;
2623	/** Pointer to the interface for query kernel log messages (DBGFOSINTERFACE_DMESG). */
2624	typedef DBGFOSIDMESG *PDBGFOSIDMESG;
2625	/** Magic value for DBGFOSIDMESG::32Magic and DBGFOSIDMESG::u32EndMagic. (Kenazburo Oe) */
2626	#define DBGFOSIDMESG_MAGIC UINT32_C(0x19350131)
2627
2628
2629	/**
2630	* Interface for querying Windows NT guest specifics (DBGFOSINTERFACE_WINNT).
2631	*/
2632	typedef struct DBGFOSIWINNT
2633	{
2634	/** Trailing magic (DBGFOSIWINNT_MAGIC). */
2635	uint32_t u32Magic;
2636
2637	/**
2638	* Queries version information.
2639	*
2640	* @returns VBox status code.
2641	* @param pThis Pointer to the interface structure.
2642	* @param pUVM The user mode VM handle.
2643	* @param puVersMajor Where to store the major version part, optional.
2644	* @param puVersMinor Where to store the minor version part, optional.
2645	* @param puBuildNumber Where to store the build number, optional.
2646	* @param pf32Bit Where to store the flag whether this is a 32bit Windows NT, optional.
2647	*/
2648	DECLCALLBACKMEMBER(int, pfnQueryVersion,(struct DBGFOSIWINNT *pThis, PUVM pUVM,
2649	uint32_t puVersMajor, uint32_t puVersMinor,
2650	uint32_t puBuildNumber, bool pf32Bit));
2651
2652	/**
2653	* Queries some base kernel pointers.
2654	*
2655	* @returns VBox status code.
2656	* @param pThis Pointer to the interface structure.
2657	* @param pUVM The user mode VM handle.
2658	* @param pGCPtrKernBase Where to store the kernel base on success.
2659	* @param pGCPtrPsLoadedModuleList Where to store the pointer to the laoded module list head on success.
2660	*/
2661	DECLCALLBACKMEMBER(int, pfnQueryKernelPtrs,(struct DBGFOSIWINNT *pThis, PUVM pUVM,
2662	PRTGCUINTPTR pGCPtrKernBase, PRTGCUINTPTR pGCPtrPsLoadedModuleList));
2663
2664	/**
2665	* Queries KPCR and KPCRB pointers for the given vCPU.
2666	*
2667	* @returns VBox status code.
2668	* @param pThis Pointer to the interface structure.
2669	* @param pUVM The user mode VM handle.
2670	* @param idCpu The vCPU to query the KPCR/KPCRB for.
2671	* @param pKpcr Where to store the KPCR pointer on success, optional.
2672	* @param pKpcrb Where to store the KPCR pointer on success, optional.
2673	*/
2674	DECLCALLBACKMEMBER(int, pfnQueryKpcrForVCpu,(struct DBGFOSIWINNT *pThis, PUVM pUVM, VMCPUID idCpu,
2675	PRTGCUINTPTR pKpcr, PRTGCUINTPTR pKpcrb));
2676
2677	/**
2678	* Queries the current thread for the given vCPU.
2679	*
2680	* @returns VBox status code.
2681	* @param pThis Pointer to the interface structure.
2682	* @param pUVM The user mode VM handle.
2683	* @param idCpu The vCPU to query the KPCR/KPCRB for.
2684	* @param pCurThrd Where to store the CurrentThread pointer on success.
2685	*/
2686	DECLCALLBACKMEMBER(int, pfnQueryCurThrdForVCpu,(struct DBGFOSIWINNT *pThis, PUVM pUVM, VMCPUID idCpu,
2687	PRTGCUINTPTR pCurThrd));
2688
2689	/** Trailing magic (DBGFOSIWINNT_MAGIC). */
2690	uint32_t u32EndMagic;
2691	} DBGFOSIWINNT;
2692	/** Pointer to the interface for query kernel log messages (DBGFOSINTERFACE_WINNT). */
2693	typedef DBGFOSIWINNT *PDBGFOSIWINNT;
2694	/** Magic value for DBGFOSIWINNT::32Magic and DBGFOSIWINNT::u32EndMagic. (Dave Cutler) */
2695	#define DBGFOSIWINNT_MAGIC UINT32_C(0x19420313)
2696
2697
2698	VMMR3DECL(int) DBGFR3OSRegister(PUVM pUVM, PCDBGFOSREG pReg);
2699	VMMR3DECL(int) DBGFR3OSDeregister(PUVM pUVM, PCDBGFOSREG pReg);
2700	VMMR3DECL(int) DBGFR3OSDetect(PUVM pUVM, char *pszName, size_t cchName);
2701	VMMR3DECL(int) DBGFR3OSQueryNameAndVersion(PUVM pUVM, char pszName, size_t cchName, char pszVersion, size_t cchVersion);
2702	VMMR3DECL(void *) DBGFR3OSQueryInterface(PUVM pUVM, DBGFOSINTERFACE enmIf);
2703
2704
2705	VMMR3DECL(int) DBGFR3CoreWrite(PUVM pUVM, const char *pszFilename, bool fReplaceFile);
2706
2707
2708
2709	/** @defgroup grp_dbgf_plug_in The DBGF Plug-in Interface
2710	* @{
2711	*/
2712
2713	/** The plug-in module name prefix. */
2714	# define DBGF_PLUG_IN_PREFIX "DbgPlugIn"
2715
2716	/** The name of the plug-in entry point (FNDBGFPLUGIN) */
2717	# define DBGF_PLUG_IN_ENTRYPOINT "DbgPlugInEntry"
2718
2719	/**
2720	* DBGF plug-in operations.
2721	*/
2722	typedef enum DBGFPLUGINOP
2723	{
2724	/** The usual invalid first value. */
2725	DBGFPLUGINOP_INVALID,
2726	/** Initialize the plug-in for a VM, register all the stuff.
2727	* The plug-in will be unloaded on failure.
2728	* uArg: The full VirtualBox version, see VBox/version.h. */
2729	DBGFPLUGINOP_INIT,
2730	/** Terminate the plug-ing for a VM, deregister all the stuff.
2731	* The plug-in will be unloaded after this call regardless of the return
2732	* code. */
2733	DBGFPLUGINOP_TERM,
2734	/** The usual 32-bit hack. */
2735	DBGFPLUGINOP_32BIT_HACK = 0x7fffffff
2736	} DBGFPLUGINOP;
2737
2738	/**
2739	* DBGF plug-in main entry point.
2740	*
2741	* @returns VBox status code.
2742	*
2743	* @param enmOperation The operation.
2744	* @param pUVM The user mode VM handle. This may be NULL.
2745	* @param uArg Extra argument.
2746	*/
2747	typedef DECLCALLBACKTYPE(int, FNDBGFPLUGIN,(DBGFPLUGINOP enmOperation, PUVM pUVM, uintptr_t uArg));
2748	/** Pointer to a FNDBGFPLUGIN. */
2749	typedef FNDBGFPLUGIN *PFNDBGFPLUGIN;
2750
2751	/** @copydoc FNDBGFPLUGIN */
2752	DECLEXPORT(int) DbgPlugInEntry(DBGFPLUGINOP enmOperation, PUVM pUVM, uintptr_t uArg);
2753
2754	VMMR3DECL(int) DBGFR3PlugInLoad(PUVM pUVM, const char pszPlugIn, char pszActual, size_t cbActual, PRTERRINFO pErrInfo);
2755	VMMR3DECL(int) DBGFR3PlugInUnload(PUVM pUVM, const char *pszName);
2756	VMMR3DECL(void) DBGFR3PlugInLoadAll(PUVM pUVM);
2757	VMMR3DECL(void) DBGFR3PlugInUnloadAll(PUVM pUVM);
2758
2759	/** @} */
2760
2761
2762	/** @defgroup grp_dbgf_types The DBGF type system Interface.
2763	* @{
2764	*/
2765
2766	/** A few forward declarations. */
2767	/** Pointer to a type registration structure. */
2768	typedef struct DBGFTYPEREG *PDBGFTYPEREG;
2769	/** Pointer to a const type registration structure. */
2770	typedef const struct DBGFTYPEREG *PCDBGFTYPEREG;
2771	/** Pointer to a typed buffer. */
2772	typedef struct DBGFTYPEVAL *PDBGFTYPEVAL;
2773
2774	/**
2775	* DBGF built-in types.
2776	*/
2777	typedef enum DBGFTYPEBUILTIN
2778	{
2779	/** The usual invalid first value. */
2780	DBGFTYPEBUILTIN_INVALID,
2781	/** Unsigned 8bit integer. */
2782	DBGFTYPEBUILTIN_UINT8,
2783	/** Signed 8bit integer. */
2784	DBGFTYPEBUILTIN_INT8,
2785	/** Unsigned 16bit integer. */
2786	DBGFTYPEBUILTIN_UINT16,
2787	/** Signed 16bit integer. */
2788	DBGFTYPEBUILTIN_INT16,
2789	/** Unsigned 32bit integer. */
2790	DBGFTYPEBUILTIN_UINT32,
2791	/** Signed 32bit integer. */
2792	DBGFTYPEBUILTIN_INT32,
2793	/** Unsigned 64bit integer. */
2794	DBGFTYPEBUILTIN_UINT64,
2795	/** Signed 64bit integer. */
2796	DBGFTYPEBUILTIN_INT64,
2797	/** 32bit Guest pointer */
2798	DBGFTYPEBUILTIN_PTR32,
2799	/** 64bit Guest pointer */
2800	DBGFTYPEBUILTIN_PTR64,
2801	/** Guest pointer - size depends on the guest bitness */
2802	DBGFTYPEBUILTIN_PTR,
2803	/** Type indicating a size, like size_t this can have different sizes
2804	* on 32bit and 64bit systems */
2805	DBGFTYPEBUILTIN_SIZE,
2806	/** 32bit float. */
2807	DBGFTYPEBUILTIN_FLOAT32,
2808	/** 64bit float (also known as double). */
2809	DBGFTYPEBUILTIN_FLOAT64,
2810	/** Compund types like structs and unions. */
2811	DBGFTYPEBUILTIN_COMPOUND,
2812	/** The usual 32-bit hack. */
2813	DBGFTYPEBUILTIN_32BIT_HACK = 0x7fffffff
2814	} DBGFTYPEBUILTIN;
2815	/** Pointer to a built-in type. */
2816	typedef DBGFTYPEBUILTIN *PDBGFTYPEBUILTIN;
2817	/** Pointer to a const built-in type. */
2818	typedef const DBGFTYPEBUILTIN *PCDBGFTYPEBUILTIN;
2819
2820	/**
2821	* DBGF type value buffer.
2822	*/
2823	typedef union DBGFTYPEVALBUF
2824	{
2825	uint8_t u8;
2826	int8_t i8;
2827	uint16_t u16;
2828	int16_t i16;
2829	uint32_t u32;
2830	int32_t i32;
2831	uint64_t u64;
2832	int64_t i64;
2833	float f32;
2834	double f64;
2835	uint64_t size; /* For the built-in size_t which can be either 32-bit or 64-bit. */
2836	RTGCPTR GCPtr;
2837	/** For embedded structs. */
2838	PDBGFTYPEVAL pVal;
2839	} DBGFTYPEVALBUF;
2840	/** Pointer to a value. */
2841	typedef DBGFTYPEVALBUF *PDBGFTYPEVALBUF;
2842
2843	/**
2844	* DBGF type value entry.
2845	*/
2846	typedef struct DBGFTYPEVALENTRY
2847	{
2848	/** DBGF built-in type. */
2849	DBGFTYPEBUILTIN enmType;
2850	/** Size of the type. */
2851	size_t cbType;
2852	/** Number of entries, for arrays this can be > 1. */
2853	uint32_t cEntries;
2854	/** Value buffer, depends on whether this is an array. */
2855	union
2856	{
2857	/** Single value. */
2858	DBGFTYPEVALBUF Val;
2859	/** Pointer to the array of values. */
2860	PDBGFTYPEVALBUF pVal;
2861	} Buf;
2862	} DBGFTYPEVALENTRY;
2863	/** Pointer to a type value entry. */
2864	typedef DBGFTYPEVALENTRY *PDBGFTYPEVALENTRY;
2865	/** Pointer to a const type value entry. */
2866	typedef const DBGFTYPEVALENTRY *PCDBGFTYPEVALENTRY;
2867
2868	/**
2869	* DBGF typed value.
2870	*/
2871	typedef struct DBGFTYPEVAL
2872	{
2873	/** Pointer to the registration structure for this type. */
2874	PCDBGFTYPEREG pTypeReg;
2875	/** Number of value entries. */
2876	uint32_t cEntries;
2877	/** Variable sized array of value entries. */
2878	DBGFTYPEVALENTRY aEntries[1];
2879	} DBGFTYPEVAL;
2880
2881	/**
2882	* DBGF type variant.
2883	*/
2884	typedef enum DBGFTYPEVARIANT
2885	{
2886	/** The usual invalid first value. */
2887	DBGFTYPEVARIANT_INVALID,
2888	/** A struct. */
2889	DBGFTYPEVARIANT_STRUCT,
2890	/** Union. */
2891	DBGFTYPEVARIANT_UNION,
2892	/** Alias for an existing type. */
2893	DBGFTYPEVARIANT_ALIAS,
2894	/** The usual 32-bit hack. */
2895	DBGFTYPEVARIANT_32BIT_HACK = 0x7fffffff
2896	} DBGFTYPEVARIANT;
2897
2898	/** @name DBGFTYPEREGMEMBER Flags.
2899	* @{ */
2900	/** The member is an array with a fixed size. */
2901	# define DBGFTYPEREGMEMBER_F_ARRAY RT_BIT_32(0)
2902	/** The member denotes a pointer. */
2903	# define DBGFTYPEREGMEMBER_F_POINTER RT_BIT_32(1)
2904	/** @} */
2905
2906	/**
2907	* DBGF type member.
2908	*/
2909	typedef struct DBGFTYPEREGMEMBER
2910	{
2911	/** Name of the member. */
2912	const char *pszName;
2913	/** Flags for this member, see DBGFTYPEREGMEMBER_F_XXX. */
2914	uint32_t fFlags;
2915	/** Type identifier. */
2916	const char *pszType;
2917	/** The number of elements in the array, only valid for arrays. */
2918	uint32_t cElements;
2919	} DBGFTYPEREGMEMBER;
2920	/** Pointer to a member. */
2921	typedef DBGFTYPEREGMEMBER *PDBGFTYPEREGMEMBER;
2922	/** Pointer to a const member. */
2923	typedef const DBGFTYPEREGMEMBER *PCDBGFTYPEREGMEMBER;
2924
2925	/** @name DBGFTYPEREG Flags.
2926	* @{ */
2927	/** The type is a packed structure. */
2928	# define DBGFTYPEREG_F_PACKED RT_BIT_32(0)
2929	/** @} */
2930
2931	/**
2932	* New type registration structure.
2933	*/
2934	typedef struct DBGFTYPEREG
2935	{
2936	/** Name of the type. */
2937	const char *pszType;
2938	/** The type variant. */
2939	DBGFTYPEVARIANT enmVariant;
2940	/** Some registration flags, see DBGFTYPEREG_F_XXX. */
2941	uint32_t fFlags;
2942	/** Number of members this type has, only valid for structs or unions. */
2943	uint32_t cMembers;
2944	/** Pointer to the member fields, only valid for structs or unions. */
2945	PCDBGFTYPEREGMEMBER paMembers;
2946	/** Name of the aliased type for aliases. */
2947	const char *pszAliasedType;
2948	} DBGFTYPEREG;
2949
2950	/**
2951	* DBGF typed value dumper callback.
2952	*
2953	* @returns VBox status code. Any non VINF_SUCCESS status code will abort the dumping.
2954	*
2955	* @param off The byte offset of the entry from the start of the type.
2956	* @param pszField The name of the field for the value.
2957	* @param iLvl The current level.
2958	* @param enmType The type enum.
2959	* @param cbType Size of the type.
2960	* @param pValBuf Pointer to the value buffer.
2961	* @param cValBufs Number of value buffers (for arrays).
2962	* @param pvUser Opaque user data.
2963	*/
2964	typedef DECLCALLBACKTYPE(int, FNDBGFR3TYPEVALDUMP,(uint32_t off, const char *pszField, uint32_t iLvl,
2965	DBGFTYPEBUILTIN enmType, size_t cbType,
2966	PDBGFTYPEVALBUF pValBuf, uint32_t cValBufs, void *pvUser));
2967	/** Pointer to a FNDBGFR3TYPEVALDUMP. */
2968	typedef FNDBGFR3TYPEVALDUMP *PFNDBGFR3TYPEVALDUMP;
2969
2970	/**
2971	* DBGF type information dumper callback.
2972	*
2973	* @returns VBox status code. Any non VINF_SUCCESS status code will abort the dumping.
2974	*
2975	* @param off The byte offset of the entry from the start of the type.
2976	* @param pszField The name of the field for the value.
2977	* @param iLvl The current level.
2978	* @param pszType The type of the field.
2979	* @param fTypeFlags Flags for this type, see DBGFTYPEREGMEMBER_F_XXX.
2980	* @param cElements Number of for the field ( > 0 for arrays).
2981	* @param pvUser Opaque user data.
2982	*/
2983	typedef DECLCALLBACKTYPE(int, FNDBGFR3TYPEDUMP,(uint32_t off, const char *pszField, uint32_t iLvl,
2984	const char *pszType, uint32_t fTypeFlags,
2985	uint32_t cElements, void *pvUser));
2986	/** Pointer to a FNDBGFR3TYPEDUMP. */
2987	typedef FNDBGFR3TYPEDUMP *PFNDBGFR3TYPEDUMP;
2988
2989	VMMR3DECL(int) DBGFR3TypeRegister( PUVM pUVM, uint32_t cTypes, PCDBGFTYPEREG paTypes);
2990	VMMR3DECL(int) DBGFR3TypeDeregister(PUVM pUVM, const char *pszType);
2991	VMMR3DECL(int) DBGFR3TypeQueryReg( PUVM pUVM, const char pszType, PCDBGFTYPEREG ppTypeReg);
2992
2993	VMMR3DECL(int) DBGFR3TypeQuerySize( PUVM pUVM, const char pszType, size_t pcbType);
2994	VMMR3DECL(int) DBGFR3TypeSetSize( PUVM pUVM, const char *pszType, size_t cbType);
2995	VMMR3DECL(int) DBGFR3TypeDumpEx( PUVM pUVM, const char *pszType, uint32_t fFlags,
2996	uint32_t cLvlMax, PFNDBGFR3TYPEDUMP pfnDump, void *pvUser);
2997	VMMR3DECL(int) DBGFR3TypeQueryValByType(PUVM pUVM, PCDBGFADDRESS pAddress, const char *pszType,
2998	PDBGFTYPEVAL *ppVal);
2999	VMMR3DECL(void) DBGFR3TypeValFree(PDBGFTYPEVAL pVal);
3000	VMMR3DECL(int) DBGFR3TypeValDumpEx(PUVM pUVM, PCDBGFADDRESS pAddress, const char *pszType, uint32_t fFlags,
3001	uint32_t cLvlMax, FNDBGFR3TYPEVALDUMP pfnDump, void *pvUser);
3002
3003	/** @} */
3004
3005
3006	/** @defgroup grp_dbgf_flow The DBGF control flow graph Interface.
3007	* @{
3008	*/
3009
3010	/** A DBGF control flow graph handle. */
3011	typedef struct DBGFFLOWINT *DBGFFLOW;
3012	/** Pointer to a DBGF control flow graph handle. */
3013	typedef DBGFFLOW *PDBGFFLOW;
3014	/** A DBGF control flow graph basic block handle. */
3015	typedef struct DBGFFLOWBBINT *DBGFFLOWBB;
3016	/** Pointer to a DBGF control flow graph basic block handle. */
3017	typedef DBGFFLOWBB *PDBGFFLOWBB;
3018	/** A DBGF control flow graph branch table handle. */
3019	typedef struct DBGFFLOWBRANCHTBLINT *DBGFFLOWBRANCHTBL;
3020	/** Pointer to a DBGF flow control graph branch table handle. */
3021	typedef DBGFFLOWBRANCHTBL *PDBGFFLOWBRANCHTBL;
3022	/** A DBGF control flow graph iterator. */
3023	typedef struct DBGFFLOWITINT *DBGFFLOWIT;
3024	/** Pointer to a control flow graph iterator. */
3025	typedef DBGFFLOWIT *PDBGFFLOWIT;
3026	/** A DBGF control flow graph branch table iterator. */
3027	typedef struct DBGFFLOWBRANCHTBLITINT *DBGFFLOWBRANCHTBLIT;
3028	/** Pointer to a control flow graph branch table iterator. */
3029	typedef DBGFFLOWBRANCHTBLIT *PDBGFFLOWBRANCHTBLIT;
3030
3031	/** @name DBGFFLOWBB Flags.
3032	* @{ */
3033	/** The basic block is the entry into the owning control flow graph. */
3034	#define DBGF_FLOW_BB_F_ENTRY RT_BIT_32(0)
3035	/** The basic block was not populated because the limit was reached. */
3036	#define DBGF_FLOW_BB_F_EMPTY RT_BIT_32(1)
3037	/** The basic block is not complete because an error happened during disassembly. */
3038	#define DBGF_FLOW_BB_F_INCOMPLETE_ERR RT_BIT_32(2)
3039	/** The basic block is reached through a branch table. */
3040	#define DBGF_FLOW_BB_F_BRANCH_TABLE RT_BIT_32(3)
3041	/** @} */
3042
3043	/** @name Flags controlling the creating of a control flow graph.
3044	* @{ */
3045	/** Default options. */
3046	#define DBGF_FLOW_CREATE_F_DEFAULT 0
3047	/** Tries to resolve indirect branches, useful for code using
3048	* jump tables generated for large switch statements by some compilers. */
3049	#define DBGF_FLOW_CREATE_F_TRY_RESOLVE_INDIRECT_BRANCHES RT_BIT_32(0)
3050	/** @} */
3051
3052	/**
3053	* DBGF control graph basic block end type.
3054	*/
3055	typedef enum DBGFFLOWBBENDTYPE
3056	{
3057	/** Invalid type. */
3058	DBGFFLOWBBENDTYPE_INVALID = 0,
3059	/** Basic block is the exit block and has no successor. */
3060	DBGFFLOWBBENDTYPE_EXIT,
3061	/** Basic block is the last disassembled block because the
3062	* maximum amount to disassemble was reached but is not an
3063	* exit block - no successors.
3064	*/
3065	DBGFFLOWBBENDTYPE_LAST_DISASSEMBLED,
3066	/** Unconditional control flow change because the successor is referenced by multiple
3067	* basic blocks. - 1 successor. */
3068	DBGFFLOWBBENDTYPE_UNCOND,
3069	/** Unconditional control flow change because of an direct branch - 1 successor. */
3070	DBGFFLOWBBENDTYPE_UNCOND_JMP,
3071	/** Unconditional control flow change because of an indirect branch - n successors. */
3072	DBGFFLOWBBENDTYPE_UNCOND_INDIRECT_JMP,
3073	/** Conditional control flow change - 2 successors. */
3074	DBGFFLOWBBENDTYPE_COND,
3075	/** 32bit hack. */
3076	DBGFFLOWBBENDTYPE_32BIT_HACK = 0x7fffffff
3077	} DBGFFLOWBBENDTYPE;
3078
3079	/**
3080	* DBGF control flow graph iteration order.
3081	*/
3082	typedef enum DBGFFLOWITORDER
3083	{
3084	/** Invalid order. */
3085	DBGFFLOWITORDER_INVALID = 0,
3086	/** From lowest to highest basic block start address. */
3087	DBGFFLOWITORDER_BY_ADDR_LOWEST_FIRST,
3088	/** From highest to lowest basic block start address. */
3089	DBGFFLOWITORDER_BY_ADDR_HIGHEST_FIRST,
3090	/** Depth first traversing starting from the entry block. */
3091	DBGFFLOWITORDER_DEPTH_FRIST,
3092	/** Breadth first traversing starting from the entry block. */
3093	DBGFFLOWITORDER_BREADTH_FIRST,
3094	/** Usual 32bit hack. */
3095	DBGFFLOWITORDER_32BIT_HACK = 0x7fffffff
3096	} DBGFFLOWITORDER;
3097	/** Pointer to a iteration order enum. */
3098	typedef DBGFFLOWITORDER *PDBGFFLOWITORDER;
3099
3100
3101	VMMR3DECL(int) DBGFR3FlowCreate(PUVM pUVM, VMCPUID idCpu, PDBGFADDRESS pAddressStart, uint32_t cbDisasmMax,
3102	uint32_t fFlagsFlow, uint32_t fFlagsDisasm, PDBGFFLOW phFlow);
3103	VMMR3DECL(uint32_t) DBGFR3FlowRetain(DBGFFLOW hFlow);
3104	VMMR3DECL(uint32_t) DBGFR3FlowRelease(DBGFFLOW hFlow);
3105	VMMR3DECL(int) DBGFR3FlowQueryStartBb(DBGFFLOW hFlow, PDBGFFLOWBB phFlowBb);
3106	VMMR3DECL(int) DBGFR3FlowQueryBbByAddress(DBGFFLOW hFlow, PDBGFADDRESS pAddr, PDBGFFLOWBB phFlowBb);
3107	VMMR3DECL(int) DBGFR3FlowQueryBranchTblByAddress(DBGFFLOW hFlow, PDBGFADDRESS pAddr, PDBGFFLOWBRANCHTBL phFlowBranchTbl);
3108	VMMR3DECL(uint32_t) DBGFR3FlowGetBbCount(DBGFFLOW hFlow);
3109	VMMR3DECL(uint32_t) DBGFR3FlowGetBranchTblCount(DBGFFLOW hFlow);
3110
3111	VMMR3DECL(uint32_t) DBGFR3FlowBbRetain(DBGFFLOWBB hFlowBb);
3112	VMMR3DECL(uint32_t) DBGFR3FlowBbRelease(DBGFFLOWBB hFlowBb);
3113	VMMR3DECL(PDBGFADDRESS) DBGFR3FlowBbGetStartAddress(DBGFFLOWBB hFlowBb, PDBGFADDRESS pAddrStart);
3114	VMMR3DECL(PDBGFADDRESS) DBGFR3FlowBbGetEndAddress(DBGFFLOWBB hFlowBb, PDBGFADDRESS pAddrEnd);
3115	VMMR3DECL(PDBGFADDRESS) DBGFR3FlowBbGetBranchAddress(DBGFFLOWBB hFlowBb, PDBGFADDRESS pAddrTarget);
3116	VMMR3DECL(PDBGFADDRESS) DBGFR3FlowBbGetFollowingAddress(DBGFFLOWBB hFlowBb, PDBGFADDRESS pAddrFollow);
3117	VMMR3DECL(DBGFFLOWBBENDTYPE) DBGFR3FlowBbGetType(DBGFFLOWBB hFlowBb);
3118	VMMR3DECL(uint32_t) DBGFR3FlowBbGetInstrCount(DBGFFLOWBB hFlowBb);
3119	VMMR3DECL(uint32_t) DBGFR3FlowBbGetFlags(DBGFFLOWBB hFlowBb);
3120	VMMR3DECL(int) DBGFR3FlowBbQueryBranchTbl(DBGFFLOWBB hFlowBb, PDBGFFLOWBRANCHTBL phBranchTbl);
3121	VMMR3DECL(int) DBGFR3FlowBbQueryError(DBGFFLOWBB hFlowBb, const char **ppszErr);
3122	VMMR3DECL(int) DBGFR3FlowBbQueryInstr(DBGFFLOWBB hFlowBb, uint32_t idxInstr, PDBGFADDRESS pAddrInstr,
3123	uint32_t pcbInstr, const char *ppszInstr);
3124	VMMR3DECL(int) DBGFR3FlowBbQuerySuccessors(DBGFFLOWBB hFlowBb, PDBGFFLOWBB phFlowBbFollow,
3125	PDBGFFLOWBB phFlowBbTarget);
3126	VMMR3DECL(uint32_t) DBGFR3FlowBbGetRefBbCount(DBGFFLOWBB hFlowBb);
3127	VMMR3DECL(int) DBGFR3FlowBbGetRefBb(DBGFFLOWBB hFlowBb, PDBGFFLOWBB pahFlowBbRef, uint32_t cRef);
3128
3129	VMMR3DECL(uint32_t) DBGFR3FlowBranchTblRetain(DBGFFLOWBRANCHTBL hFlowBranchTbl);
3130	VMMR3DECL(uint32_t) DBGFR3FlowBranchTblRelease(DBGFFLOWBRANCHTBL hFlowBranchTbl);
3131	VMMR3DECL(uint32_t) DBGFR3FlowBranchTblGetSlots(DBGFFLOWBRANCHTBL hFlowBranchTbl);
3132	VMMR3DECL(PDBGFADDRESS) DBGFR3FlowBranchTblGetStartAddress(DBGFFLOWBRANCHTBL hFlowBranchTbl, PDBGFADDRESS pAddrStart);
3133	VMMR3DECL(PDBGFADDRESS) DBGFR3FlowBranchTblGetAddrAtSlot(DBGFFLOWBRANCHTBL hFlowBranchTbl, uint32_t idxSlot, PDBGFADDRESS pAddrSlot);
3134	VMMR3DECL(int) DBGFR3FlowBranchTblQueryAddresses(DBGFFLOWBRANCHTBL hFlowBranchTbl, PDBGFADDRESS paAddrs, uint32_t cAddrs);
3135
3136	VMMR3DECL(int) DBGFR3FlowItCreate(DBGFFLOW hFlow, DBGFFLOWITORDER enmOrder, PDBGFFLOWIT phFlowIt);
3137	VMMR3DECL(void) DBGFR3FlowItDestroy(DBGFFLOWIT hFlowIt);
3138	VMMR3DECL(DBGFFLOWBB) DBGFR3FlowItNext(DBGFFLOWIT hFlowIt);
3139	VMMR3DECL(int) DBGFR3FlowItReset(DBGFFLOWIT hFlowIt);
3140
3141	VMMR3DECL(int) DBGFR3FlowBranchTblItCreate(DBGFFLOW hFlow, DBGFFLOWITORDER enmOrder, PDBGFFLOWBRANCHTBLIT phFlowBranchTblIt);
3142	VMMR3DECL(void) DBGFR3FlowBranchTblItDestroy(DBGFFLOWBRANCHTBLIT hFlowBranchTblIt);
3143	VMMR3DECL(DBGFFLOWBRANCHTBL) DBGFR3FlowBranchTblItNext(DBGFFLOWBRANCHTBLIT hFlowBranchTblIt);
3144	VMMR3DECL(int) DBGFR3FlowBranchTblItReset(DBGFFLOWBRANCHTBLIT hFlowBranchTblIt);
3145
3146	/** @} */
3147
3148
3149	/** @defgroup grp_dbgf_misc Misc DBGF interfaces.
3150	* @{ */
3151	VMMR3DECL(VBOXSTRICTRC) DBGFR3ReportBugCheck(PVM pVM, PVMCPU pVCpu, DBGFEVENTTYPE enmEvent, uint64_t uBugCheck,
3152	uint64_t uP1, uint64_t uP2, uint64_t uP3, uint64_t uP4);
3153	VMMR3DECL(int) DBGFR3FormatBugCheck(PUVM pUVM, char *pszDetails, size_t cbDetails,
3154	uint64_t uP0, uint64_t uP1, uint64_t uP2, uint64_t uP3, uint64_t uP4);
3155	/** @} */
3156	#endif /* IN_RING3 */
3157
3158
3159	/** @defgroup grp_dbgf_tracer DBGF event tracing.
3160	* @{ */
3161	#ifdef IN_RING3
3162	VMMR3_INT_DECL(int) DBGFR3TracerRegisterEvtSrc(PVM pVM, const char *pszName, PDBGFTRACEREVTSRC phEvtSrc);
3163	VMMR3_INT_DECL(int) DBGFR3TracerDeregisterEvtSrc(PVM pVM, DBGFTRACEREVTSRC hEvtSrc);
3164	VMMR3_INT_DECL(int) DBGFR3TracerEvtIoPortCreate(PVM pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hRegion, RTIOPORT cPorts, uint32_t fFlags,
3165	uint32_t iPciRegion);
3166	VMMR3_INT_DECL(int) DBGFR3TracerEvtMmioCreate(PVM pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hRegion, RTGCPHYS cbRegion, uint32_t fFlags,
3167	uint32_t iPciRegion);
3168	#endif
3169
3170	VMM_INT_DECL(int) DBGFTracerEvtMmioMap(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hRegion, RTGCPHYS GCPhysMmio);
3171	VMM_INT_DECL(int) DBGFTracerEvtMmioUnmap(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hRegion);
3172	VMM_INT_DECL(int) DBGFTracerEvtMmioRead(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hRegion, RTGCPHYS offMmio, const void *pvVal, size_t cbVal);
3173	VMM_INT_DECL(int) DBGFTracerEvtMmioWrite(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hRegion, RTGCPHYS offMmio, const void *pvVal, size_t cbVal);
3174	VMM_INT_DECL(int) DBGFTracerEvtMmioFill(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hRegion, RTGCPHYS offMmio, uint32_t u32Item, uint32_t cbItem, uint32_t cItems);
3175	VMM_INT_DECL(int) DBGFTracerEvtIoPortMap(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hIoPorts, RTIOPORT IoPortBase);
3176	VMM_INT_DECL(int) DBGFTracerEvtIoPortUnmap(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hIoPorts);
3177	VMM_INT_DECL(int) DBGFTracerEvtIoPortRead(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hIoPorts, RTIOPORT offPort, const void *pvVal, size_t cbVal);
3178	VMM_INT_DECL(int) DBGFTracerEvtIoPortReadStr(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hIoPorts, RTIOPORT offPort, const void *pv, size_t cb,
3179	uint32_t cTransfersReq, uint32_t cTransfersRet);
3180	VMM_INT_DECL(int) DBGFTracerEvtIoPortWrite(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hIoPorts, RTIOPORT offPort, const void *pvVal, size_t cbVal);
3181	VMM_INT_DECL(int) DBGFTracerEvtIoPortWriteStr(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, uint64_t hIoPorts, RTIOPORT offPort, const void *pv, size_t cb,
3182	uint32_t cTransfersReq, uint32_t cTransfersRet);
3183	VMM_INT_DECL(int) DBGFTracerEvtIrq(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, int32_t iIrq, int32_t fIrqLvl);
3184	VMM_INT_DECL(int) DBGFTracerEvtIoApicMsi(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, RTGCPHYS GCPhys, uint32_t u32Val);
3185	VMM_INT_DECL(int) DBGFTracerEvtGCPhysRead(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, RTGCPHYS GCPhys, const void *pvBuf, size_t cbRead);
3186	VMM_INT_DECL(int) DBGFTracerEvtGCPhysWrite(PVMCC pVM, DBGFTRACEREVTSRC hEvtSrc, RTGCPHYS GCPhys, const void *pvBuf, size_t cbWrite);
3187	/** @} */
3188
3189	/** @} */
3190
3191	RT_C_DECLS_END
3192
3193	#endif /* !VBOX_INCLUDED_vmm_dbgf_h */
3194

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

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

Download in other formats: