| 1 | /* $Id: DBGFInternal.h 56287 2015-06-09 11:15:22Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * DBGF - Internal header file.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2015 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | */
|
|---|
| 17 |
|
|---|
| 18 | #ifndef ___DBGFInternal_h
|
|---|
| 19 | #define ___DBGFInternal_h
|
|---|
| 20 |
|
|---|
| 21 | #include <VBox/cdefs.h>
|
|---|
| 22 | #include <VBox/types.h>
|
|---|
| 23 | #include <iprt/semaphore.h>
|
|---|
| 24 | #include <iprt/critsect.h>
|
|---|
| 25 | #include <iprt/string.h>
|
|---|
| 26 | #include <iprt/avl.h>
|
|---|
| 27 | #include <iprt/dbg.h>
|
|---|
| 28 | #include <VBox/vmm/dbgf.h>
|
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 |
|
|---|
| 32 | /** @defgroup grp_dbgf_int Internals
|
|---|
| 33 | * @ingroup grp_dbgf
|
|---|
| 34 | * @internal
|
|---|
| 35 | * @{
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 |
|
|---|
| 39 | /** VMM Debugger Command. */
|
|---|
| 40 | typedef enum DBGFCMD
|
|---|
| 41 | {
|
|---|
| 42 | /** No command.
|
|---|
| 43 | * This is assigned to the field by the emulation thread after
|
|---|
| 44 | * a command has been completed. */
|
|---|
| 45 | DBGFCMD_NO_COMMAND = 0,
|
|---|
| 46 | /** Halt the VM. */
|
|---|
| 47 | DBGFCMD_HALT,
|
|---|
| 48 | /** Resume execution. */
|
|---|
| 49 | DBGFCMD_GO,
|
|---|
| 50 | /** Single step execution - stepping into calls. */
|
|---|
| 51 | DBGFCMD_SINGLE_STEP,
|
|---|
| 52 | /** Set a breakpoint. */
|
|---|
| 53 | DBGFCMD_BREAKPOINT_SET,
|
|---|
| 54 | /** Set a access breakpoint. */
|
|---|
| 55 | DBGFCMD_BREAKPOINT_SET_ACCESS,
|
|---|
| 56 | /** Set a REM breakpoint. */
|
|---|
| 57 | DBGFCMD_BREAKPOINT_SET_REM,
|
|---|
| 58 | /** Clear a breakpoint. */
|
|---|
| 59 | DBGFCMD_BREAKPOINT_CLEAR,
|
|---|
| 60 | /** Enable a breakpoint. */
|
|---|
| 61 | DBGFCMD_BREAKPOINT_ENABLE,
|
|---|
| 62 | /** Disable a breakpoint. */
|
|---|
| 63 | DBGFCMD_BREAKPOINT_DISABLE,
|
|---|
| 64 | /** List breakpoints. */
|
|---|
| 65 | DBGFCMD_BREAKPOINT_LIST,
|
|---|
| 66 |
|
|---|
| 67 | /** Detaches the debugger.
|
|---|
| 68 | * Disabling all breakpoints, watch points and the like. */
|
|---|
| 69 | DBGFCMD_DETACH_DEBUGGER = 0x7ffffffe,
|
|---|
| 70 | /** Detached the debugger.
|
|---|
| 71 | * The isn't a command as such, it's just that it's necessary for the
|
|---|
| 72 | * detaching protocol to be racefree. */
|
|---|
| 73 | DBGFCMD_DETACHED_DEBUGGER = 0x7fffffff
|
|---|
| 74 | } DBGFCMD;
|
|---|
| 75 |
|
|---|
| 76 | /**
|
|---|
| 77 | * VMM Debugger Command.
|
|---|
| 78 | */
|
|---|
| 79 | typedef union DBGFCMDDATA
|
|---|
| 80 | {
|
|---|
| 81 | uint32_t uDummy;
|
|---|
| 82 | } DBGFCMDDATA;
|
|---|
| 83 | /** Pointer to DBGF Command Data. */
|
|---|
| 84 | typedef DBGFCMDDATA *PDBGFCMDDATA;
|
|---|
| 85 |
|
|---|
| 86 | /**
|
|---|
| 87 | * Info type.
|
|---|
| 88 | */
|
|---|
| 89 | typedef enum DBGFINFOTYPE
|
|---|
| 90 | {
|
|---|
| 91 | /** Invalid. */
|
|---|
| 92 | DBGFINFOTYPE_INVALID = 0,
|
|---|
| 93 | /** Device owner. */
|
|---|
| 94 | DBGFINFOTYPE_DEV,
|
|---|
| 95 | /** Driver owner. */
|
|---|
| 96 | DBGFINFOTYPE_DRV,
|
|---|
| 97 | /** Internal owner. */
|
|---|
| 98 | DBGFINFOTYPE_INT,
|
|---|
| 99 | /** External owner. */
|
|---|
| 100 | DBGFINFOTYPE_EXT
|
|---|
| 101 | } DBGFINFOTYPE;
|
|---|
| 102 |
|
|---|
| 103 |
|
|---|
| 104 | /** Pointer to info structure. */
|
|---|
| 105 | typedef struct DBGFINFO *PDBGFINFO;
|
|---|
| 106 |
|
|---|
| 107 | #ifdef IN_RING3
|
|---|
| 108 | /**
|
|---|
| 109 | * Info structure.
|
|---|
| 110 | */
|
|---|
| 111 | typedef struct DBGFINFO
|
|---|
| 112 | {
|
|---|
| 113 | /** The flags. */
|
|---|
| 114 | uint32_t fFlags;
|
|---|
| 115 | /** Owner type. */
|
|---|
| 116 | DBGFINFOTYPE enmType;
|
|---|
| 117 | /** Per type data. */
|
|---|
| 118 | union
|
|---|
| 119 | {
|
|---|
| 120 | /** DBGFINFOTYPE_DEV */
|
|---|
| 121 | struct
|
|---|
| 122 | {
|
|---|
| 123 | /** Device info handler function. */
|
|---|
| 124 | PFNDBGFHANDLERDEV pfnHandler;
|
|---|
| 125 | /** The device instance. */
|
|---|
| 126 | PPDMDEVINS pDevIns;
|
|---|
| 127 | } Dev;
|
|---|
| 128 |
|
|---|
| 129 | /** DBGFINFOTYPE_DRV */
|
|---|
| 130 | struct
|
|---|
| 131 | {
|
|---|
| 132 | /** Driver info handler function. */
|
|---|
| 133 | PFNDBGFHANDLERDRV pfnHandler;
|
|---|
| 134 | /** The driver instance. */
|
|---|
| 135 | PPDMDRVINS pDrvIns;
|
|---|
| 136 | } Drv;
|
|---|
| 137 |
|
|---|
| 138 | /** DBGFINFOTYPE_INT */
|
|---|
| 139 | struct
|
|---|
| 140 | {
|
|---|
| 141 | /** Internal info handler function. */
|
|---|
| 142 | PFNDBGFHANDLERINT pfnHandler;
|
|---|
| 143 | } Int;
|
|---|
| 144 |
|
|---|
| 145 | /** DBGFINFOTYPE_EXT */
|
|---|
| 146 | struct
|
|---|
| 147 | {
|
|---|
| 148 | /** External info handler function. */
|
|---|
| 149 | PFNDBGFHANDLEREXT pfnHandler;
|
|---|
| 150 | /** The user argument. */
|
|---|
| 151 | void *pvUser;
|
|---|
| 152 | } Ext;
|
|---|
| 153 | } u;
|
|---|
| 154 |
|
|---|
| 155 | /** Pointer to the description. */
|
|---|
| 156 | const char *pszDesc;
|
|---|
| 157 | /** Pointer to the next info structure. */
|
|---|
| 158 | PDBGFINFO pNext;
|
|---|
| 159 | /** The identifier name length. */
|
|---|
| 160 | size_t cchName;
|
|---|
| 161 | /** The identifier name. (Extends 'beyond' the struct as usual.) */
|
|---|
| 162 | char szName[1];
|
|---|
| 163 | } DBGFINFO;
|
|---|
| 164 | #endif /* IN_RING3 */
|
|---|
| 165 |
|
|---|
| 166 |
|
|---|
| 167 | /**
|
|---|
| 168 | * Guest OS digger instance.
|
|---|
| 169 | */
|
|---|
| 170 | typedef struct DBGFOS
|
|---|
| 171 | {
|
|---|
| 172 | /** Pointer to the registration record. */
|
|---|
| 173 | PCDBGFOSREG pReg;
|
|---|
| 174 | /** Pointer to the next OS we've registered. */
|
|---|
| 175 | struct DBGFOS *pNext;
|
|---|
| 176 | /** List of EMT interface wrappers. */
|
|---|
| 177 | struct DBGFOSEMTWRAPPER *pWrapperHead;
|
|---|
| 178 | /** The instance data (variable size). */
|
|---|
| 179 | uint8_t abData[16];
|
|---|
| 180 | } DBGFOS;
|
|---|
| 181 | /** Pointer to guest OS digger instance. */
|
|---|
| 182 | typedef DBGFOS *PDBGFOS;
|
|---|
| 183 | /** Pointer to const guest OS digger instance. */
|
|---|
| 184 | typedef DBGFOS const *PCDBGFOS;
|
|---|
| 185 |
|
|---|
| 186 |
|
|---|
| 187 |
|
|---|
| 188 | /**
|
|---|
| 189 | * Converts a DBGF pointer into a VM pointer.
|
|---|
| 190 | * @returns Pointer to the VM structure the CPUM is part of.
|
|---|
| 191 | * @param pDBGF Pointer to DBGF instance data.
|
|---|
| 192 | */
|
|---|
| 193 | #define DBGF2VM(pDBGF) ( (PVM)((char*)pDBGF - pDBGF->offVM) )
|
|---|
| 194 |
|
|---|
| 195 |
|
|---|
| 196 | /**
|
|---|
| 197 | * DBGF Data (part of VM)
|
|---|
| 198 | */
|
|---|
| 199 | typedef struct DBGF
|
|---|
| 200 | {
|
|---|
| 201 | /** Offset to the VM structure. */
|
|---|
| 202 | int32_t offVM;
|
|---|
| 203 |
|
|---|
| 204 | /** Debugger Attached flag.
|
|---|
| 205 | * Set if a debugger is attached, elsewise it's clear.
|
|---|
| 206 | */
|
|---|
| 207 | bool volatile fAttached;
|
|---|
| 208 |
|
|---|
| 209 | /** Stopped in the Hypervisor.
|
|---|
| 210 | * Set if we're stopped on a trace, breakpoint or assertion inside
|
|---|
| 211 | * the hypervisor and have to restrict the available operations.
|
|---|
| 212 | */
|
|---|
| 213 | bool volatile fStoppedInHyper;
|
|---|
| 214 |
|
|---|
| 215 | /**
|
|---|
| 216 | * Ping-Pong construct where the Ping side is the VMM and the Pong side
|
|---|
| 217 | * the Debugger.
|
|---|
| 218 | */
|
|---|
| 219 | RTPINGPONG PingPong;
|
|---|
| 220 |
|
|---|
| 221 | /** The Event to the debugger.
|
|---|
| 222 | * The VMM will ping the debugger when the event is ready. The event is
|
|---|
| 223 | * either a response to a command or to a break/watch point issued
|
|---|
| 224 | * previously.
|
|---|
| 225 | */
|
|---|
| 226 | DBGFEVENT DbgEvent;
|
|---|
| 227 |
|
|---|
| 228 | /** The Command to the VMM.
|
|---|
| 229 | * Operated in an atomic fashion since the VMM will poll on this.
|
|---|
| 230 | * This means that a the command data must be written before this member
|
|---|
| 231 | * is set. The VMM will reset this member to the no-command state
|
|---|
| 232 | * when it have processed it.
|
|---|
| 233 | */
|
|---|
| 234 | DBGFCMD volatile enmVMMCmd;
|
|---|
| 235 | /** The Command data.
|
|---|
| 236 | * Not all commands take data. */
|
|---|
| 237 | DBGFCMDDATA VMMCmdData;
|
|---|
| 238 |
|
|---|
| 239 | /** The number of hardware breakpoints. */
|
|---|
| 240 | uint32_t cHwBreakpoints;
|
|---|
| 241 | /** The number of active breakpoints. */
|
|---|
| 242 | uint32_t cBreakpoints;
|
|---|
| 243 | /** Array of hardware breakpoints. (0..3)
|
|---|
| 244 | * This is shared among all the CPUs because life is much simpler that way. */
|
|---|
| 245 | DBGFBP aHwBreakpoints[4];
|
|---|
| 246 | /** Array of int 3 and REM breakpoints. (4..)
|
|---|
| 247 | * @remark This is currently a fixed size array for reasons of simplicity. */
|
|---|
| 248 | DBGFBP aBreakpoints[32];
|
|---|
| 249 | } DBGF;
|
|---|
| 250 | /** Pointer to DBGF Data. */
|
|---|
| 251 | typedef DBGF *PDBGF;
|
|---|
| 252 |
|
|---|
| 253 |
|
|---|
| 254 | /** Converts a DBGFCPU pointer into a VM pointer. */
|
|---|
| 255 | #define DBGFCPU_2_VM(pDbgfCpu) ((PVM)((uint8_t *)(pDbgfCpu) + (pDbgfCpu)->offVM))
|
|---|
| 256 |
|
|---|
| 257 | /**
|
|---|
| 258 | * The per CPU data for DBGF.
|
|---|
| 259 | */
|
|---|
| 260 | typedef struct DBGFCPU
|
|---|
| 261 | {
|
|---|
| 262 | /** The offset into the VM structure.
|
|---|
| 263 | * @see DBGFCPU_2_VM(). */
|
|---|
| 264 | uint32_t offVM;
|
|---|
| 265 |
|
|---|
| 266 | /** Current active breakpoint (id).
|
|---|
| 267 | * This is ~0U if not active. It is set when a execution engine
|
|---|
| 268 | * encounters a breakpoint and returns VINF_EM_DBG_BREAKPOINT. This is
|
|---|
| 269 | * currently not used for REM breakpoints because of the lazy coupling
|
|---|
| 270 | * between VBox and REM. */
|
|---|
| 271 | uint32_t iActiveBp;
|
|---|
| 272 | /** Set if we're singlestepping in raw mode.
|
|---|
| 273 | * This is checked and cleared in the \#DB handler. */
|
|---|
| 274 | bool fSingleSteppingRaw;
|
|---|
| 275 |
|
|---|
| 276 | /** Padding the structure to 16 bytes. */
|
|---|
| 277 | bool afReserved[7];
|
|---|
| 278 | } DBGFCPU;
|
|---|
| 279 | /** Pointer to DBGFCPU data. */
|
|---|
| 280 | typedef DBGFCPU *PDBGFCPU;
|
|---|
| 281 |
|
|---|
| 282 | struct DBGFOSEMTWRAPPER;
|
|---|
| 283 |
|
|---|
| 284 | /**
|
|---|
| 285 | * The DBGF data kept in the UVM.
|
|---|
| 286 | */
|
|---|
| 287 | typedef struct DBGFUSERPERVM
|
|---|
| 288 | {
|
|---|
| 289 | /** The address space database lock. */
|
|---|
| 290 | RTSEMRW hAsDbLock;
|
|---|
| 291 | /** The address space handle database. (Protected by hAsDbLock.) */
|
|---|
| 292 | R3PTRTYPE(AVLPVTREE) AsHandleTree;
|
|---|
| 293 | /** The address space process id database. (Protected by hAsDbLock.) */
|
|---|
| 294 | R3PTRTYPE(AVLU32TREE) AsPidTree;
|
|---|
| 295 | /** The address space name database. (Protected by hAsDbLock.) */
|
|---|
| 296 | R3PTRTYPE(RTSTRSPACE) AsNameSpace;
|
|---|
| 297 | /** Special address space aliases. (Protected by hAsDbLock.) */
|
|---|
| 298 | RTDBGAS volatile ahAsAliases[DBGF_AS_COUNT];
|
|---|
| 299 | /** For lazily populating the aliased address spaces. */
|
|---|
| 300 | bool volatile afAsAliasPopuplated[DBGF_AS_COUNT];
|
|---|
| 301 | /** Alignment padding. */
|
|---|
| 302 | bool afAlignment1[2];
|
|---|
| 303 | /** Debug configuration. */
|
|---|
| 304 | R3PTRTYPE(RTDBGCFG) hDbgCfg;
|
|---|
| 305 |
|
|---|
| 306 | /** The register database lock. */
|
|---|
| 307 | RTSEMRW hRegDbLock;
|
|---|
| 308 | /** String space for looking up registers. (Protected by hRegDbLock.) */
|
|---|
| 309 | R3PTRTYPE(RTSTRSPACE) RegSpace;
|
|---|
| 310 | /** String space holding the register sets. (Protected by hRegDbLock.) */
|
|---|
| 311 | R3PTRTYPE(RTSTRSPACE) RegSetSpace;
|
|---|
| 312 | /** The number of registers (aliases, sub-fields and the special CPU
|
|---|
| 313 | * register aliases (eg AH) are not counted). */
|
|---|
| 314 | uint32_t cRegs;
|
|---|
| 315 | /** For early initialization by . */
|
|---|
| 316 | bool volatile fRegDbInitialized;
|
|---|
| 317 | /** Alignment padding. */
|
|---|
| 318 | bool afAlignment2[3];
|
|---|
| 319 |
|
|---|
| 320 | /** Critical section protecting the Guest OS Digger data, the info handlers
|
|---|
| 321 | * and the plugins. These share to give the best possible plugin unload
|
|---|
| 322 | * race protection. */
|
|---|
| 323 | RTCRITSECTRW CritSect;
|
|---|
| 324 | /** Head of the LIFO of loaded DBGF plugins. */
|
|---|
| 325 | R3PTRTYPE(struct DBGFPLUGIN *) pPlugInHead;
|
|---|
| 326 | /** The current Guest OS digger. */
|
|---|
| 327 | R3PTRTYPE(PDBGFOS) pCurOS;
|
|---|
| 328 | /** The head of the Guest OS digger instances. */
|
|---|
| 329 | R3PTRTYPE(PDBGFOS) pOSHead;
|
|---|
| 330 | /** List of registered info handlers. */
|
|---|
| 331 | R3PTRTYPE(PDBGFINFO) pInfoFirst;
|
|---|
| 332 |
|
|---|
| 333 | } DBGFUSERPERVM;
|
|---|
| 334 | typedef DBGFUSERPERVM *PDBGFUSERPERVM;
|
|---|
| 335 | typedef DBGFUSERPERVM const *PCDBGFUSERPERVM;
|
|---|
| 336 |
|
|---|
| 337 | /**
|
|---|
| 338 | * The per-CPU DBGF data kept in the UVM.
|
|---|
| 339 | */
|
|---|
| 340 | typedef struct DBGFUSERPERVMCPU
|
|---|
| 341 | {
|
|---|
| 342 | /** The guest register set for this CPU. Can be NULL. */
|
|---|
| 343 | R3PTRTYPE(struct DBGFREGSET *) pGuestRegSet;
|
|---|
| 344 | /** The hypervisor register set for this CPU. Can be NULL. */
|
|---|
| 345 | R3PTRTYPE(struct DBGFREGSET *) pHyperRegSet;
|
|---|
| 346 | } DBGFUSERPERVMCPU;
|
|---|
| 347 |
|
|---|
| 348 |
|
|---|
| 349 | int dbgfR3AsInit(PUVM pUVM);
|
|---|
| 350 | void dbgfR3AsTerm(PUVM pUVM);
|
|---|
| 351 | void dbgfR3AsRelocate(PUVM pUVM, RTGCUINTPTR offDelta);
|
|---|
| 352 | int dbgfR3BpInit(PVM pVM);
|
|---|
| 353 | int dbgfR3InfoInit(PUVM pUVM);
|
|---|
| 354 | int dbgfR3InfoTerm(PUVM pUVM);
|
|---|
| 355 | int dbgfR3OSInit(PUVM pUVM);
|
|---|
| 356 | void dbgfR3OSTerm(PUVM pUVM);
|
|---|
| 357 | int dbgfR3RegInit(PUVM pUVM);
|
|---|
| 358 | void dbgfR3RegTerm(PUVM pUVM);
|
|---|
| 359 | int dbgfR3TraceInit(PVM pVM);
|
|---|
| 360 | void dbgfR3TraceRelocate(PVM pVM);
|
|---|
| 361 | void dbgfR3TraceTerm(PVM pVM);
|
|---|
| 362 | int dbgfR3PlugInInit(PUVM pUVM);
|
|---|
| 363 | void dbgfR3PlugInTerm(PUVM pUVM);
|
|---|
| 364 |
|
|---|
| 365 |
|
|---|
| 366 |
|
|---|
| 367 | #ifdef IN_RING3
|
|---|
| 368 |
|
|---|
| 369 | #endif
|
|---|
| 370 |
|
|---|
| 371 | /** @} */
|
|---|
| 372 |
|
|---|
| 373 | #endif
|
|---|
