dbgf.h@ 73348

Last change on this file since 73348 was 73348, checked in by vboxsync, 7 years ago
DBGF,DBGC,GIMHv: Added some basic windows bug check formatting (DBGFR3FormatBugCheck). Extended DBGFEventGenericWithArgs and DBGFEVENT to hold up to 6 64-bit arguments, so that we can pass all the bug check arguments to the debugger.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 110.1 KB

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

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

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

Download in other formats: