dbgf.h@ 47671

Last change on this file since 47671 was 47671, checked in by vboxsync, 11 years ago
VMM: More debugging related stuff.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 61.9 KB

Line
1	/** @file
2	* DBGF - Debugger Facility.
3	*/
4
5	/*
6	* Copyright (C) 2006-2013 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	* @{
42	*/
43
44	#if defined(IN_RC) \|\| defined(IN_RING0)
45	/** @addgroup grp_dbgf_rz The RZ DBGF API
46	* @ingroup grp_dbgf
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
151	/** Fatal error.
152	* This notifies a fatal error in the VMM and that the debugger get's a
153	* chance to first hand information about the the problem.
154	*/
155	DBGFEVENT_FATAL_ERROR = 100,
156	/** Breakpoint Hit.
157	* This notifies that a breakpoint installed by the debugger was hit. The
158	* identifier of the breakpoint can be found in the DBGFEVENT::u::Bp::iBp member.
159	*/
160	DBGFEVENT_BREAKPOINT,
161	/** Breakpoint Hit in the Hypervisor.
162	* This notifies that a breakpoint installed by the debugger was hit. The
163	* identifier of the breakpoint can be found in the DBGFEVENT::u::Bp::iBp member.
164	*/
165	DBGFEVENT_BREAKPOINT_HYPER,
166	/** Assertion in the Hypervisor (breakpoint instruction).
167	* This notifies that a breakpoint instruction was hit in the hypervisor context.
168	*/
169	DBGFEVENT_ASSERTION_HYPER,
170	/** Single Stepped.
171	* This notifies that a single step operation was completed.
172	*/
173	DBGFEVENT_STEPPED,
174	/** Single Stepped.
175	* This notifies that a hypervisor single step operation was completed.
176	*/
177	DBGFEVENT_STEPPED_HYPER,
178	/** The developer have used the DBGFSTOP macro or the PDMDeviceDBGFSTOP function
179	* to bring up the debugger at a specific place.
180	*/
181	DBGFEVENT_DEV_STOP,
182	/** The VM is powering off.
183	* When this notification is received, the debugger thread should detach ASAP.
184	*/
185	DBGFEVENT_POWERING_OFF,
186
187	/** The usual 32-bit hack. */
188	DBGFEVENT_32BIT_HACK = 0x7fffffff
189	} DBGFEVENTTYPE;
190
191
192	/**
193	* The context of an event.
194	*/
195	typedef enum DBGFEVENTCTX
196	{
197	/** The usual invalid entry. */
198	DBGFEVENTCTX_INVALID = 0,
199	/** Raw mode. */
200	DBGFEVENTCTX_RAW,
201	/** Recompiled mode. */
202	DBGFEVENTCTX_REM,
203	/** VMX / AVT mode. */
204	DBGFEVENTCTX_HM,
205	/** Hypervisor context. */
206	DBGFEVENTCTX_HYPER,
207	/** Other mode */
208	DBGFEVENTCTX_OTHER,
209
210	/** The usual 32-bit hack */
211	DBGFEVENTCTX_32BIT_HACK = 0x7fffffff
212	} DBGFEVENTCTX;
213
214	/**
215	* VMM Debug Event.
216	*/
217	typedef struct DBGFEVENT
218	{
219	/** Type. */
220	DBGFEVENTTYPE enmType;
221	/** Context */
222	DBGFEVENTCTX enmCtx;
223	/** Type specific data. */
224	union
225	{
226	/** Fatal error details. */
227	struct
228	{
229	/** The GC return code. */
230	int rc;
231	} FatalError;
232
233	/** Source location. */
234	struct
235	{
236	/** File name. */
237	R3PTRTYPE(const char *) pszFile;
238	/** Function name. */
239	R3PTRTYPE(const char *) pszFunction;
240	/** Message. */
241	R3PTRTYPE(const char *) pszMessage;
242	/** Line number. */
243	unsigned uLine;
244	} Src;
245
246	/** Assertion messages. */
247	struct
248	{
249	/** The first message. */
250	R3PTRTYPE(const char *) pszMsg1;
251	/** The second message. */
252	R3PTRTYPE(const char *) pszMsg2;
253	} Assert;
254
255	/** Breakpoint. */
256	struct DBGFEVENTBP
257	{
258	/** The identifier of the breakpoint which was hit. */
259	RTUINT iBp;
260	} Bp;
261	/** Padding for ensuring that the structure is 8 byte aligned. */
262	uint64_t au64Padding[4];
263	} u;
264	} DBGFEVENT;
265	/** Pointer to VMM Debug Event. */
266	typedef DBGFEVENT *PDBGFEVENT;
267	/** Pointer to const VMM Debug Event. */
268	typedef const DBGFEVENT *PCDBGFEVENT;
269
270	#ifdef IN_RING3 /* The event API only works in ring-3. */
271
272	/** @def DBGFSTOP
273	* Stops the debugger raising a DBGFEVENT_DEVELOPER_STOP event.
274	*
275	* @returns VBox status code which must be propagated up to EM if not VINF_SUCCESS.
276	* @param pVM VM Handle.
277	*/
278	# ifdef VBOX_STRICT
279	# define DBGFSTOP(pVM) DBGFR3EventSrc(pVM, DBGFEVENT_DEV_STOP, __FILE__, __LINE__, __PRETTY_FUNCTION__, NULL)
280	# else
281	# define DBGFSTOP(pVM) VINF_SUCCESS
282	# endif
283
284	VMMR3_INT_DECL(int) DBGFR3Init(PVM pVM);
285	VMMR3_INT_DECL(int) DBGFR3Term(PVM pVM);
286	VMMR3_INT_DECL(void) DBGFR3PowerOff(PVM pVM);
287	VMMR3_INT_DECL(void) DBGFR3Relocate(PVM pVM, RTGCINTPTR offDelta);
288	VMMR3_INT_DECL(int) DBGFR3VMMForcedAction(PVM pVM);
289	VMMR3DECL(int) DBGFR3Event(PVM pVM, DBGFEVENTTYPE enmEvent);
290	VMMR3DECL(int) DBGFR3EventSrc(PVM pVM, DBGFEVENTTYPE enmEvent, const char *pszFile, unsigned uLine,
291	const char pszFunction, const char pszFormat, ...);
292	VMMR3DECL(int) DBGFR3EventSrcV(PVM pVM, DBGFEVENTTYPE enmEvent, const char *pszFile, unsigned uLine,
293	const char pszFunction, const char pszFormat, va_list args);
294	VMMR3_INT_DECL(int) DBGFR3EventAssertion(PVM pVM, DBGFEVENTTYPE enmEvent, const char pszMsg1, const char pszMsg2);
295	VMMR3_INT_DECL(int) DBGFR3EventBreakpoint(PVM pVM, DBGFEVENTTYPE enmEvent);
296	VMMR3_INT_DECL(int) DBGFR3PrgStep(PVMCPU pVCpu);
297
298	VMMR3DECL(int) DBGFR3Attach(PUVM pUVM);
299	VMMR3DECL(int) DBGFR3Detach(PUVM pUVM);
300	VMMR3DECL(int) DBGFR3EventWait(PUVM pUVM, RTMSINTERVAL cMillies, PCDBGFEVENT *ppEvent);
301	VMMR3DECL(int) DBGFR3Halt(PUVM pUVM);
302	VMMR3DECL(bool) DBGFR3IsHalted(PUVM pUVM);
303	VMMR3DECL(int) DBGFR3QueryWaitable(PUVM pUVM);
304	VMMR3DECL(int) DBGFR3Resume(PUVM pUVM);
305	VMMR3DECL(int) DBGFR3Step(PUVM pUVM, VMCPUID idCpu);
306	VMMR3DECL(int) DBGFR3InjectNMI(PUVM pUVM, VMCPUID idCpu);
307
308	#endif /* IN_RING3 */
309
310
311
312	/** Breakpoint type. */
313	typedef enum DBGFBPTYPE
314	{
315	/** Free breakpoint entry. */
316	DBGFBPTYPE_FREE = 0,
317	/** Debug register. */
318	DBGFBPTYPE_REG,
319	/** INT 3 instruction. */
320	DBGFBPTYPE_INT3,
321	/** Recompiler. */
322	DBGFBPTYPE_REM,
323	/** ensure 32-bit size. */
324	DBGFBPTYPE_32BIT_HACK = 0x7fffffff
325	} DBGFBPTYPE;
326
327
328	/**
329	* A Breakpoint.
330	*/
331	typedef struct DBGFBP
332	{
333	/** The number of breakpoint hits. */
334	uint64_t cHits;
335	/** The hit number which starts to trigger the breakpoint. */
336	uint64_t iHitTrigger;
337	/** The hit number which stops triggering the breakpoint (disables it).
338	* Use ~(uint64_t)0 if it should never stop. */
339	uint64_t iHitDisable;
340	/** The Flat GC address of the breakpoint.
341	* (PC register value if REM type?) */
342	RTGCUINTPTR GCPtr;
343	/** The breakpoint id. */
344	uint32_t iBp;
345	/** The breakpoint status - enabled or disabled. */
346	bool fEnabled;
347
348	/** The breakpoint type. */
349	DBGFBPTYPE enmType;
350
351	#if GC_ARCH_BITS == 64
352	uint32_t u32Padding;
353	#endif
354
355	/** Union of type specific data. */
356	union
357	{
358	/** Debug register data. */
359	struct DBGFBPREG
360	{
361	/** The debug register number. */
362	uint8_t iReg;
363	/** The access type (one of the X86_DR7_RW_* value). */
364	uint8_t fType;
365	/** The access size. */
366	uint8_t cb;
367	} Reg;
368	/** Recompiler breakpoint data. */
369	struct DBGFBPINT3
370	{
371	/** The byte value we replaced by the INT 3 instruction. */
372	uint8_t bOrg;
373	} Int3;
374
375	/** Recompiler breakpoint data. */
376	struct DBGFBPREM
377	{
378	/** nothing yet */
379	uint8_t fDummy;
380	} Rem;
381	/** Paddind to ensure that the size is identical on win32 and linux. */
382	uint64_t u64Padding;
383	} u;
384	} DBGFBP;
385
386	/** Pointer to a breakpoint. */
387	typedef DBGFBP *PDBGFBP;
388	/** Pointer to a const breakpoint. */
389	typedef const DBGFBP *PCDBGFBP;
390
391	#ifdef IN_RING3 /* The breakpoint management API is only available in ring-3. */
392	VMMR3DECL(int) DBGFR3BpSet(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
393	VMMR3DECL(int) DBGFR3BpSetReg(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable,
394	uint8_t fType, uint8_t cb, uint32_t *piBp);
395	VMMR3DECL(int) DBGFR3BpSetREM(PUVM pUVM, PCDBGFADDRESS pAddress, uint64_t iHitTrigger, uint64_t iHitDisable, uint32_t *piBp);
396	VMMR3DECL(int) DBGFR3BpClear(PUVM pUVM, uint32_t iBp);
397	VMMR3DECL(int) DBGFR3BpEnable(PUVM pUVM, uint32_t iBp);
398	VMMR3DECL(int) DBGFR3BpDisable(PUVM pUVM, uint32_t iBp);
399
400	/**
401	* Breakpoint enumeration callback function.
402	*
403	* @returns VBox status code. Any failure will stop the enumeration.
404	* @param pUVM The user mode VM handle.
405	* @param pvUser The user argument.
406	* @param pBp Pointer to the breakpoint information. (readonly)
407	*/
408	typedef DECLCALLBACK(int) FNDBGFBPENUM(PUVM pUVM, void *pvUser, PCDBGFBP pBp);
409	/** Pointer to a breakpoint enumeration callback function. */
410	typedef FNDBGFBPENUM *PFNDBGFBPENUM;
411
412	VMMR3DECL(int) DBGFR3BpEnum(PUVM pUVM, PFNDBGFBPENUM pfnCallback, void *pvUser);
413	#endif /* IN_RING3 */
414
415	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR7(PVM pVM);
416	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR0(PVM pVM);
417	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR1(PVM pVM);
418	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR2(PVM pVM);
419	VMM_INT_DECL(RTGCUINTREG) DBGFBpGetDR3(PVM pVM);
420	VMM_INT_DECL(bool) DBGFBpIsHwArmed(PVM pVM);
421	VMM_INT_DECL(bool) DBGFIsStepping(PVMCPU pVCpu);
422
423
424	#ifdef IN_RING3 /* The CPU mode API only works in ring-3. */
425	VMMR3DECL(CPUMMODE) DBGFR3CpuGetMode(PUVM pUVM, VMCPUID idCpu);
426	VMMR3DECL(VMCPUID) DBGFR3CpuGetCount(PUVM pUVM);
427	VMMR3DECL(bool) DBGFR3CpuIsIn64BitCode(PUVM pUVM, VMCPUID idCpu);
428	#endif
429
430
431
432	#ifdef IN_RING3 /* The info callbacks API only works in ring-3. */
433
434	/**
435	* Info helper callback structure.
436	*/
437	typedef struct DBGFINFOHLP
438	{
439	/**
440	* Print formatted string.
441	*
442	* @param pHlp Pointer to this structure.
443	* @param pszFormat The format string.
444	* @param ... Arguments.
445	*/
446	DECLCALLBACKMEMBER(void, pfnPrintf)(PCDBGFINFOHLP pHlp, const char *pszFormat, ...);
447
448	/**
449	* Print formatted string.
450	*
451	* @param pHlp Pointer to this structure.
452	* @param pszFormat The format string.
453	* @param args Argument list.
454	*/
455	DECLCALLBACKMEMBER(void, pfnPrintfV)(PCDBGFINFOHLP pHlp, const char *pszFormat, va_list args);
456	} DBGFINFOHLP;
457
458
459	/**
460	* Info handler, device version.
461	*
462	* @param pDevIns The device instance which registered the info.
463	* @param pHlp Callback functions for doing output.
464	* @param pszArgs Argument string. Optional and specific to the handler.
465	*/
466	typedef DECLCALLBACK(void) FNDBGFHANDLERDEV(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs);
467	/** Pointer to a FNDBGFHANDLERDEV function. */
468	typedef FNDBGFHANDLERDEV *PFNDBGFHANDLERDEV;
469
470	/**
471	* Info handler, USB device version.
472	*
473	* @param pUsbIns The USB device instance which registered the info.
474	* @param pHlp Callback functions for doing output.
475	* @param pszArgs Argument string. Optional and specific to the handler.
476	*/
477	typedef DECLCALLBACK(void) FNDBGFHANDLERUSB(PPDMUSBINS pUsbIns, PCDBGFINFOHLP pHlp, const char *pszArgs);
478	/** Pointer to a FNDBGFHANDLERUSB function. */
479	typedef FNDBGFHANDLERUSB *PFNDBGFHANDLERUSB;
480
481	/**
482	* Info handler, driver version.
483	*
484	* @param pDrvIns The driver instance which registered the info.
485	* @param pHlp Callback functions for doing output.
486	* @param pszArgs Argument string. Optional and specific to the handler.
487	*/
488	typedef DECLCALLBACK(void) FNDBGFHANDLERDRV(PPDMDRVINS pDrvIns, PCDBGFINFOHLP pHlp, const char *pszArgs);
489	/** Pointer to a FNDBGFHANDLERDRV function. */
490	typedef FNDBGFHANDLERDRV *PFNDBGFHANDLERDRV;
491
492	/**
493	* Info handler, internal version.
494	*
495	* @param pVM The VM handle.
496	* @param pHlp Callback functions for doing output.
497	* @param pszArgs Argument string. Optional and specific to the handler.
498	*/
499	typedef DECLCALLBACK(void) FNDBGFHANDLERINT(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
500	/** Pointer to a FNDBGFHANDLERINT function. */
501	typedef FNDBGFHANDLERINT *PFNDBGFHANDLERINT;
502
503	/**
504	* Info handler, external version.
505	*
506	* @param pvUser User argument.
507	* @param pHlp Callback functions for doing output.
508	* @param pszArgs Argument string. Optional and specific to the handler.
509	*/
510	typedef DECLCALLBACK(void) FNDBGFHANDLEREXT(void pvUser, PCDBGFINFOHLP pHlp, const char pszArgs);
511	/** Pointer to a FNDBGFHANDLEREXT function. */
512	typedef FNDBGFHANDLEREXT *PFNDBGFHANDLEREXT;
513
514
515	/** @name Flags for the info registration functions.
516	* @{ */
517	/** The handler must run on the EMT. */
518	#define DBGFINFO_FLAGS_RUN_ON_EMT RT_BIT(0)
519	/** @} */
520
521	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDevice(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERDEV pfnHandler, PPDMDEVINS pDevIns);
522	VMMR3_INT_DECL(int) DBGFR3InfoRegisterDriver(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler, PPDMDRVINS pDrvIns);
523	VMMR3_INT_DECL(int) DBGFR3InfoRegisterInternal(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERINT pfnHandler);
524	VMMR3_INT_DECL(int) DBGFR3InfoRegisterInternalEx(PVM pVM, const char pszName, const char pszDesc, PFNDBGFHANDLERINT pfnHandler, uint32_t fFlags);
525	VMMR3DECL(int) DBGFR3InfoRegisterExternal(PUVM pUVM, const char pszName, const char pszDesc, PFNDBGFHANDLEREXT pfnHandler, void *pvUser);
526	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterDevice(PVM pVM, PPDMDEVINS pDevIns, const char *pszName);
527	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterDriver(PVM pVM, PPDMDRVINS pDrvIns, const char *pszName);
528	VMMR3_INT_DECL(int) DBGFR3InfoDeregisterInternal(PVM pVM, const char *pszName);
529	VMMR3DECL(int) DBGFR3InfoDeregisterExternal(PUVM pUVM, const char *pszName);
530	VMMR3DECL(int) DBGFR3Info(PUVM pUVM, const char pszName, const char pszArgs, PCDBGFINFOHLP pHlp);
531	VMMR3DECL(int) DBGFR3InfoEx(PUVM pUVM, VMCPUID idCpu, const char pszName, const char pszArgs, PCDBGFINFOHLP pHlp);
532	VMMR3DECL(int) DBGFR3InfoLogRel(PUVM pUVM, const char pszName, const char pszArgs);
533	VMMR3DECL(int) DBGFR3InfoStdErr(PUVM pUVM, const char pszName, const char pszArgs);
534	VMMR3_INT_DECL(int) DBGFR3InfoMulti(PVM pVM, const char pszIncludePat, const char pszExcludePat,
535	const char *pszSepFmt, PCDBGFINFOHLP pHlp);
536
537	/** @def DBGFR3InfoLog
538	* Display a piece of info writing to the log if enabled.
539	*
540	* @param a_pVM The shared VM handle.
541	* @param a_pszName The identifier of the info to display.
542	* @param a_pszArgs Arguments to the info handler.
543	*/
544	#ifdef LOG_ENABLED
545	# define DBGFR3_INFO_LOG(a_pVM, a_pszName, a_pszArgs) \
546	do { \
547	if (LogIsEnabled()) \
548	DBGFR3Info((a_pVM)->pUVM, a_pszName, a_pszArgs, NULL); \
549	} while (0)
550	#else
551	# define DBGFR3_INFO_LOG(a_pVM, a_pszName, a_pszArgs) do { } while (0)
552	#endif
553
554	/**
555	* Enumeration callback for use with DBGFR3InfoEnum.
556	*
557	* @returns VBox status code.
558	* A status code indicating failure will end the enumeration
559	* and DBGFR3InfoEnum will return with that status code.
560	* @param pUVM The user mode VM handle.
561	* @param pszName Info identifier name.
562	* @param pszDesc The description.
563	*/
564	typedef DECLCALLBACK(int) FNDBGFINFOENUM(PUVM pUVM, const char pszName, const char pszDesc, void *pvUser);
565	/** Pointer to a FNDBGFINFOENUM function. */
566	typedef FNDBGFINFOENUM *PFNDBGFINFOENUM;
567
568	VMMR3DECL(int) DBGFR3InfoEnum(PUVM pUVM, PFNDBGFINFOENUM pfnCallback, void *pvUser);
569	VMMR3DECL(PCDBGFINFOHLP) DBGFR3InfoLogHlp(void);
570	VMMR3DECL(PCDBGFINFOHLP) DBGFR3InfoLogRelHlp(void);
571
572	#endif /* IN_RING3 */
573
574
575	#ifdef IN_RING3 /* The log contrl API only works in ring-3. */
576	VMMR3DECL(int) DBGFR3LogModifyGroups(PUVM pUVM, const char *pszGroupSettings);
577	VMMR3DECL(int) DBGFR3LogModifyFlags(PUVM pUVM, const char *pszFlagSettings);
578	VMMR3DECL(int) DBGFR3LogModifyDestinations(PUVM pUVM, const char *pszDestSettings);
579	#endif /* IN_RING3 */
580
581	#ifdef IN_RING3 /* The debug information management APIs only works in ring-3. */
582
583	/** Max length (including '\\0') of a symbol name. */
584	#define DBGF_SYMBOL_NAME_LENGTH 512
585
586	/**
587	* Debug symbol.
588	*/
589	typedef struct DBGFSYMBOL
590	{
591	/** Symbol value (address). */
592	RTGCUINTPTR Value;
593	/** Symbol size. */
594	uint32_t cb;
595	/** Symbol Flags. (reserved). */
596	uint32_t fFlags;
597	/** Symbol name. */
598	char szName[DBGF_SYMBOL_NAME_LENGTH];
599	} DBGFSYMBOL;
600	/** Pointer to debug symbol. */
601	typedef DBGFSYMBOL *PDBGFSYMBOL;
602	/** Pointer to const debug symbol. */
603	typedef const DBGFSYMBOL *PCDBGFSYMBOL;
604
605	/**
606	* Debug line number information.
607	*/
608	typedef struct DBGFLINE
609	{
610	/** Address. */
611	RTGCUINTPTR Address;
612	/** Line number. */
613	uint32_t uLineNo;
614	/** Filename. */
615	char szFilename[260];
616	} DBGFLINE;
617	/** Pointer to debug line number. */
618	typedef DBGFLINE *PDBGFLINE;
619	/** Pointer to const debug line number. */
620	typedef const DBGFLINE *PCDBGFLINE;
621
622	/** @name Address spaces aliases.
623	* @{ */
624	/** The guest global address space. */
625	#define DBGF_AS_GLOBAL ((RTDBGAS)-1)
626	/** The guest kernel address space.
627	* This is usually resolves to the same as DBGF_AS_GLOBAL. */
628	#define DBGF_AS_KERNEL ((RTDBGAS)-2)
629	/** The physical address space. */
630	#define DBGF_AS_PHYS ((RTDBGAS)-3)
631	/** Raw-mode context. */
632	#define DBGF_AS_RC ((RTDBGAS)-4)
633	/** Ring-0 context. */
634	#define DBGF_AS_R0 ((RTDBGAS)-5)
635	/** Raw-mode context and then global guest context.
636	* When used for looking up information, it works as if the call was first made
637	* with DBGF_AS_RC and then on failure with DBGF_AS_GLOBAL. When called for
638	* making address space changes, it works as if DBGF_AS_RC was used. */
639	#define DBGF_AS_RC_AND_GC_GLOBAL ((RTDBGAS)-6)
640
641	/** The first special one. */
642	#define DBGF_AS_FIRST DBGF_AS_RC_AND_GC_GLOBAL
643	/** The last special one. */
644	#define DBGF_AS_LAST DBGF_AS_GLOBAL
645	#endif
646	/** The number of special address space handles. */
647	#define DBGF_AS_COUNT (6U)
648	#ifdef IN_RING3
649	/** Converts an alias handle to an array index. */
650	#define DBGF_AS_ALIAS_2_INDEX(hAlias) \
651	( (uintptr_t)(hAlias) - (uintptr_t)DBGF_AS_FIRST )
652	/** Predicat macro that check if the specified handle is an alias. */
653	#define DBGF_AS_IS_ALIAS(hAlias) \
654	( DBGF_AS_ALIAS_2_INDEX(hAlias) < DBGF_AS_COUNT )
655	/** Predicat macro that check if the specified alias is a fixed one or not. */
656	#define DBGF_AS_IS_FIXED_ALIAS(hAlias) \
657	( DBGF_AS_ALIAS_2_INDEX(hAlias) < (uintptr_t)DBGF_AS_PHYS - (uintptr_t)DBGF_AS_FIRST + 1U )
658
659	/** @} */
660
661	VMMR3DECL(RTDBGCFG) DBGFR3AsGetConfig(PUVM pUVM);
662
663	VMMR3DECL(int) DBGFR3AsAdd(PUVM pUVM, RTDBGAS hDbgAs, RTPROCESS ProcId);
664	VMMR3DECL(int) DBGFR3AsDelete(PUVM pUVM, RTDBGAS hDbgAs);
665	VMMR3DECL(int) DBGFR3AsSetAlias(PUVM pUVM, RTDBGAS hAlias, RTDBGAS hAliasFor);
666	VMMR3DECL(RTDBGAS) DBGFR3AsResolve(PUVM pUVM, RTDBGAS hAlias);
667	VMMR3DECL(RTDBGAS) DBGFR3AsResolveAndRetain(PUVM pUVM, RTDBGAS hAlias);
668	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByName(PUVM pUVM, const char *pszName);
669	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByPid(PUVM pUVM, RTPROCESS ProcId);
670
671	VMMR3DECL(int) DBGFR3AsLoadImage(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags);
672	VMMR3DECL(int) DBGFR3AsLoadMap(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, RTGCUINTPTR uSubtrahend, uint32_t fFlags);
673	VMMR3DECL(int) DBGFR3AsLinkModule(PUVM pUVM, RTDBGAS hDbgAs, RTDBGMOD hMod, PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags);
674
675	VMMR3DECL(int) DBGFR3AsSymbolByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
676	PRTGCINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
677	VMMR3DECL(PRTDBGSYMBOL) DBGFR3AsSymbolByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t Flags,
678	PRTGCINTPTR poffDisp, PRTDBGMOD phMod);
679	VMMR3DECL(int) DBGFR3AsSymbolByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod);
680
681	VMMR3DECL(int) DBGFR3AsLineByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
682	PRTGCINTPTR poffDisp, PRTDBGLINE pLine, PRTDBGMOD phMod);
683	VMMR3DECL(PRTDBGLINE) DBGFR3AsLineByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
684	PRTGCINTPTR poffDisp, PRTDBGMOD phMod);
685
686	#endif /* IN_RING3 */
687
688	#ifdef IN_RING3 /* The stack API only works in ring-3. */
689
690	/**
691	* Return type.
692	*/
693	typedef enum DBGFRETRUNTYPE
694	{
695	/** The usual invalid 0 value. */
696	DBGFRETURNTYPE_INVALID = 0,
697	/** Near 16-bit return. */
698	DBGFRETURNTYPE_NEAR16,
699	/** Near 32-bit return. */
700	DBGFRETURNTYPE_NEAR32,
701	/** Near 64-bit return. */
702	DBGFRETURNTYPE_NEAR64,
703	/** Far 16:16 return. */
704	DBGFRETURNTYPE_FAR16,
705	/** Far 16:32 return. */
706	DBGFRETURNTYPE_FAR32,
707	/** Far 16:64 return. */
708	DBGFRETURNTYPE_FAR64,
709	/** 16-bit iret return (e.g. real or 286 protect mode). */
710	DBGFRETURNTYPE_IRET16,
711	/** 32-bit iret return. */
712	DBGFRETURNTYPE_IRET32,
713	/** 32-bit iret return. */
714	DBGFRETURNTYPE_IRET32_PRIV,
715	/** 32-bit iret return to V86 mode. */
716	DBGFRETURNTYPE_IRET32_V86,
717	/** @todo 64-bit iret return. */
718	DBGFRETURNTYPE_IRET64,
719	/** The end of the valid return types. */
720	DBGFRETURNTYPE_END,
721	/** The usual 32-bit blowup. */
722	DBGFRETURNTYPE_32BIT_HACK = 0x7fffffff
723	} DBGFRETURNTYPE;
724
725	/**
726	* Figures the size of the return state on the stack.
727	*
728	* @returns number of bytes. 0 if invalid parameter.
729	* @param enmRetType The type of return.
730	*/
731	DECLINLINE(unsigned) DBGFReturnTypeSize(DBGFRETURNTYPE enmRetType)
732	{
733	switch (enmRetType)
734	{
735	case DBGFRETURNTYPE_NEAR16: return 2;
736	case DBGFRETURNTYPE_NEAR32: return 4;
737	case DBGFRETURNTYPE_NEAR64: return 8;
738	case DBGFRETURNTYPE_FAR16: return 4;
739	case DBGFRETURNTYPE_FAR32: return 4;
740	case DBGFRETURNTYPE_FAR64: return 8;
741	case DBGFRETURNTYPE_IRET16: return 6;
742	case DBGFRETURNTYPE_IRET32: return 4*3;
743	case DBGFRETURNTYPE_IRET32_PRIV: return 4*5;
744	case DBGFRETURNTYPE_IRET32_V86: return 4*9;
745	case DBGFRETURNTYPE_IRET64:
746	default:
747	return 0;
748	}
749	}
750
751
752	/** Pointer to stack frame info. */
753	typedef struct DBGFSTACKFRAME *PDBGFSTACKFRAME;
754	/** Pointer to const stack frame info. */
755	typedef struct DBGFSTACKFRAME const *PCDBGFSTACKFRAME;
756	/**
757	* Info about a stack frame.
758	*/
759	typedef struct DBGFSTACKFRAME
760	{
761	/** Frame number. */
762	uint32_t iFrame;
763	/** Frame flags. */
764	uint32_t fFlags;
765	/** The frame address.
766	* The off member is [e\|r]bp and the Sel member is ss. */
767	DBGFADDRESS AddrFrame;
768	/** The stack address of the frame.
769	* The off member is [e\|r]sp and the Sel member is ss. */
770	DBGFADDRESS AddrStack;
771	/** The program counter (PC) address of the frame.
772	* The off member is [e\|r]ip and the Sel member is cs. */
773	DBGFADDRESS AddrPC;
774	/** Pointer to the symbol nearest the program counter (PC). NULL if not found. */
775	PRTDBGSYMBOL pSymPC;
776	/** Pointer to the linnumber nearest the program counter (PC). NULL if not found. */
777	PRTDBGLINE pLinePC;
778
779	/** The return frame address.
780	* The off member is [e\|r]bp and the Sel member is ss. */
781	DBGFADDRESS AddrReturnFrame;
782	/** The return stack address.
783	* The off member is [e\|r]sp and the Sel member is ss. */
784	DBGFADDRESS AddrReturnStack;
785	/** The way this frame returns to the next one. */
786	DBGFRETURNTYPE enmReturnType;
787
788	/** The program counter (PC) address which the frame returns to.
789	* The off member is [e\|r]ip and the Sel member is cs. */
790	DBGFADDRESS AddrReturnPC;
791	/** Pointer to the symbol nearest the return PC. NULL if not found. */
792	PRTDBGSYMBOL pSymReturnPC;
793	/** Pointer to the linnumber nearest the return PC. NULL if not found. */
794	PRTDBGLINE pLineReturnPC;
795
796	/** 32-bytes of stack arguments. */
797	union
798	{
799	/** 64-bit view */
800	uint64_t au64[4];
801	/** 32-bit view */
802	uint32_t au32[8];
803	/** 16-bit view */
804	uint16_t au16[16];
805	/** 8-bit view */
806	uint8_t au8[32];
807	} Args;
808
809	/** Pointer to the next frame.
810	* Might not be used in some cases, so consider it internal. */
811	PCDBGFSTACKFRAME pNextInternal;
812	/** Pointer to the first frame.
813	* Might not be used in some cases, so consider it internal. */
814	PCDBGFSTACKFRAME pFirstInternal;
815	} DBGFSTACKFRAME;
816
817	/** @name DBGFSTACKFRAME Flags.
818	* @{ */
819	/** Set if the content of the frame is filled in by DBGFR3StackWalk() and can be used
820	* to construct the next frame. */
821	# define DBGFSTACKFRAME_FLAGS_ALL_VALID RT_BIT(0)
822	/** This is the last stack frame we can read.
823	* This flag is not set if the walk stop because of max dept or recursion. */
824	# define DBGFSTACKFRAME_FLAGS_LAST RT_BIT(1)
825	/** This is the last record because we detected a loop. */
826	# define DBGFSTACKFRAME_FLAGS_LOOP RT_BIT(2)
827	/** This is the last record because we reached the maximum depth. */
828	# define DBGFSTACKFRAME_FLAGS_MAX_DEPTH RT_BIT(3)
829	/** 16-bit frame. */
830	# define DBGFSTACKFRAME_FLAGS_16BIT RT_BIT(4)
831	/** 32-bit frame. */
832	# define DBGFSTACKFRAME_FLAGS_32BIT RT_BIT(5)
833	/** 64-bit frame. */
834	# define DBGFSTACKFRAME_FLAGS_64BIT RT_BIT(6)
835	/** @} */
836
837	/** @name DBGFCODETYPE
838	* @{ */
839	typedef enum DBGFCODETYPE
840	{
841	/** The usual invalid 0 value. */
842	DBGFCODETYPE_INVALID = 0,
843	/** Stack walk for guest code. */
844	DBGFCODETYPE_GUEST,
845	/** Stack walk for hypervisor code. */
846	DBGFCODETYPE_HYPER,
847	/** Stack walk for ring 0 code. */
848	DBGFCODETYPE_RING0,
849	/** The usual 32-bit blowup. */
850	DBGFCODETYPE_32BIT_HACK = 0x7fffffff
851	} DBGFCODETYPE;
852	/** @} */
853
854	VMMR3DECL(int) DBGFR3StackWalkBegin(PUVM pUVM, VMCPUID idCpu, DBGFCODETYPE enmCodeType,
855	PCDBGFSTACKFRAME *ppFirstFrame);
856	VMMR3DECL(int) DBGFR3StackWalkBeginEx(PUVM pUVM, VMCPUID idCpu, DBGFCODETYPE enmCodeType, PCDBGFADDRESS pAddrFrame,
857	PCDBGFADDRESS pAddrStack,PCDBGFADDRESS pAddrPC,
858	DBGFRETURNTYPE enmReturnType, PCDBGFSTACKFRAME *ppFirstFrame);
859	VMMR3DECL(PCDBGFSTACKFRAME) DBGFR3StackWalkNext(PCDBGFSTACKFRAME pCurrent);
860	VMMR3DECL(void) DBGFR3StackWalkEnd(PCDBGFSTACKFRAME pFirstFrame);
861
862	#endif /* IN_RING3 */
863
864
865	#ifdef IN_RING3 /* The disassembly API only works in ring-3. */
866
867	/** Flags to pass to DBGFR3DisasInstrEx().
868	* @{ */
869	/** Disassemble the current guest instruction, with annotations. */
870	#define DBGF_DISAS_FLAGS_CURRENT_GUEST RT_BIT(0)
871	/** Disassemble the current hypervisor instruction, with annotations. */
872	#define DBGF_DISAS_FLAGS_CURRENT_HYPER RT_BIT(1)
873	/** No annotations for current context. */
874	#define DBGF_DISAS_FLAGS_NO_ANNOTATION RT_BIT(2)
875	/** No symbol lookup. */
876	#define DBGF_DISAS_FLAGS_NO_SYMBOLS RT_BIT(3)
877	/** No instruction bytes. */
878	#define DBGF_DISAS_FLAGS_NO_BYTES RT_BIT(4)
879	/** No address in the output. */
880	#define DBGF_DISAS_FLAGS_NO_ADDRESS RT_BIT(5)
881	/** Probably a hypervisor instruction. */
882	#define DBGF_DISAS_FLAGS_HYPER RT_BIT(6)
883	/** Disassemble original unpatched bytes (PATM). */
884	#define DBGF_DISAS_FLAGS_UNPATCHED_BYTES RT_BIT(7)
885	/** Annotate patched instructions. */
886	#define DBGF_DISAS_FLAGS_ANNOTATE_PATCHED RT_BIT(8)
887	/** Disassemble in the default mode of the specific context. */
888	#define DBGF_DISAS_FLAGS_DEFAULT_MODE UINT32_C(0x00000000)
889	/** Disassemble in 16-bit mode. */
890	#define DBGF_DISAS_FLAGS_16BIT_MODE UINT32_C(0x10000000)
891	/** Disassemble in 16-bit mode with real mode address translation. */
892	#define DBGF_DISAS_FLAGS_16BIT_REAL_MODE UINT32_C(0x20000000)
893	/** Disassemble in 32-bit mode. */
894	#define DBGF_DISAS_FLAGS_32BIT_MODE UINT32_C(0x30000000)
895	/** Disassemble in 64-bit mode. */
896	#define DBGF_DISAS_FLAGS_64BIT_MODE UINT32_C(0x40000000)
897	/** The disassembly mode mask. */
898	#define DBGF_DISAS_FLAGS_MODE_MASK UINT32_C(0x70000000)
899	/** Mask containing the valid flags. */
900	#define DBGF_DISAS_FLAGS_VALID_MASK UINT32_C(0x700001ff)
901	/** @} */
902
903	/** Special flat selector. */
904	#define DBGF_SEL_FLAT 1
905
906	VMMR3DECL(int) DBGFR3DisasInstrEx(PUVM pUVM, VMCPUID idCpu, RTSEL Sel, RTGCPTR GCPtr, uint32_t fFlags,
907	char pszOutput, uint32_t cbOutput, uint32_t pcbInstr);
908	VMMR3_INT_DECL(int) DBGFR3DisasInstrCurrent(PVMCPU pVCpu, char *pszOutput, uint32_t cbOutput);
909	VMMR3DECL(int) DBGFR3DisasInstrCurrentLogInternal(PVMCPU pVCpu, const char *pszPrefix);
910
911	/** @def DBGFR3DisasInstrCurrentLog
912	* Disassembles the current guest context instruction and writes it to the log.
913	* All registers and data will be displayed. Addresses will be attempted resolved to symbols.
914	*/
915	#ifdef LOG_ENABLED
916	# define DBGFR3_DISAS_INSTR_CUR_LOG(pVCpu, pszPrefix) \
917	do { \
918	if (LogIsEnabled()) \
919	DBGFR3DisasInstrCurrentLogInternal(pVCpu, pszPrefix); \
920	} while (0)
921	#else
922	# define DBGFR3_DISAS_INSTR_CUR_LOG(pVCpu, pszPrefix) do { } while (0)
923	#endif
924
925	VMMR3DECL(int) DBGFR3DisasInstrLogInternal(PVMCPU pVCpu, RTSEL Sel, RTGCPTR GCPtr, const char *pszPrefix);
926
927	/** @def DBGFR3DisasInstrLog
928	* Disassembles the specified guest context instruction and writes it to the log.
929	* Addresses will be attempted resolved to symbols.
930	* @thread Any EMT.
931	*/
932	# ifdef LOG_ENABLED
933	# define DBGFR3_DISAS_INSTR_LOG(pVCpu, Sel, GCPtr, pszPrefix) \
934	do { \
935	if (LogIsEnabled()) \
936	DBGFR3DisasInstrLogInternal(pVCpu, Sel, GCPtr, pszPrefix); \
937	} while (0)
938	# else
939	# define DBGFR3_DISAS_INSTR_LOG(pVCpu, Sel, GCPtr, pszPrefix) do { } while (0)
940	# endif
941	#endif
942
943
944	#ifdef IN_RING3
945	VMMR3DECL(int) DBGFR3MemScan(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, RTGCUINTPTR cbRange, RTGCUINTPTR uAlign,
946	const void *pvNeedle, size_t cbNeedle, PDBGFADDRESS pHitAddress);
947	VMMR3DECL(int) DBGFR3MemRead(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, void *pvBuf, size_t cbRead);
948	VMMR3DECL(int) DBGFR3MemReadString(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, char *pszBuf, size_t cbBuf);
949	VMMR3DECL(int) DBGFR3MemWrite(PUVM pUVM, VMCPUID idCpu, PCDBGFADDRESS pAddress, void const *pvBuf, size_t cbRead);
950	#endif
951
952
953	/** @name Flags for DBGFR3PagingDumpEx, PGMR3DumpHierarchyHCEx and
954	* PGMR3DumpHierarchyGCEx
955	* @{ */
956	/** The CR3 from the current CPU state. */
957	#define DBGFPGDMP_FLAGS_CURRENT_CR3 RT_BIT_32(0)
958	/** The current CPU paging mode (PSE, PAE, LM, EPT, NX). */
959	#define DBGFPGDMP_FLAGS_CURRENT_MODE RT_BIT_32(1)
960	/** Whether PSE is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
961	* Same value as X86_CR4_PSE. */
962	#define DBGFPGDMP_FLAGS_PSE RT_BIT_32(4) /* */
963	/** Whether PAE is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
964	* Same value as X86_CR4_PAE. */
965	#define DBGFPGDMP_FLAGS_PAE RT_BIT_32(5) /* */
966	/** Whether LME is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
967	* Same value as MSR_K6_EFER_LME. */
968	#define DBGFPGDMP_FLAGS_LME RT_BIT_32(8)
969	/** Whether nested paging is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE). */
970	#define DBGFPGDMP_FLAGS_NP RT_BIT_32(9)
971	/** Whether extended nested page tables are enabled
972	* (!DBGFPGDMP_FLAGS_CURRENT_STATE). */
973	#define DBGFPGDMP_FLAGS_EPT RT_BIT_32(10)
974	/** Whether no-execution is enabled (!DBGFPGDMP_FLAGS_CURRENT_STATE).
975	* Same value as MSR_K6_EFER_NXE. */
976	#define DBGFPGDMP_FLAGS_NXE RT_BIT_32(11)
977	/** Whether to print the CR3. */
978	#define DBGFPGDMP_FLAGS_PRINT_CR3 RT_BIT_32(27)
979	/** Whether to print the header. */
980	#define DBGFPGDMP_FLAGS_HEADER RT_BIT_32(28)
981	/** Whether to dump additional page information. */
982	#define DBGFPGDMP_FLAGS_PAGE_INFO RT_BIT_32(29)
983	/** Dump the shadow tables if set.
984	* Cannot be used together with DBGFPGDMP_FLAGS_GUEST. */
985	#define DBGFPGDMP_FLAGS_SHADOW RT_BIT_32(30)
986	/** Dump the guest tables if set.
987	* Cannot be used together with DBGFPGDMP_FLAGS_SHADOW. */
988	#define DBGFPGDMP_FLAGS_GUEST RT_BIT_32(31)
989	/** Mask of valid bits. */
990	#define DBGFPGDMP_FLAGS_VALID_MASK UINT32_C(0xf8000f33)
991	/** The mask of bits controlling the paging mode. */
992	#define DBGFPGDMP_FLAGS_MODE_MASK UINT32_C(0x00000f32)
993	/** @} */
994	VMMDECL(int) DBGFR3PagingDumpEx(PUVM pUVM, VMCPUID idCpu, uint32_t fFlags, uint64_t cr3, uint64_t u64FirstAddr,
995	uint64_t u64LastAddr, uint32_t cMaxDepth, PCDBGFINFOHLP pHlp);
996
997
998	/** @name DBGFR3SelQueryInfo flags.
999	* @{ */
1000	/** Get the info from the guest descriptor table. */
1001	#define DBGFSELQI_FLAGS_DT_GUEST UINT32_C(0)
1002	/** Get the info from the shadow descriptor table.
1003	* Only works in raw-mode. */
1004	#define DBGFSELQI_FLAGS_DT_SHADOW UINT32_C(1)
1005	/** If currently executing in in 64-bit mode, blow up data selectors. */
1006	#define DBGFSELQI_FLAGS_DT_ADJ_64BIT_MODE UINT32_C(2)
1007	/** @} */
1008	VMMR3DECL(int) DBGFR3SelQueryInfo(PUVM pUVM, VMCPUID idCpu, RTSEL Sel, uint32_t fFlags, PDBGFSELINFO pSelInfo);
1009
1010
1011	/**
1012	* Register identifiers.
1013	*/
1014	typedef enum DBGFREG
1015	{
1016	/* General purpose registers: */
1017	DBGFREG_AL = 0,
1018	DBGFREG_AX = DBGFREG_AL,
1019	DBGFREG_EAX = DBGFREG_AL,
1020	DBGFREG_RAX = DBGFREG_AL,
1021
1022	DBGFREG_CL,
1023	DBGFREG_CX = DBGFREG_CL,
1024	DBGFREG_ECX = DBGFREG_CL,
1025	DBGFREG_RCX = DBGFREG_CL,
1026
1027	DBGFREG_DL,
1028	DBGFREG_DX = DBGFREG_DL,
1029	DBGFREG_EDX = DBGFREG_DL,
1030	DBGFREG_RDX = DBGFREG_DL,
1031
1032	DBGFREG_BL,
1033	DBGFREG_BX = DBGFREG_BL,
1034	DBGFREG_EBX = DBGFREG_BL,
1035	DBGFREG_RBX = DBGFREG_BL,
1036
1037	DBGFREG_SPL,
1038	DBGFREG_SP = DBGFREG_SPL,
1039	DBGFREG_ESP = DBGFREG_SPL,
1040	DBGFREG_RSP = DBGFREG_SPL,
1041
1042	DBGFREG_BPL,
1043	DBGFREG_BP = DBGFREG_BPL,
1044	DBGFREG_EBP = DBGFREG_BPL,
1045	DBGFREG_RBP = DBGFREG_BPL,
1046
1047	DBGFREG_SIL,
1048	DBGFREG_SI = DBGFREG_SIL,
1049	DBGFREG_ESI = DBGFREG_SIL,
1050	DBGFREG_RSI = DBGFREG_SIL,
1051
1052	DBGFREG_DIL,
1053	DBGFREG_DI = DBGFREG_DIL,
1054	DBGFREG_EDI = DBGFREG_DIL,
1055	DBGFREG_RDI = DBGFREG_DIL,
1056
1057	DBGFREG_R8,
1058	DBGFREG_R8B = DBGFREG_R8,
1059	DBGFREG_R8W = DBGFREG_R8,
1060	DBGFREG_R8D = DBGFREG_R8,
1061
1062	DBGFREG_R9,
1063	DBGFREG_R9B = DBGFREG_R9,
1064	DBGFREG_R9W = DBGFREG_R9,
1065	DBGFREG_R9D = DBGFREG_R9,
1066
1067	DBGFREG_R10,
1068	DBGFREG_R10B = DBGFREG_R10,
1069	DBGFREG_R10W = DBGFREG_R10,
1070	DBGFREG_R10D = DBGFREG_R10,
1071
1072	DBGFREG_R11,
1073	DBGFREG_R11B = DBGFREG_R11,
1074	DBGFREG_R11W = DBGFREG_R11,
1075	DBGFREG_R11D = DBGFREG_R11,
1076
1077	DBGFREG_R12,
1078	DBGFREG_R12B = DBGFREG_R12,
1079	DBGFREG_R12W = DBGFREG_R12,
1080	DBGFREG_R12D = DBGFREG_R12,
1081
1082	DBGFREG_R13,
1083	DBGFREG_R13B = DBGFREG_R13,
1084	DBGFREG_R13W = DBGFREG_R13,
1085	DBGFREG_R13D = DBGFREG_R13,
1086
1087	DBGFREG_R14,
1088	DBGFREG_R14B = DBGFREG_R14,
1089	DBGFREG_R14W = DBGFREG_R14,
1090	DBGFREG_R14D = DBGFREG_R14,
1091
1092	DBGFREG_R15,
1093	DBGFREG_R15B = DBGFREG_R15,
1094	DBGFREG_R15W = DBGFREG_R15,
1095	DBGFREG_R15D = DBGFREG_R15,
1096
1097	/* Segments and other special registers: */
1098	DBGFREG_CS,
1099	DBGFREG_CS_ATTR,
1100	DBGFREG_CS_BASE,
1101	DBGFREG_CS_LIMIT,
1102
1103	DBGFREG_DS,
1104	DBGFREG_DS_ATTR,
1105	DBGFREG_DS_BASE,
1106	DBGFREG_DS_LIMIT,
1107
1108	DBGFREG_ES,
1109	DBGFREG_ES_ATTR,
1110	DBGFREG_ES_BASE,
1111	DBGFREG_ES_LIMIT,
1112
1113	DBGFREG_FS,
1114	DBGFREG_FS_ATTR,
1115	DBGFREG_FS_BASE,
1116	DBGFREG_FS_LIMIT,
1117
1118	DBGFREG_GS,
1119	DBGFREG_GS_ATTR,
1120	DBGFREG_GS_BASE,
1121	DBGFREG_GS_LIMIT,
1122
1123	DBGFREG_SS,
1124	DBGFREG_SS_ATTR,
1125	DBGFREG_SS_BASE,
1126	DBGFREG_SS_LIMIT,
1127
1128	DBGFREG_IP,
1129	DBGFREG_EIP = DBGFREG_IP,
1130	DBGFREG_RIP = DBGFREG_IP,
1131
1132	DBGFREG_FLAGS,
1133	DBGFREG_EFLAGS = DBGFREG_FLAGS,
1134	DBGFREG_RFLAGS = DBGFREG_FLAGS,
1135
1136	/* FPU: */
1137	DBGFREG_FCW,
1138	DBGFREG_FSW,
1139	DBGFREG_FTW,
1140	DBGFREG_FOP,
1141	DBGFREG_FPUIP,
1142	DBGFREG_FPUCS,
1143	DBGFREG_FPUDP,
1144	DBGFREG_FPUDS,
1145	DBGFREG_MXCSR,
1146	DBGFREG_MXCSR_MASK,
1147
1148	DBGFREG_ST0,
1149	DBGFREG_ST1,
1150	DBGFREG_ST2,
1151	DBGFREG_ST3,
1152	DBGFREG_ST4,
1153	DBGFREG_ST5,
1154	DBGFREG_ST6,
1155	DBGFREG_ST7,
1156
1157	DBGFREG_MM0,
1158	DBGFREG_MM1,
1159	DBGFREG_MM2,
1160	DBGFREG_MM3,
1161	DBGFREG_MM4,
1162	DBGFREG_MM5,
1163	DBGFREG_MM6,
1164	DBGFREG_MM7,
1165
1166	/* SSE: */
1167	DBGFREG_XMM0,
1168	DBGFREG_XMM1,
1169	DBGFREG_XMM2,
1170	DBGFREG_XMM3,
1171	DBGFREG_XMM4,
1172	DBGFREG_XMM5,
1173	DBGFREG_XMM6,
1174	DBGFREG_XMM7,
1175	DBGFREG_XMM8,
1176	DBGFREG_XMM9,
1177	DBGFREG_XMM10,
1178	DBGFREG_XMM11,
1179	DBGFREG_XMM12,
1180	DBGFREG_XMM13,
1181	DBGFREG_XMM14,
1182	DBGFREG_XMM15,
1183	/** @todo add XMM aliases. */
1184
1185	/* System registers: */
1186	DBGFREG_GDTR_BASE,
1187	DBGFREG_GDTR_LIMIT,
1188	DBGFREG_IDTR_BASE,
1189	DBGFREG_IDTR_LIMIT,
1190	DBGFREG_LDTR,
1191	DBGFREG_LDTR_ATTR,
1192	DBGFREG_LDTR_BASE,
1193	DBGFREG_LDTR_LIMIT,
1194	DBGFREG_TR,
1195	DBGFREG_TR_ATTR,
1196	DBGFREG_TR_BASE,
1197	DBGFREG_TR_LIMIT,
1198
1199	DBGFREG_CR0,
1200	DBGFREG_CR2,
1201	DBGFREG_CR3,
1202	DBGFREG_CR4,
1203	DBGFREG_CR8,
1204
1205	DBGFREG_DR0,
1206	DBGFREG_DR1,
1207	DBGFREG_DR2,
1208	DBGFREG_DR3,
1209	DBGFREG_DR6,
1210	DBGFREG_DR7,
1211
1212	/* MSRs: */
1213	DBGFREG_MSR_IA32_APICBASE,
1214	DBGFREG_MSR_IA32_CR_PAT,
1215	DBGFREG_MSR_IA32_PERF_STATUS,
1216	DBGFREG_MSR_IA32_SYSENTER_CS,
1217	DBGFREG_MSR_IA32_SYSENTER_EIP,
1218	DBGFREG_MSR_IA32_SYSENTER_ESP,
1219	DBGFREG_MSR_IA32_TSC,
1220	DBGFREG_MSR_K6_EFER,
1221	DBGFREG_MSR_K6_STAR,
1222	DBGFREG_MSR_K8_CSTAR,
1223	DBGFREG_MSR_K8_FS_BASE,
1224	DBGFREG_MSR_K8_GS_BASE,
1225	DBGFREG_MSR_K8_KERNEL_GS_BASE,
1226	DBGFREG_MSR_K8_LSTAR,
1227	DBGFREG_MSR_K8_SF_MASK,
1228	DBGFREG_MSR_K8_TSC_AUX,
1229
1230	/** The number of registers to pass to DBGFR3RegQueryAll. */
1231	DBGFREG_ALL_COUNT,
1232
1233	/* Misc aliases that doesn't need be part of the 'all' query: */
1234	DBGFREG_AH = DBGFREG_ALL_COUNT,
1235	DBGFREG_CH,
1236	DBGFREG_DH,
1237	DBGFREG_BH,
1238	DBGFREG_GDTR,
1239	DBGFREG_IDTR,
1240
1241	/** The end of the registers. */
1242	DBGFREG_END,
1243	/** The usual 32-bit type hack. */
1244	DBGFREG_32BIT_HACK = 0x7fffffff
1245	} DBGFREG;
1246	/** Pointer to a register identifier. */
1247	typedef DBGFREG *PDBGFREG;
1248	/** Pointer to a const register identifier. */
1249	typedef DBGFREG const *PCDBGFREG;
1250
1251	/**
1252	* Register value type.
1253	*/
1254	typedef enum DBGFREGVALTYPE
1255	{
1256	DBGFREGVALTYPE_INVALID = 0,
1257	/** Unsigned 8-bit register value. */
1258	DBGFREGVALTYPE_U8,
1259	/** Unsigned 16-bit register value. */
1260	DBGFREGVALTYPE_U16,
1261	/** Unsigned 32-bit register value. */
1262	DBGFREGVALTYPE_U32,
1263	/** Unsigned 64-bit register value. */
1264	DBGFREGVALTYPE_U64,
1265	/** Unsigned 128-bit register value. */
1266	DBGFREGVALTYPE_U128,
1267	/** Long double register value. */
1268	DBGFREGVALTYPE_R80,
1269	/** Descriptor table register value. */
1270	DBGFREGVALTYPE_DTR,
1271	/** End of the valid register value types. */
1272	DBGFREGVALTYPE_END,
1273	/** The usual 32-bit type hack. */
1274	DBGFREGVALTYPE_32BIT_HACK = 0x7fffffff
1275	} DBGFREGVALTYPE;
1276	/** Pointer to a register value type. */
1277	typedef DBGFREGVALTYPE *PDBGFREGVALTYPE;
1278
1279	/**
1280	* A generic register value type.
1281	*/
1282	typedef union DBGFREGVAL
1283	{
1284	uint8_t u8; /*< The 8-bit view. /
1285	uint16_t u16; /*< The 16-bit view. /
1286	uint32_t u32; /*< The 32-bit view. /
1287	uint64_t u64; /*< The 64-bit view. /
1288	RTUINT128U u128; /*< The 128-bit view. /
1289	RTFLOAT80U r80; /*< The 80-bit floating point view. /
1290	RTFLOAT80U2 r80Ex; /*< The 80-bit floating point view v2. /
1291	/** GDTR or LDTR (DBGFREGVALTYPE_DTR). */
1292	struct
1293	{
1294	/** The table address. */
1295	uint64_t u64Base;
1296	/** The table limit (length minus 1). */
1297	uint32_t u32Limit;
1298	} dtr;
1299
1300	uint8_t au8[16]; /*< The 8-bit array view. /
1301	uint16_t au16[8]; /*< The 16-bit array view. /
1302	uint32_t au32[4]; /*< The 32-bit array view. /
1303	uint64_t au64[2]; /*< The 64-bit array view. /
1304	RTUINT128U u;
1305	} DBGFREGVAL;
1306	/** Pointer to a generic register value type. */
1307	typedef DBGFREGVAL *PDBGFREGVAL;
1308	/** Pointer to a const generic register value type. */
1309	typedef DBGFREGVAL const *PCDBGFREGVAL;
1310
1311	VMMDECL(ssize_t) DBGFR3RegFormatValue(char *pszBuf, size_t cbBuf, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType, bool fSpecial);
1312	VMMDECL(ssize_t) DBGFR3RegFormatValueEx(char *pszBuf, size_t cbBuf, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType,
1313	unsigned uBase, signed int cchWidth, signed int cchPrecision, uint32_t fFlags);
1314
1315	/**
1316	* Register sub-field descriptor.
1317	*/
1318	typedef struct DBGFREGSUBFIELD
1319	{
1320	/** The name of the sub-field. NULL is used to terminate the array. */
1321	const char *pszName;
1322	/** The index of the first bit. Ignored if pfnGet is set. */
1323	uint8_t iFirstBit;
1324	/** The number of bits. Mandatory. */
1325	uint8_t cBits;
1326	/** The shift count. Not applied when pfnGet is set, but used to
1327	* calculate the minimum type. */
1328	int8_t cShift;
1329	/** Sub-field flags, DBGFREGSUBFIELD_FLAGS_XXX. */
1330	uint8_t fFlags;
1331	/** Getter (optional).
1332	* @remarks Does not take the device lock or anything like that.
1333	*/
1334	DECLCALLBACKMEMBER(int, pfnGet)(void pvUser, struct DBGFREGSUBFIELD const pSubField, PRTUINT128U puValue);
1335	/** Setter (optional).
1336	* @remarks Does not take the device lock or anything like that.
1337	*/
1338	DECLCALLBACKMEMBER(int, pfnSet)(void pvUser, struct DBGFREGSUBFIELD const pSubField, RTUINT128U uValue, RTUINT128U fMask);
1339	} DBGFREGSUBFIELD;
1340	/** Pointer to a const register sub-field descriptor. */
1341	typedef DBGFREGSUBFIELD const *PCDBGFREGSUBFIELD;
1342
1343	/** @name DBGFREGSUBFIELD_FLAGS_XXX
1344	* @{ */
1345	/** The sub-field is read-only. */
1346	#define DBGFREGSUBFIELD_FLAGS_READ_ONLY UINT8_C(0x01)
1347	/** @} */
1348
1349	/** Macro for creating a read-write sub-field entry without getters. */
1350	#define DBGFREGSUBFIELD_RW(a_szName, a_iFirstBit, a_cBits, a_cShift) \
1351	{ a_szName, a_iFirstBit, a_cBits, a_cShift, 0 /fFlags/, NULL /pfnGet/, NULL /pfnSet/ }
1352	/** Macro for creating a read-write sub-field entry with getters. */
1353	#define DBGFREGSUBFIELD_RW_SG(a_szName, a_cBits, a_cShift, a_pfnGet, a_pfnSet) \
1354	{ a_szName, 0 /iFirstBit/, a_cBits, a_cShift, 0 /fFlags/, a_pfnGet, a_pfnSet }
1355	/** Macro for creating a read-only sub-field entry without getters. */
1356	#define DBGFREGSUBFIELD_RO(a_szName, a_iFirstBit, a_cBits, a_cShift) \
1357	{ a_szName, a_iFirstBit, a_cBits, a_cShift, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL /pfnGet/, NULL /pfnSet/ }
1358	/** Macro for creating a terminator sub-field entry. */
1359	#define DBGFREGSUBFIELD_TERMINATOR() \
1360	{ NULL, 0, 0, 0, 0, NULL, NULL }
1361
1362	/**
1363	* Register alias descriptor.
1364	*/
1365	typedef struct DBGFREGALIAS
1366	{
1367	/** The alias name. NULL is used to terminate the array. */
1368	const char *pszName;
1369	/** Set to a valid type if the alias has a different type. */
1370	DBGFREGVALTYPE enmType;
1371	} DBGFREGALIAS;
1372	/** Pointer to a const register alias descriptor. */
1373	typedef DBGFREGALIAS const *PCDBGFREGALIAS;
1374
1375	/**
1376	* Register descriptor.
1377	*/
1378	typedef struct DBGFREGDESC
1379	{
1380	/** The normal register name. */
1381	const char *pszName;
1382	/** The register identifier if this is a CPU register. */
1383	DBGFREG enmReg;
1384	/** The default register type. */
1385	DBGFREGVALTYPE enmType;
1386	/** Flags, see DBGFREG_FLAGS_XXX. */
1387	uint32_t fFlags;
1388	/** The internal register indicator.
1389	* For CPU registers this is the offset into the CPUMCTX structure,
1390	* thuse the 'off' prefix. */
1391	uint32_t offRegister;
1392	/** Getter.
1393	* @remarks Does not take the device lock or anything like that.
1394	*/
1395	DECLCALLBACKMEMBER(int, pfnGet)(void pvUser, struct DBGFREGDESC const pDesc, PDBGFREGVAL pValue);
1396	/** Setter.
1397	* @remarks Does not take the device lock or anything like that.
1398	*/
1399	DECLCALLBACKMEMBER(int, pfnSet)(void pvUser, struct DBGFREGDESC const pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask);
1400	/** Aliases (optional). */
1401	PCDBGFREGALIAS paAliases;
1402	/** Sub fields (optional). */
1403	PCDBGFREGSUBFIELD paSubFields;
1404	} DBGFREGDESC;
1405
1406	/** @name Macros for constructing DBGFREGDESC arrays.
1407	* @{ */
1408	#define DBGFREGDESC_RW(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet) \
1409	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, NULL /paAlises/, NULL /paSubFields/ }
1410	#define DBGFREGDESC_RO(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet) \
1411	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, NULL /paAlises/, NULL /paSubFields/ }
1412	#define DBGFREGDESC_RW_A(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases) \
1413	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, NULL /paSubFields/ }
1414	#define DBGFREGDESC_RO_A(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases) \
1415	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, NULL /paSubFields/ }
1416	#define DBGFREGDESC_RW_S(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paSubFields) \
1417	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, /paAliases/, a_paSubFields }
1418	#define DBGFREGDESC_RO_S(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paSubFields) \
1419	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, /paAliases/, a_paSubFields }
1420	#define DBGFREGDESC_RW_AS(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields) \
1421	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, 0 /fFlags/, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields }
1422	#define DBGFREGDESC_RO_AS(a_szName, a_TypeSuff, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields) \
1423	{ a_szName, DBGFREG_END, DBGFREGVALTYPE_##a_TypeSuff, DBGFREG_FLAGS_READ_ONLY, a_offRegister, a_pfnGet, a_pfnSet, a_paAliases, a_paSubFields }
1424	#define DBGFREGDESC_TERMINATOR() \
1425	{ NULL, DBGFREG_END, DBGFREGVALTYPE_INVALID, 0, 0, NULL, NULL, NULL, NULL }
1426	/** @} */
1427
1428
1429	/** @name DBGFREG_FLAGS_XXX
1430	* @{ */
1431	/** The register is read-only. */
1432	#define DBGFREG_FLAGS_READ_ONLY RT_BIT_32(0)
1433	/** @} */
1434
1435	/**
1436	* Entry in a batch query or set operation.
1437	*/
1438	typedef struct DBGFREGENTRY
1439	{
1440	/** The register identifier. */
1441	DBGFREG enmReg;
1442	/** The size of the value in bytes. */
1443	DBGFREGVALTYPE enmType;
1444	/** The register value. The valid view is indicated by enmType. */
1445	DBGFREGVAL Val;
1446	} DBGFREGENTRY;
1447	/** Pointer to a register entry in a batch operation. */
1448	typedef DBGFREGENTRY *PDBGFREGENTRY;
1449	/** Pointer to a const register entry in a batch operation. */
1450	typedef DBGFREGENTRY const *PCDBGFREGENTRY;
1451
1452	/** Used with DBGFR3Reg* to indicate the hypervisor register set instead of the
1453	* guest. */
1454	#define DBGFREG_HYPER_VMCPUID UINT32_C(0x01000000)
1455
1456	VMMR3DECL(int) DBGFR3RegCpuQueryU8( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint8_t *pu8);
1457	VMMR3DECL(int) DBGFR3RegCpuQueryU16( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint16_t *pu16);
1458	VMMR3DECL(int) DBGFR3RegCpuQueryU32( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint32_t *pu32);
1459	VMMR3DECL(int) DBGFR3RegCpuQueryU64( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t *pu64);
1460	VMMR3DECL(int) DBGFR3RegCpuQueryU128(PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint128_t *pu128);
1461	VMMR3DECL(int) DBGFR3RegCpuQueryLrd( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, long double *plrd);
1462	VMMR3DECL(int) DBGFR3RegCpuQueryXdtr(PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t pu64Base, uint16_t pu16Limit);
1463	#if 0
1464	VMMR3DECL(int) DBGFR3RegCpuQueryBatch(PUVM pUVM,VMCPUID idCpu, PDBGFREGENTRY paRegs, size_t cRegs);
1465	VMMR3DECL(int) DBGFR3RegCpuQueryAll( PUVM pUVM, VMCPUID idCpu, PDBGFREGENTRY paRegs, size_t cRegs);
1466
1467	VMMR3DECL(int) DBGFR3RegCpuSetU8( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint8_t u8);
1468	VMMR3DECL(int) DBGFR3RegCpuSetU16( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint16_t u16);
1469	VMMR3DECL(int) DBGFR3RegCpuSetU32( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint32_t u32);
1470	VMMR3DECL(int) DBGFR3RegCpuSetU64( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint64_t u64);
1471	VMMR3DECL(int) DBGFR3RegCpuSetU128( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, uint128_t u128);
1472	VMMR3DECL(int) DBGFR3RegCpuSetLrd( PUVM pUVM, VMCPUID idCpu, DBGFREG enmReg, long double lrd);
1473	VMMR3DECL(int) DBGFR3RegCpuSetBatch( PUVM pUVM, VMCPUID idCpu, PCDBGFREGENTRY paRegs, size_t cRegs);
1474	#endif
1475
1476	VMMR3DECL(const char *) DBGFR3RegCpuName(PUVM pUVM, DBGFREG enmReg, DBGFREGVALTYPE enmType);
1477
1478	VMMR3_INT_DECL(int) DBGFR3RegRegisterCpu(PVM pVM, PVMCPU pVCpu, PCDBGFREGDESC paRegisters, bool fGuestRegs);
1479	VMMR3_INT_DECL(int) DBGFR3RegRegisterDevice(PVM pVM, PCDBGFREGDESC paRegisters, PPDMDEVINS pDevIns,
1480	const char *pszPrefix, uint32_t iInstance);
1481
1482	/**
1483	* Entry in a named batch query or set operation.
1484	*/
1485	typedef struct DBGFREGENTRYNM
1486	{
1487	/** The register name. */
1488	const char *pszName;
1489	/** The size of the value in bytes. */
1490	DBGFREGVALTYPE enmType;
1491	/** The register value. The valid view is indicated by enmType. */
1492	DBGFREGVAL Val;
1493	} DBGFREGENTRYNM;
1494	/** Pointer to a named register entry in a batch operation. */
1495	typedef DBGFREGENTRYNM *PDBGFREGENTRYNM;
1496	/** Pointer to a const named register entry in a batch operation. */
1497	typedef DBGFREGENTRYNM const *PCDBGFREGENTRYNM;
1498
1499	VMMR3DECL(int) DBGFR3RegNmValidate( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg);
1500
1501	VMMR3DECL(int) DBGFR3RegNmQuery( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PDBGFREGVAL pValue, PDBGFREGVALTYPE penmType);
1502	VMMR3DECL(int) DBGFR3RegNmQueryU8( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint8_t pu8);
1503	VMMR3DECL(int) DBGFR3RegNmQueryU16( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint16_t pu16);
1504	VMMR3DECL(int) DBGFR3RegNmQueryU32( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint32_t pu32);
1505	VMMR3DECL(int) DBGFR3RegNmQueryU64( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint64_t pu64);
1506	VMMR3DECL(int) DBGFR3RegNmQueryU128(PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PRTUINT128U pu128);
1507	/VMMR3DECL(int) DBGFR3RegNmQueryLrd( PUVM pUVM, VMCPUID idDefCpu, const char pszReg, long double plrd);/
1508	VMMR3DECL(int) DBGFR3RegNmQueryXdtr(PUVM pUVM, VMCPUID idDefCpu, const char pszReg, uint64_t pu64Base, uint16_t *pu16Limit);
1509	VMMR3DECL(int) DBGFR3RegNmQueryBatch(PUVM pUVM,VMCPUID idDefCpu, PDBGFREGENTRYNM paRegs, size_t cRegs);
1510	VMMR3DECL(int) DBGFR3RegNmQueryAllCount(PUVM pUVM, size_t *pcRegs);
1511	VMMR3DECL(int) DBGFR3RegNmQueryAll( PUVM pUVM, PDBGFREGENTRYNM paRegs, size_t cRegs);
1512
1513	VMMR3DECL(int) DBGFR3RegNmSet( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, PCDBGFREGVAL pValue, DBGFREGVALTYPE enmType);
1514	VMMR3DECL(int) DBGFR3RegNmSetU8( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint8_t u8);
1515	VMMR3DECL(int) DBGFR3RegNmSetU16( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint16_t u16);
1516	VMMR3DECL(int) DBGFR3RegNmSetU32( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint32_t u32);
1517	VMMR3DECL(int) DBGFR3RegNmSetU64( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, uint64_t u64);
1518	VMMR3DECL(int) DBGFR3RegNmSetU128( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, RTUINT128U u128);
1519	VMMR3DECL(int) DBGFR3RegNmSetLrd( PUVM pUVM, VMCPUID idDefCpu, const char *pszReg, long double lrd);
1520	VMMR3DECL(int) DBGFR3RegNmSetBatch( PUVM pUVM, VMCPUID idDefCpu, PCDBGFREGENTRYNM paRegs, size_t cRegs);
1521
1522	/** @todo add enumeration methods. */
1523
1524	VMMR3DECL(int) DBGFR3RegPrintf( PUVM pUVM, VMCPUID idDefCpu, char pszBuf, size_t cbBuf, const char pszFormat, ...);
1525	VMMR3DECL(int) DBGFR3RegPrintfV(PUVM pUVM, VMCPUID idDefCpu, char pszBuf, size_t cbBuf, const char pszFormat, va_list va);
1526
1527
1528	/**
1529	* Guest OS digger interface identifier.
1530	*
1531	* This is for use together with PDBGFR3QueryInterface and is used to
1532	* obtain access to optional interfaces.
1533	*/
1534	typedef enum DBGFOSINTERFACE
1535	{
1536	/** The usual invalid entry. */
1537	DBGFOSINTERFACE_INVALID = 0,
1538	/** Process info. */
1539	DBGFOSINTERFACE_PROCESS,
1540	/** Thread info. */
1541	DBGFOSINTERFACE_THREAD,
1542	/** The end of the valid entries. */
1543	DBGFOSINTERFACE_END,
1544	/** The usual 32-bit type blowup. */
1545	DBGFOSINTERFACE_32BIT_HACK = 0x7fffffff
1546	} DBGFOSINTERFACE;
1547	/** Pointer to a Guest OS digger interface identifier. */
1548	typedef DBGFOSINTERFACE *PDBGFOSINTERFACE;
1549	/** Pointer to a const Guest OS digger interface identifier. */
1550	typedef DBGFOSINTERFACE const *PCDBGFOSINTERFACE;
1551
1552
1553	/**
1554	* Guest OS Digger Registration Record.
1555	*
1556	* This is used with the DBGFR3OSRegister() API.
1557	*/
1558	typedef struct DBGFOSREG
1559	{
1560	/** Magic value (DBGFOSREG_MAGIC). */
1561	uint32_t u32Magic;
1562	/** Flags. Reserved. */
1563	uint32_t fFlags;
1564	/** The size of the instance data. */
1565	uint32_t cbData;
1566	/** Operative System name. */
1567	char szName[24];
1568
1569	/**
1570	* Constructs the instance.
1571	*
1572	* @returns VBox status code.
1573	* @param pUVM The user mode VM handle.
1574	* @param pvData Pointer to the instance data.
1575	*/
1576	DECLCALLBACKMEMBER(int, pfnConstruct)(PUVM pUVM, void *pvData);
1577
1578	/**
1579	* Destroys the instance.
1580	*
1581	* @param pUVM The user mode VM handle.
1582	* @param pvData Pointer to the instance data.
1583	*/
1584	DECLCALLBACKMEMBER(void, pfnDestruct)(PUVM pUVM, void *pvData);
1585
1586	/**
1587	* Probes the guest memory for OS finger prints.
1588	*
1589	* No setup or so is performed, it will be followed by a call to pfnInit
1590	* or pfnRefresh that should take care of that.
1591	*
1592	* @returns true if is an OS handled by this module, otherwise false.
1593	* @param pUVM The user mode VM handle.
1594	* @param pvData Pointer to the instance data.
1595	*/
1596	DECLCALLBACKMEMBER(bool, pfnProbe)(PUVM pUVM, void *pvData);
1597
1598	/**
1599	* Initializes a fresly detected guest, loading symbols and such useful stuff.
1600	*
1601	* This is called after pfnProbe.
1602	*
1603	* @returns VBox status code.
1604	* @param pUVM The user mode VM handle.
1605	* @param pvData Pointer to the instance data.
1606	*/
1607	DECLCALLBACKMEMBER(int, pfnInit)(PUVM pUVM, void *pvData);
1608
1609	/**
1610	* Refreshes symbols and stuff following a redetection of the same OS.
1611	*
1612	* This is called after pfnProbe.
1613	*
1614	* @returns VBox status code.
1615	* @param pUVM The user mode VM handle.
1616	* @param pvData Pointer to the instance data.
1617	*/
1618	DECLCALLBACKMEMBER(int, pfnRefresh)(PUVM pUVM, void *pvData);
1619
1620	/**
1621	* Terminates an OS when a new (or none) OS has been detected,
1622	* and before destruction.
1623	*
1624	* This is called after pfnProbe and if needed before pfnDestruct.
1625	*
1626	* @param pUVM The user mode VM handle.
1627	* @param pvData Pointer to the instance data.
1628	*/
1629	DECLCALLBACKMEMBER(void, pfnTerm)(PUVM pUVM, void *pvData);
1630
1631	/**
1632	* Queries the version of the running OS.
1633	*
1634	* This is only called after pfnInit().
1635	*
1636	* @returns VBox status code.
1637	* @param pUVM The user mode VM handle.
1638	* @param pvData Pointer to the instance data.
1639	* @param pszVersion Where to store the version string.
1640	* @param cchVersion The size of the version string buffer.
1641	*/
1642	DECLCALLBACKMEMBER(int, pfnQueryVersion)(PUVM pUVM, void pvData, char pszVersion, size_t cchVersion);
1643
1644	/**
1645	* Queries the pointer to a interface.
1646	*
1647	* This is called after pfnProbe.
1648	*
1649	* @returns Pointer to the interface if available, NULL if not available.
1650	* @param pUVM The user mode VM handle.
1651	* @param pvData Pointer to the instance data.
1652	* @param enmIf The interface identifier.
1653	*/
1654	DECLCALLBACKMEMBER(void , pfnQueryInterface)(PUVM pUVM, void pvData, DBGFOSINTERFACE enmIf);
1655
1656	/** Trailing magic (DBGFOSREG_MAGIC). */
1657	uint32_t u32EndMagic;
1658	} DBGFOSREG;
1659	/** Pointer to a Guest OS digger registration record. */
1660	typedef DBGFOSREG *PDBGFOSREG;
1661	/** Pointer to a const Guest OS digger registration record. */
1662	typedef DBGFOSREG const *PCDBGFOSREG;
1663
1664	/** Magic value for DBGFOSREG::u32Magic and DBGFOSREG::u32EndMagic. (Hitomi Kanehara) */
1665	#define DBGFOSREG_MAGIC 0x19830808
1666
1667	VMMR3DECL(int) DBGFR3OSRegister(PUVM pUVM, PCDBGFOSREG pReg);
1668	VMMR3DECL(int) DBGFR3OSDeregister(PUVM pUVM, PCDBGFOSREG pReg);
1669	VMMR3DECL(int) DBGFR3OSDetect(PUVM pUVM, char *pszName, size_t cchName);
1670	VMMR3DECL(int) DBGFR3OSQueryNameAndVersion(PUVM pUVM, char pszName, size_t cchName, char pszVersion, size_t cchVersion);
1671	VMMR3DECL(void *) DBGFR3OSQueryInterface(PUVM pUVM, DBGFOSINTERFACE enmIf);
1672
1673
1674	VMMR3DECL(int) DBGFR3CoreWrite(PUVM pUVM, const char *pszFilename, bool fReplaceFile);
1675
1676	/** @} */
1677
1678
1679	RT_C_DECLS_END
1680
1681	#endif
1682

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

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

Download in other formats: