dbgf.h@ 73351

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

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

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

Download in other formats: