dbg.h revision 7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * IPRT - Debugging Routines.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Copyright (C) 2008-2009 Sun Microsystems, Inc.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * available from http://www.virtualbox.org. This file is free software;
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * you can redistribute it and/or modify it under the terms of the GNU
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * General Public License (GPL) as published by the Free Software
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * The contents of this file may alternatively be used under the terms
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * of the Common Development and Distribution License Version 1.0
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * VirtualBox OSE distribution, in which case the provisions of the
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * CDDL are applicable instead of those of the GPL.
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * You may elect to license modified versions of this file under the
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * terms and conditions of either the GPL or the CDDL or both.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * additional information or have any questions.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** @defgroup grp_rt_dbg RTDbg - Debugging Routines
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @ingroup grp_rt
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Debug segment index. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to a debug segment index. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to a const debug segment index. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** NIL debug segment index. */
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync/** The last normal segment index. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Special segment index that indicates that the offset is a relative
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * virtual address (RVA). I.e. an offset from the start of the module. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Special segment index that indicates that the offset is a absolute. */
c2046db2cc346cc299f0cd9b2d1e160179159cfcvboxsync/** The last valid special segment index. */
c2046db2cc346cc299f0cd9b2d1e160179159cfcvboxsync/** The last valid special segment index. */
c2046db2cc346cc299f0cd9b2d1e160179159cfcvboxsync#define RTDBGSEGIDX_SPECIAL_FIRST (RTDBGSEGIDX_LAST + 1U)
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Max length (including '\\0') of a symbol name. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync#define RTDBG_SYMBOL_NAME_LENGTH (512 - 8 - 4 - 4 - 4)
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Debug symbol.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsynctypedef struct RTDBGSYMBOL
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync /** Symbol value (address).
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * This depends a bit who you ask. It will be the same as offSeg when you
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * as RTDbgMod, but the mapping address if you ask RTDbgAs. */
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync /** Offset into the segment specified by iSeg. */
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync /** Segment number. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Symbol size. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Symbol Flags. (reserved). */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Symbol name. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to debug symbol. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to const debug symbol. */
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * Allocate a new symbol structure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @returns Pointer to a new structure on success, NULL on failure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * Duplicates a symbol structure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @returns Pointer to duplicate on success, NULL on failure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param pSymbol The symbol to duplicate.
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsyncRTDECL(PRTDBGSYMBOL) RTDbgSymbolDup(PCRTDBGSYMBOL pSymbol);
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * Free a symbol structure previously allocated by a RTDbg method.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param pSymbol The symbol to free. NULL is ignored.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync/** Max length (including '\\0') of a debug info file name. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Debug line number information.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsynctypedef struct RTDBGLINE
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync /** Address.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * This depends a bit who you ask. It will be the same as offSeg when you
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * as RTDbgMod, but the mapping address if you ask RTDbgAs. */
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync /** Offset into the segment specified by iSeg. */
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync /** Segment number. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Line number. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Filename. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to debug line number. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to const debug line number. */
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsync * Allocate a new line number structure.
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsync * @returns Pointer to a new structure on success, NULL on failure.
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsync * Duplicates a line number structure.
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsync * @returns Pointer to duplicate on success, NULL on failure.
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsync * @param pLine The line number to duplicate.
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsync * Free a line number structure previously allocated by a RTDbg method.
7d80dfbe5d66fc4c6de6fe109ce96a081496dcd4vboxsync * @param pLine The line number to free. NULL is ignored.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** @defgroup grp_rt_dbgas RTDbgAs - Debug Address Space
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Creates an empty address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param phDbgAs Where to store the address space handle on success.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param FirstAddr The first address in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param LastAddr The last address in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pszName The name of the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsCreate(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszName);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Variant of RTDbgAsCreate that takes a name format string.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param phDbgAs Where to store the address space handle on success.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param FirstAddr The first address in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param LastAddr The last address in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pszNameFmt The name format of the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param va Format arguments.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsCreateV(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszNameFmt, va_list va);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Variant of RTDbgAsCreate that takes a name format string.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param phDbgAs Where to store the address space handle on success.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param FirstAddr The first address in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param LastAddr The last address in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pszNameFmt The name format of the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param ... Format arguments.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsCreateF(PRTDBGAS phDbgAs, RTUINTPTR FirstAddr, RTUINTPTR LastAddr, const char *pszNameFmt, ...);
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * Retains a reference to the address space.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @returns New reference count, UINT32_MAX on invalid handle (asserted).
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @param hDbgAs The address space handle.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @remarks Will not take any locks.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * Release a reference to the address space.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * When the reference count reaches zero, the address space is destroyed.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * That means unlinking all the modules it currently contains, potentially
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * causing some or all of them to be destroyed as they are managed by
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * reference counting.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @returns New reference count, UINT32_MAX on invalid handle (asserted).
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @param hDbgAs The address space handle. The NIL handle is quietly
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * ignored and 0 is returned.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @remarks Will not take any locks.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Gets the name of an address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns read only address space name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * NULL if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @remarks Will not take any locks.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Gets the first address in an address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns The address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * 0 if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @remarks Will not take any locks.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Gets the last address in an address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns The address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * 0 if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @remarks Will not take any locks.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Gets the number of modules in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * This can be used together with RTDbgAsModuleByIndex
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * to enumerate the modules.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns The number of modules.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @remarks Will not take any locks.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(uint32_t) RTDbgAsModuleCount(RTDBGAS hDbgAs);
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync/** @name Flags for RTDbgAsModuleLink and RTDbgAsModuleLinkSeg
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync/** Replace all conflicting module.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * (The conflicting modules will be removed the address space and their
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * references released.) */
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync/** Mask containing the valid flags. */
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync#define RTDBGASLINK_FLAGS_VALID_MASK UINT32_C(0x00000001)
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Links a module into the address space at the give address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * The size of the mapping is determined using RTDbgModImageSize().
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_OUT_OF_RANGE if the specified address will put the module
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * outside the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_ADDRESS_CONFLICT if the mapping clashes with existing mappings.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgMod The module handle of the module to be linked in.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param ImageAddr The address to link the module at.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @param fFlags See RTDBGASLINK_FLAGS_*.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsyncRTDECL(int) RTDbgAsModuleLink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod, RTUINTPTR ImageAddr, uint32_t fFlags);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Links a segment into the address space at the give address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * The size of the mapping is determined using RTDbgModSegmentSize().
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_OUT_OF_RANGE if the specified address will put the module
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * outside the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_ADDRESS_CONFLICT if the mapping clashes with existing mappings.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgMod The module handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param iSeg The segment number (0-based) of the segment to be
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * linked in.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param SegAddr The address to link the segment at.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsync * @param fFlags See RTDBGASLINK_FLAGS_*.
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsyncRTDECL(int) RTDbgAsModuleLinkSeg(RTDBGAS hDbgAs, RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR SegAddr, uint32_t fFlags);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Unlinks all the mappings of a module from the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if the module wasn't found.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgMod The module handle of the module to be unlinked.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsModuleUnlink(RTDBGAS hDbgAs, RTDBGMOD hDbgMod);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Unlinks the mapping at the specified address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if no module or segment is mapped at that address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param Addr The address within the mapping to be unlinked.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsModuleUnlinkByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Get a the handle of a module in the address space by is index.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns A retained handle to the specified module. The caller must release
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * the returned reference.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * NIL_RTDBGMOD if invalid index or handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param iModule The index of the module to get.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @remarks The module indexes may change after calls to RTDbgAsModuleLink,
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * RTDbgAsModuleLinkSeg, RTDbgAsModuleUnlink and
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * RTDbgAsModuleUnlinkByAddr.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(RTDBGMOD) RTDbgAsModuleByIndex(RTDBGAS hDbgAs, uint32_t iModule);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Queries mapping module information by handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if no mapping was found at the specified address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param Addr Address within the mapping of the module or segment.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param phMod Where to the return the retained module handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Optional.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pAddr Where to return the base address of the mapping.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Optional.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param piSeg Where to return the segment index. This is set to
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * NIL if the entire module is mapped as a single
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * mapping. Optional.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsModuleByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTDBGMOD phMod, PRTUINTPTR pAddr, PRTDBGSEGIDX piSeg);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Queries mapping module information by name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if no mapping was found at the specified address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_OUT_OF_RANGE if the name index was out of range.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pszName The module name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param iName There can be more than one module by the same name
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * in an address space. This argument indicates which
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * is ment. (0 based)
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param phMod Where to the return the retained module handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsModuleByName(RTDBGAS hDbgAs, const char *pszName, uint32_t iName, PRTDBGMOD phMod);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Adds a symbol to a module in the address space.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code. See RTDbgModSymbolAdd for more specific ones.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if no module was found at the specified address.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @retval VERR_NOT_SUPPORTED if the module interpret doesn't support adding
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * custom symbols.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pszSymbol The symbol name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param Addr The address of the symbol.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param cb The size of the symbol.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param fFlags Symbol flags.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsyncRTDECL(int) RTDbgAsSymbolAdd(RTDBGAS hDbgAs, const char *pszSymbol, RTUINTPTR Addr, RTUINTPTR cb, uint32_t fFlags);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Query a symbol by address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code. See RTDbgModSymbolAddr for more specific ones.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param Addr The address which closest symbol is requested.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param poffDisp Where to return the distance between the symbol
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * and address. Optional.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pSymbol Where to return the symbol info.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsSymbolByAddr(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGSYMBOL pSymbol);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Query a symbol by address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code. See RTDbgModSymbolAddrA for more specific ones.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param Addr The address which closest symbol is requested.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param poffDisp Where to return the distance between the symbol
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * and address. Optional.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param ppSymbol Where to return the pointer to the allocated
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * symbol info. Always set. Free with RTDbgSymbolFree.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsSymbolByAddrA(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymbol);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Query a symbol by name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_SYMBOL_NOT_FOUND if not found.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pszSymbol The symbol name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pSymbol Where to return the symbol info.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsSymbolByName(RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL pSymbol);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Query a symbol by name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_SYMBOL_NOT_FOUND if not found.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pszSymbol The symbol name.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param ppSymbol Where to return the pointer to the allocated
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * symbol info. Always set. Free with RTDbgSymbolFree.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsSymbolByNameA(RTDBGAS hDbgAs, const char *pszSymbol, PRTDBGSYMBOL *ppSymbol);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Query a line number by address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code. See RTDbgModSymbolAddrA for more specific ones.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param Addr The address which closest symbol is requested.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param poffDisp Where to return the distance between the line
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * number and address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param pLine Where to return the line number information.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAs(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGLINE pLine);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * Query a line number by address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @returns IPRT status code. See RTDbgModSymbolAddrA for more specific ones.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_INVALID_HANDLE if hDbgAs is invalid.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @retval VERR_NOT_FOUND if the address couldn't be mapped to a module.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param hDbgAs The address space handle.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param Addr The address which closest symbol is requested.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param poffDisp Where to return the distance between the line
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * number and address.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * @param ppLine Where to return the pointer to the allocated line
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync * number info. Always set. Free with RTDbgLineFree.
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(int) RTDbgAsLineByAddrA(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGLINE *ppLine);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync/** @todo Missing some bits here. */
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsync/** @defgroup grp_rt_dbgmod RTDbgMod - Debug Module Interpreter
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsyncRTDECL(int) RTDbgModCreate(PRTDBGMOD phDbgMod, const char *pszName, RTUINTPTR cb, uint32_t fFlags);
611e5e148a74d4b54cf76c97e4d36acaa816d8c0vboxsyncRTDECL(int) RTDbgModCreateDeferred(PRTDBGMOD phDbgMod, const char *pszFilename, const char *pszName, RTUINTPTR cb, uint32_t fFlags);
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsyncRTDECL(int) RTDbgModCreateFromImage(PRTDBGMOD phDbgMod, const char *pszFilename, const char *pszName, uint32_t fFlags);
9939c713bffcfc4305d99d994552aa2ad9bce097vboxsyncRTDECL(int) RTDbgModCreateFromMap(PRTDBGMOD phDbgMod, const char *pszFilename, const char *pszName, RTUINTPTR uSubtrahend, uint32_t fFlags);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(const char *) RTDbgModName(RTDBGMOD hDbgMod);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(RTUINTPTR) RTDbgModImageSize(RTDBGMOD hDbgMod);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(RTUINTPTR) RTDbgModSegmentSize(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg);
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsyncRTDECL(RTUINTPTR) RTDbgModSegmentRva(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg);
4a1654dd5b9f0ae4e149d909843a3ab07b8bec33vboxsyncRTDECL(RTDBGSEGIDX) RTDbgModSegmentCount(RTDBGMOD hDbgMod);
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsyncRTDECL(int) RTDbgModSymbolAdd(RTDBGMOD hDbgMod, const char *pszSymbol, RTDBGSEGIDX iSeg, RTUINTPTR off, RTUINTPTR cb, uint32_t fFlags);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncRTDECL(uint32_t) RTDbgModSymbolCount(RTDBGMOD hDbgMod);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncRTDECL(int) RTDbgModSymbolByIndex(RTDBGMOD hDbgMod, uint32_t iSymbol, PRTDBGSYMBOL pSymbol);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncRTDECL(int) RTDbgModSymbolByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGSYMBOL pSymbol);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncRTDECL(int) RTDbgModSymbolByAddrA(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGSYMBOL *ppSymbol);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncRTDECL(int) RTDbgModSymbolByName(RTDBGMOD hDbgMod, const char *pszSymbol, PRTDBGSYMBOL pSymbol);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncRTDECL(int) RTDbgModSymbolByNameA(RTDBGMOD hDbgMod, const char *pszSymbol, PRTDBGSYMBOL *ppSymbol);
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsyncRTDECL(int) RTDbgModLineAdd(RTDBGMOD hDbgMod, const char *pszFile, uint32_t uLineNo, RTDBGSEGIDX iSeg, RTUINTPTR off);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncRTDECL(int) RTDbgModLineByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE pLine);