dbgf.h@ 64589

Last change on this file since 64589 was 64589, checked in by vboxsync, 8 years ago
DBGFR3Flow: Iterator API for the branch tables
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 106.0 KB

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

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

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

Download in other formats: