dbgf.h@ 87594

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

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

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

Download in other formats: