dbgf.h@ 73460

Last change on this file since 73460 was 73460, checked in by vboxsync, 7 years ago
IPRT,DBGF,Diggers: Moved DBGFRETURNTYPE and the unwind state structure to IPRT (dbg.h) in prep for debug module interface and more. Added stack unwind assist callback for the OS diggers so they can identify special stack frames and supply more info via the sure-register-value array and frame flags. Identify and decode NT/AMD64 trap frames.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 111.2 KB

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

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

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

Download in other formats: