dbgf.h@ 58932

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

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

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

Download in other formats: