dbgf.h@ 58979

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

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

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

Download in other formats: