3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * IPRT - Internal Header for RTDbgMod and the associated interpreters.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2008-2012 Oracle Corporation
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.
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync/** @addtogroup grp_rt_dbgmod
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @internal
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to the internal module structure. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Virtual method table for executable image interpreters.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Magic number (RTDBGMODVTIMG_MAGIC). */
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** Reserved. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The name of the interpreter. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Try open the image.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * This combines probing and opening.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code. No informational returns defined.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pMod Pointer to the module that is being opened.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * The RTDBGMOD::pszDbgFile member will point to
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * the filename of any debug info we're aware of
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * on input. Also, or alternatively, it is expected
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * that the interpreter will look for debug info in
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * the executable image file when present and that it
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * may ask the image interpreter for this when it's
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Upon successful return the method is expected to
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * initialize pImgOps and pvImgPriv.
6ba706e9f431401d425d16817fdcd6316f83b584vboxsync * @param enmArch The desired architecture.
6ba706e9f431401d425d16817fdcd6316f83b584vboxsync DECLCALLBACKMEMBER(int, pfnTryOpen)(PRTDBGMODINT pMod, RTLDRARCH enmArch);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Close the interpreter, freeing all associated resources.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * The caller sets the pDbgOps and pvDbgPriv RTDBGMOD members
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * to NULL upon return.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pMod Pointer to the module structure.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync DECLCALLBACKMEMBER(int, pfnClose)(PRTDBGMODINT pMod);
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Enumerate the debug info contained in the executable image.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * Identical to RTLdrEnumDbgInfo.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * @returns IPRT status code or whatever pfnCallback returns.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param pMod Pointer to the module structure.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * @param pfnCallback The callback function. Ignore the module
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * handle argument!
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync * @param pvUser The user argument.
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync DECLCALLBACKMEMBER(int, pfnEnumDbgInfo)(PRTDBGMODINT pMod, PFNRTLDRENUMDBG pfnCallback, void *pvUser);
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * Enumerate the segments in the executable image.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * Identical to RTLdrEnumSegments.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * @returns IPRT status code or whatever pfnCallback returns.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * @param pMod Pointer to the module structure.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * @param pfnCallback The callback function. Ignore the module
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * handle argument!
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * @param pvUser The user argument.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync DECLCALLBACKMEMBER(int, pfnEnumSegments)(PRTDBGMODINT pMod, PFNRTLDRENUMSEGS pfnCallback, void *pvUser);
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * Enumerates the symbols exported by the module.
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * @returns iprt status code, which might have been returned by pfnCallback.
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * @param pMod Pointer to the module structure.
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * @param fFlags Flags indicating what to return and such.
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * @param BaseAddress The image base addressto use when calculating the
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * symbol values.
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * @param pfnCallback The callback function which each symbol is to be fed
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync * @param pvUser User argument to pass to the enumerator.
abe1b07126bb9f5644b2ad8424534c2d1e97a66cvboxsync DECLCALLBACKMEMBER(int, pfnEnumSymbols)(PRTDBGMODINT pMod, uint32_t fFlags, RTLDRADDR BaseAddress,
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * Gets the size of the loaded image.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * Identical to RTLdrSize.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * @returns The size in bytes, RTUINTPTR_MAX on failure.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync * @param pMod Pointer to the module structure.
d3dea25ec07f6546715fe3af943ea863294b392evboxsync DECLCALLBACKMEMBER(RTUINTPTR, pfnImageSize)(PRTDBGMODINT pMod);
4bf996d915405be92dc4394b2db1395e00e14d58vboxsync * Converts a link address to a segment:offset address (RVA included).
4bf996d915405be92dc4394b2db1395e00e14d58vboxsync * @returns IPRT status code.
4bf996d915405be92dc4394b2db1395e00e14d58vboxsync * @param pMod Pointer to the module structure.
4bf996d915405be92dc4394b2db1395e00e14d58vboxsync * @param LinkAddress The link address to convert.
4bf996d915405be92dc4394b2db1395e00e14d58vboxsync * @param piSeg The segment index.
4bf996d915405be92dc4394b2db1395e00e14d58vboxsync * @param poffSeg Where to return the segment offset.
4bf996d915405be92dc4394b2db1395e00e14d58vboxsync DECLCALLBACKMEMBER(int, pfnLinkAddressToSegOffset)(PRTDBGMODINT pMod, RTLDRADDR LinkAddress,
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * Converts an image relative virtual address to a segment:offset.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * @returns IPRT status code.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * @param pMod Pointer to the loader module structure.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * @param Rva The RVA to convert.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * @param piSeg The segment index.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * @param poffSeg Where to return the segment offset.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync DECLCALLBACKMEMBER(int, pfnRvaToSegOffset)(PRTDBGMODINT pMod, RTLDRADDR Rva, uint32_t *piSeg, PRTLDRADDR poffSeg);
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * Creates a read-only mapping of a part of the image file.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @returns IPRT status code and *ppvMap set on success.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param pMod Pointer to the module structure.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * @param iDbgInfo The debug info ordinal number if the request
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * corresponds exactly to a debug info part from
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * pfnEnumDbgInfo. Otherwise, pass UINT32_MAX.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param off The offset into the image file.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param cb The number of bytes to map.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param ppvMap Where to return the mapping address on success.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync * @remarks Fixups will only be applied if @a iDbgInfo is specified.
3bb3e26b3306b9f62b18c17380bdf2ca3a98ca49vboxsync DECLCALLBACKMEMBER(int, pfnMapPart)(PRTDBGMODINT pMod, uint32_t iDbgInfo, RTFOFF off, size_t cb, void const **ppvMap);
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * Unmaps memory previously mapped by pfnMapPart.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @returns IPRT status code, *ppvMap set to NULL on success.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param pMod Pointer to the module structure.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param cb The size of the mapping.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * @param ppvMap The mapping address on input, NULL on
5b0a093ca572a855886faa6747ad46df859dd041vboxsync * successful return.
5b0a093ca572a855886faa6747ad46df859dd041vboxsync DECLCALLBACKMEMBER(int, pfnUnmapPart)(PRTDBGMODINT pMod, size_t cb, void const **ppvMap);
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * Reads data from the image file.
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * @returns IPRT status code, *ppvMap set to NULL on success.
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * @param pMod Pointer to the module structure.
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * @param iDbgInfoHint The debug info ordinal number hint, pass UINT32_MAX
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * if not know or sure.
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * @param off The offset into the image file.
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * @param pvBuf The buffer to read into.
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync * @param cb The number of bytes to read.
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsync DECLCALLBACKMEMBER(int, pfnReadAt)(PRTDBGMODINT pMod, uint32_t iDbgInfoHint, RTFOFF off, void *pvBuf, size_t cb);
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync * Gets the image format.
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync * @returns Valid image format on success, RTLDRFMT_INVALID if not supported.
6ba706e9f431401d425d16817fdcd6316f83b584vboxsync * @param pMod Pointer to the module structure.
6ba706e9f431401d425d16817fdcd6316f83b584vboxsync DECLCALLBACKMEMBER(RTLDRFMT, pfnGetFormat)(PRTDBGMODINT pMod);
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync * Gets the image architecture.
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync * @returns Valid image architecutre on success, RTLDRARCH_WHATEVER if not
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync * supported.
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync * @param pMod Pointer to the module structure.
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync DECLCALLBACKMEMBER(RTLDRARCH, pfnGetArch)(PRTDBGMODINT pMod);
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync * Generic method for querying image properties.
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync * @returns IPRT status code.
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync * @param pMod Pointer to the module structure.
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync * @param enmLdrProp The property to query.
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync * @param pvBuf Pointer to the return buffer.
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync * @param cbBuf The size of the return buffer.
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync * @sa RTLdrQueryProp
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync DECLCALLBACKMEMBER(int, pfnQueryProp)(PRTDBGMODINT pMod, RTLDRPROP enmProp, void *pvBuf, size_t cbBuf);
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsync /** For catching initialization errors (RTDBGMODVTIMG_MAGIC). */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to a const RTDBGMODVTIMG. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Virtual method table for debug info interpreters.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Magic number (RTDBGMODVTDBG_MAGIC). */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Mask of supported debug info types, see grp_rt_dbg_type.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Used to speed up the search for a suitable interpreter. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The name of the interpreter. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Try open the image.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * This combines probing and opening.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code. No informational returns defined.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pMod Pointer to the module that is being opened.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * The RTDBGMOD::pszDbgFile member will point to
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * the filename of any debug info we're aware of
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * on input. Also, or alternatively, it is expected
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * that the interpreter will look for debug info in
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * the executable image file when present and that it
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * may ask the image interpreter for this when it's
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Upon successful return the method is expected to
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * initialize pDbgOps and pvDbgPriv.
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync * @param enmArch The desired architecture.
d1e9999d55e7ac80a28692c161710be98071fc00vboxsync DECLCALLBACKMEMBER(int, pfnTryOpen)(PRTDBGMODINT pMod, RTLDRARCH enmArch);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Close the interpreter, freeing all associated resources.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * The caller sets the pDbgOps and pvDbgPriv RTDBGMOD members
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * to NULL upon return.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pMod Pointer to the module structure.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync DECLCALLBACKMEMBER(int, pfnClose)(PRTDBGMODINT pMod);
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * Converts an image relative virtual address address to a segmented address.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @returns Segment index on success, NIL_RTDBGSEGIDX on failure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param pMod Pointer to the module structure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param uRva The image relative address to convert.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param poffSeg Where to return the segment offset. Optional.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync DECLCALLBACKMEMBER(RTDBGSEGIDX, pfnRvaToSegOff)(PRTDBGMODINT pMod, RTUINTPTR uRva, PRTUINTPTR poffSeg);
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * Image size when mapped if segments are mapped adjacently.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync * For ELF, PE, and Mach-O images this is (usually) a natural query, for LX and
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync * NE and such it's a bit odder and the answer may not make much sense for them.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync * @returns Image mapped size.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync * @param pMod Pointer to the module structure.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync DECLCALLBACKMEMBER(RTUINTPTR, pfnImageSize)(PRTDBGMODINT pMod);
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Adds a segment to the module (optional).
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_NOT_SUPPORTED if the interpreter doesn't support this feature.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_SEGMENT_INDEX_CONFLICT if the segment index exists already.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pMod Pointer to the module structure.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param uRva The segment image relative address.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param cb The segment size.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pszName The segment name.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param cchName The length of the segment name.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param fFlags Segment flags.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param piSeg The segment index or NIL_RTDBGSEGIDX on input.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * The assigned segment index on successful return.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Optional.
044af0d1e6474076366759db86f101778c5f20ccvboxsync DECLCALLBACKMEMBER(int, pfnSegmentAdd)(PRTDBGMODINT pMod, RTUINTPTR uRva, RTUINTPTR cb, const char *pszName, size_t cchName,
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Gets the segment count.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns Number of segments.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval NIL_RTDBGSEGIDX if unknown.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pMod Pointer to the module structure.
044af0d1e6474076366759db86f101778c5f20ccvboxsync DECLCALLBACKMEMBER(RTDBGSEGIDX, pfnSegmentCount)(PRTDBGMODINT pMod);
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Gets information about a segment.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_INVALID_SEGMENT_INDEX if iSeg is too high.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pMod Pointer to the module structure.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param iSeg The segment.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pSegInfo Where to store the segment information.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync DECLCALLBACKMEMBER(int, pfnSegmentByIndex)(PRTDBGMODINT pMod, RTDBGSEGIDX iSeg, PRTDBGSEGMENT pSegInfo);
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * Adds a symbol to the module (optional).
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT code.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * @retval VERR_NOT_SUPPORTED if the interpreter doesn't support this feature.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * @param pMod Pointer to the module structure.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * @param pszSymbol The symbol name.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param cchSymbol The length for the symbol name.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * @param iSeg The segment number (0-based). RTDBGMOD_SEG_RVA can be used.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync * @param off The offset into the segment.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param cb The area covered by the symbol. 0 is fine.
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync * @param fFlags Flags.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param piOrdinal Where to return the symbol ordinal on success. If the
044af0d1e6474076366759db86f101778c5f20ccvboxsync * interpreter doesn't do ordinals, this will be set to
044af0d1e6474076366759db86f101778c5f20ccvboxsync * UINT32_MAX. Optional
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync DECLCALLBACKMEMBER(int, pfnSymbolAdd)(PRTDBGMODINT pMod, const char *pszSymbol, size_t cchSymbol,
044af0d1e6474076366759db86f101778c5f20ccvboxsync uint32_t iSeg, RTUINTPTR off, RTUINTPTR cb, uint32_t fFlags,
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Gets the number of symbols in the module.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * This is used for figuring out the max value to pass to pfnSymbolByIndex among
044af0d1e6474076366759db86f101778c5f20ccvboxsync * other things.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns The number of symbols, UINT32_MAX if not known/supported.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pMod Pointer to the module structure.
044af0d1e6474076366759db86f101778c5f20ccvboxsync DECLCALLBACKMEMBER(uint32_t, pfnSymbolCount)(PRTDBGMODINT pMod);
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Queries symbol information by ordinal number.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VINF_SUCCESS on success, no informational status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_NOT_SUPPORTED if lookup by ordinal is not supported.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_SYMBOL_NOT_FOUND if there is no symbol at that index.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pMod Pointer to the module structure.
a1df400bbe9d64aad400442e56eb637019300a5evboxsync * @param iOrdinal The symbol ordinal number.
a1df400bbe9d64aad400442e56eb637019300a5evboxsync * @param pSymInfo Where to store the symbol information.
a1df400bbe9d64aad400442e56eb637019300a5evboxsync DECLCALLBACKMEMBER(int, pfnSymbolByOrdinal)(PRTDBGMODINT pMod, uint32_t iOrdinal, PRTDBGSYMBOL pSymInfo);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Queries symbol information by symbol name.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @retval VINF_SUCCESS on success, no informational status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pMod Pointer to the module structure.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pszSymbol The symbol name.
a1df400bbe9d64aad400442e56eb637019300a5evboxsync * @param cchSymbol The length of the symbol name.
a1df400bbe9d64aad400442e56eb637019300a5evboxsync * @param pSymInfo Where to store the symbol information.
a1df400bbe9d64aad400442e56eb637019300a5evboxsync DECLCALLBACKMEMBER(int, pfnSymbolByName)(PRTDBGMODINT pMod, const char *pszSymbol, size_t cchSymbol, PRTDBGSYMBOL pSymInfo);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Queries symbol information by address.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * The returned symbol is what the debug info interpreter considers the symbol
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * most applicable to the specified address. This usually means a symbol with an
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * address equal or lower than the requested.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @retval VINF_SUCCESS on success, no informational status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_NO_SYMBOLS if there aren't any symbols.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @retval VERR_SYMBOL_NOT_FOUND if no suitable symbol was found.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pMod Pointer to the module structure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param iSeg The segment number (0-based) or RTDBGSEGIDX_ABS.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param off The offset into the segment.
2d8870843ff566fee9bd3a6a5942414254106479vboxsync * @param fFlags Symbol search flags, see RTDBGSYMADDR_FLAGS_XXX.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param poffDisp Where to store the distance between the specified address
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * and the returned symbol. Optional.
a1df400bbe9d64aad400442e56eb637019300a5evboxsync * @param pSymInfo Where to store the symbol information.
2d8870843ff566fee9bd3a6a5942414254106479vboxsync DECLCALLBACKMEMBER(int, pfnSymbolByAddr)(PRTDBGMODINT pMod, uint32_t iSeg, RTUINTPTR off, uint32_t fFlags,
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * Adds a line number to the module (optional).
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @retval VERR_NOT_SUPPORTED if the interpreter doesn't support this feature.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param pMod Pointer to the module structure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param pszFile The filename.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param cchFile The length of the filename.
88acfa6629a7976c0583c1712d2b5b22a87a5121vboxsync * @param uLineNo The line number.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param iSeg The segment number (0-based).
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param off The offset into the segment.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param piOrdinal Where to return the line number ordinal on success. If
044af0d1e6474076366759db86f101778c5f20ccvboxsync * the interpreter doesn't do ordinals, this will be set to
044af0d1e6474076366759db86f101778c5f20ccvboxsync * UINT32_MAX. Optional
044af0d1e6474076366759db86f101778c5f20ccvboxsync DECLCALLBACKMEMBER(int, pfnLineAdd)(PRTDBGMODINT pMod, const char *pszFile, size_t cchFile, uint32_t uLineNo,
044af0d1e6474076366759db86f101778c5f20ccvboxsync uint32_t iSeg, RTUINTPTR off, uint32_t *piOrdinal);
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Gets the number of line numbers in the module.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns The number or UINT32_MAX if not known/supported.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pMod Pointer to the module structure.
044af0d1e6474076366759db86f101778c5f20ccvboxsync DECLCALLBACKMEMBER(uint32_t, pfnLineCount)(PRTDBGMODINT pMod);
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Queries line number information by ordinal number.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VINF_SUCCESS on success, no informational status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_LINE_NOT_FOUND if there is no line number with that
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pMod Pointer to the module structure.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param iOrdinal The line number ordinal number.
df8e6a449f00e1884fbf4a1fc67143614d7d528dvboxsync * @param pLineInfo Where to store the information about the line number.
df8e6a449f00e1884fbf4a1fc67143614d7d528dvboxsync DECLCALLBACKMEMBER(int, pfnLineByOrdinal)(PRTDBGMODINT pMod, uint32_t iOrdinal, PRTDBGLINE pLineInfo);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Queries line number information by address.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns IPRT status code.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @retval VINF_SUCCESS on success, no informational status code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_NO_LINE_NUMBERS if there aren't any line numbers.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @retval VERR_DBG_LINE_NOT_FOUND if no suitable line number was found.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pMod Pointer to the module structure.
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync * @param iSeg The segment number (0-based) or RTDBGSEGIDX_ABS.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param off The offset into the segment.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param poffDisp Where to store the distance between the specified address
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * and the returned line number. Optional.
df8e6a449f00e1884fbf4a1fc67143614d7d528dvboxsync * @param pLineInfo Where to store the information about the closest line
df8e6a449f00e1884fbf4a1fc67143614d7d528dvboxsync DECLCALLBACKMEMBER(int, pfnLineByAddr)(PRTDBGMODINT pMod, uint32_t iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE pLineInfo);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** For catching initialization errors (RTDBGMODVTDBG_MAGIC). */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Pointer to a const RTDBGMODVTDBG. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * Deferred loading callback.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @returns IPRT status code. On success the necessary method tables should be
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * installed in @a pMod.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @param pMod Pointer to the debug module structure.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * @param pDeferred The deferred load data.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsynctypedef DECLCALLBACK(int) FNRTDBGMODDEFERRED(PRTDBGMODINT pMod, struct RTDBGMODDEFERRED *pDeferred);
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync/** Pointer to a deferred loading callback. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * Structure pointed to by pvDbgPriv and/or pvImgPriv when
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * g_rtDbgModVtDbgDeferred and/or g_rtDbgModVtImgDeferred are being used.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The image size.
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * Deferred loading is almost pointless without knowing the module size, as
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * it cannot be mapped (correctly) without it. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Reference counter. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The configuration instance (referenced), can be NIL. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Performs deferred loading of the module. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Callback specific data. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The time/date stamp of the executable image and codeview file. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The PDB uuid. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The PDB age. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** The CRC-32 value found in the .gnu_debuglink section. */
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync /** The image UUID. */
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync /** Image architecture. */
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync /** Number of segment mappings. */
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync /** Segment mappings. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync/** Pointer to the deferred loading data. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Debug module structure.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Magic value (RTDBGMOD_MAGIC). */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync /** The number of reference there are to this module.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * This is used to perform automatic cleanup and sharing. */
ae83ea510012552d3286d67b41abddf158ca6654vboxsync /** The module tag. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** When set, the loading of the image and debug info (including locating any
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync * external files), will not have taken place yet. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Set if deferred loading failed. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Set if the debug info is based on image exports and segments. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Alignment padding. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The module name (short). */
e9525bea57dc13d82fd3392913aebb33d2cb79e3vboxsync /** The image file specified by the user. Can be NULL. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The module filename. Can be NULL. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The debug info file (if external). Can be NULL. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The method table for the executable image interpreter. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Pointer to the private data of the executable image interpreter. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** The method table for the debug info interpreter. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Pointer to the private data of the debug info interpreter. */
daa94352f51be2329ac8660f70396e03a7cb983bvboxsync /** Critical section serializing access to the module. */
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Pointer to an debug module structure. */
e8859cfff41731e3688972d64cf6d5575addcd8fvboxsyncextern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgCodeView;
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsyncextern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgDwarf;
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsyncextern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgNm;
e36f03470adaee73199dcdddd8eb9cf39bbdf7advboxsyncextern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgDbgHelp;
daa94352f51be2329ac8660f70396e03a7cb983bvboxsyncextern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgDeferred;
31771163041e3661403a806eb3382d2a165c003bvboxsyncextern DECLHIDDEN(RTDBGMODVTDBG const) g_rtDbgModVtDbgContainer;
c58c758d3642ac45d3f12356c406c631fcd8f538vboxsyncextern DECLHIDDEN(RTDBGMODVTIMG const) g_rtDbgModVtImgLdr;
daa94352f51be2329ac8660f70396e03a7cb983bvboxsyncextern DECLHIDDEN(RTDBGMODVTIMG const) g_rtDbgModVtImgDeferred;
daa94352f51be2329ac8660f70396e03a7cb983bvboxsyncDECLHIDDEN(int) rtDbgModContainerCreate(PRTDBGMODINT pMod, RTUINTPTR cbSeg);
31771163041e3661403a806eb3382d2a165c003bvboxsyncDECLHIDDEN(int) rtDbgModContainer_SymbolRemoveAll(PRTDBGMODINT pMod);
31771163041e3661403a806eb3382d2a165c003bvboxsyncDECLHIDDEN(int) rtDbgModContainer_LineRemoveAll(PRTDBGMODINT pMod);
31771163041e3661403a806eb3382d2a165c003bvboxsyncDECLHIDDEN(int) rtDbgModContainer_RemoveAll(PRTDBGMODINT pMod);
daa94352f51be2329ac8660f70396e03a7cb983bvboxsyncDECLHIDDEN(int) rtDbgModCreateForExports(PRTDBGMODINT pDbgMod);
daa94352f51be2329ac8660f70396e03a7cb983bvboxsyncDECLHIDDEN(int) rtDbgModDeferredCreate(PRTDBGMODINT pDbgMod, PFNRTDBGMODDEFERRED pfnDeferred, RTUINTPTR cbImage,
2a2b173b54c259e34320ce0acf26f18e9382ce2avboxsync RTDBGCFG hDbgCfg, size_t cbDeferred, PRTDBGMODDEFERRED *ppDeferred);