dbgf.h@ 58995

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

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

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

Download in other formats: