VirtualBox

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

Last change on this file since 45006 was 45006, checked in by vboxsync, 12 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette