dbgf.h@ 59072

Last change on this file since 59072 was 59072, checked in by vboxsync, 9 years ago
DBGC: Implemented the DBGC side of the sx* commands. (DBGF isn't quite there yet.)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 88.8 KB

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

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

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

Download in other formats: