common/dbg/dbgmodcontainer.cpp

	dbgmodcontainer.cpp revision 7af218a7441de38fc9e814919db04bae3e917664
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/*******************************************************************************
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync*   Header Files                                                               *
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync*******************************************************************************/
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#include <iprt/dbg.h>
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#include <iprt/avl.h>
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#include <iprt/err.h>
de6e321f351aa489a6a62bed474390a0056e8093vboxsync#include <iprt/mem.h>
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#include <iprt/string.h>
7af218a7441de38fc9e814919db04bae3e917664vboxsync#include <iprt/strcache.h>
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync#include "internal/dbgmod.h"
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/*******************************************************************************
de6e321f351aa489a6a62bed474390a0056e8093vboxsync*   Structures and Typedefs                                                    *
de6e321f351aa489a6a62bed474390a0056e8093vboxsync*******************************************************************************/
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/**
de6e321f351aa489a6a62bed474390a0056e8093vboxsync * Symbol entry.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync */
de6e321f351aa489a6a62bed474390a0056e8093vboxsynctypedef struct RTDBGMODCONTAINERSYMBOL
de6e321f351aa489a6a62bed474390a0056e8093vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The address core. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    AVLRUINTPTRNODECORE         AddrCore;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The name space core. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTSTRSPACECORE              NameCore;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The segent offset. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTUINTPTR                   off;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The segment index. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTDBGSEGIDX                 iSeg;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync} RTDBGMODCONTAINERSYMBOL;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** Pointer to a symbol entry in the debug info container. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsynctypedef RTDBGMODCONTAINERSYMBOL *PRTDBGMODCONTAINERSYMBOL;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/**
de6e321f351aa489a6a62bed474390a0056e8093vboxsync * Segment entry.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync */
de6e321f351aa489a6a62bed474390a0056e8093vboxsynctypedef struct RTDBGMODCONTAINERSEGMENT
de6e321f351aa489a6a62bed474390a0056e8093vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The segment offset. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTUINTPTR                   off;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The segment size. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTUINTPTR                   cb;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The segment name. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    const char                 *pszName;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync} RTDBGMODCONTAINERSEGMENT;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** Pointer to a segment entry in the debug info container. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsynctypedef RTDBGMODCONTAINERSEGMENT *PRTDBGMODCONTAINERSEGMENT;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/**
de6e321f351aa489a6a62bed474390a0056e8093vboxsync * Instance data.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync */
de6e321f351aa489a6a62bed474390a0056e8093vboxsynctypedef struct RTDBGMODCONTAINER
de6e321f351aa489a6a62bed474390a0056e8093vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The name space. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTSTRSPACE                  Names;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The address space tree. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync    AVLRUINTPTRTREE             Addresses;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** Segment table. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    PRTDBGMODCONTAINERSEGMENT   paSegs;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The number of segments in the segment table. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTDBGSEGIDX                 cSegs;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /** The image size. 0 means unlimited. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTUINTPTR                   cb;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync} RTDBGMODCONTAINER;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** Pointer to instance data for the debug info container. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsynctypedef RTDBGMODCONTAINER *PRTDBGMODCONTAINER;
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** @copydoc RTDBGMODVTDBG::pfnLineByAddr */
7af218a7441de38fc9e814919db04bae3e917664vboxsyncstatic DECLCALLBACK(int) rtDbgModContainer_LineByAddr(PRTDBGMODINT pMod, RTDBGSEGIDX iSeg, RTGCUINTPTR off, PRTGCINTPTR poffDisp, PRTDBGLINE pLine)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync{
7af218a7441de38fc9e814919db04bae3e917664vboxsync    /** @todo Make it possible to add line numbers. */
7af218a7441de38fc9e814919db04bae3e917664vboxsync    return VERR_DBG_NO_LINE_NUMBERS;
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync}
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** @copydoc RTDBGMODVTDBG::pfnSymbolByAddr */
7af218a7441de38fc9e814919db04bae3e917664vboxsyncstatic DECLCALLBACK(int) rtDbgModContainer_SymbolByAddr(PRTDBGMODINT pMod, RTDBGSEGIDX iSeg, RTGCUINTPTR off, PRTGCINTPTR poffDisp, PRTDBGSYMBOL pSymbol)
de6e321f351aa489a6a62bed474390a0056e8093vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    return VINF_SUCCESS;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync}
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** @copydoc RTDBGMODVTDBG::pfnSymbolByName */
de6e321f351aa489a6a62bed474390a0056e8093vboxsyncstatic DECLCALLBACK(int) rtDbgModContainer_SymbolByName(PRTDBGMODINT pMod, const char *pszSymbol, PRTDBGSYMBOL pSymbol)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync{
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    return VINF_SUCCESS;
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync}
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** @copydoc RTDBGMODVTDBG::pfnSymbolAdd */
7af218a7441de38fc9e814919db04bae3e917664vboxsyncstatic DECLCALLBACK(int) rtDbgModContainer_SymbolAdd(PRTDBGMODINT pMod, const char *pszSymbol, RTDBGSEGIDX iSeg, RTGCUINTPTR off, uint32_t cbSymbol)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync{
7af218a7441de38fc9e814919db04bae3e917664vboxsync    PRTDBGMODCONTAINER pThis = (PRTDBGMODCONTAINER)pMod->pvDbgPriv;
7af218a7441de38fc9e814919db04bae3e917664vboxsync
7af218a7441de38fc9e814919db04bae3e917664vboxsync    /*
7af218a7441de38fc9e814919db04bae3e917664vboxsync     * Address validation. The other arguments have already been validated.
7af218a7441de38fc9e814919db04bae3e917664vboxsync     */
7af218a7441de38fc9e814919db04bae3e917664vboxsync    AssertMsgReturn(    (   iSeg >= RTDBGSEGIDX_SPECIAL_FIRST
7af218a7441de38fc9e814919db04bae3e917664vboxsync                         && iSeg <= RTDBGSEGIDX_SPECIAL_LAST)
7af218a7441de38fc9e814919db04bae3e917664vboxsync                    ||  iSeg < pThis->cSegs,
7af218a7441de38fc9e814919db04bae3e917664vboxsync                    ("iSeg=%x cSegs=%x\n", pThis->cSegs),
7af218a7441de38fc9e814919db04bae3e917664vboxsync                    VERR_DBG_INVALID_SEGMENT_INDEX);
7af218a7441de38fc9e814919db04bae3e917664vboxsync    AssertMsgReturn(    iSeg >= RTDBGSEGIDX_SPECIAL_FIRST
7af218a7441de38fc9e814919db04bae3e917664vboxsync                    ||  pThis->paSegs[iSeg].cb <= off + cbSymbol,
7af218a7441de38fc9e814919db04bae3e917664vboxsync                    ("off=%RTptr cbSymbol=%RTptr cbSeg=%RTptr\n", off, cbSymbol, pThis->paSegs[iSeg].cb),
7af218a7441de38fc9e814919db04bae3e917664vboxsync                    VERR_DBG_INVALID_SEGMENT_OFFSET);
7af218a7441de38fc9e814919db04bae3e917664vboxsync
7af218a7441de38fc9e814919db04bae3e917664vboxsync    /*
7af218a7441de38fc9e814919db04bae3e917664vboxsync     * Create a new entry.
7af218a7441de38fc9e814919db04bae3e917664vboxsync     */
7af218a7441de38fc9e814919db04bae3e917664vboxsync    PRTDBGMODCONTAINERSYMBOL pSymbol = (PRTDBGMODCONTAINERSYMBOL)RTMemAllocZ(sizeof(*pSymbol));
7af218a7441de38fc9e814919db04bae3e917664vboxsync    if (!pSymbol)
7af218a7441de38fc9e814919db04bae3e917664vboxsync        return VERR_NO_MEMORY;
7af218a7441de38fc9e814919db04bae3e917664vboxsync
7af218a7441de38fc9e814919db04bae3e917664vboxsync#if 0 /* continue on the workstation */
7af218a7441de38fc9e814919db04bae3e917664vboxsync    pSymbol->AddrCore.Key     = iSeg < RTDBGSEGIDX_SPECIAL_FIRST
7af218a7441de38fc9e814919db04bae3e917664vboxsync                              ? pThis->paSegs->off + off
7af218a7441de38fc9e814919db04bae3e917664vboxsync                              : off;
7af218a7441de38fc9e814919db04bae3e917664vboxsync    pSymbol->AddrCore.KeyLast = pSymbol->AddrCore.Key + cbSymbol;
7af218a7441de38fc9e814919db04bae3e917664vboxsync    pSymbol->off  = off;
7af218a7441de38fc9e814919db04bae3e917664vboxsync    pSymbol->iSeg = iSeg;
7af218a7441de38fc9e814919db04bae3e917664vboxsync    pSymbol->NameCore.pszString = RTStrCacheEnter(g_hDbgModStrCache, pszSymbol);
7af218a7441de38fc9e814919db04bae3e917664vboxsync    if (pSymbol->NameCore.pszString)
7af218a7441de38fc9e814919db04bae3e917664vboxsync    {
7af218a7441de38fc9e814919db04bae3e917664vboxsync        if (RTStrSpaceInsert(&pThis->Names, &pSymbol->NameCore))
7af218a7441de38fc9e814919db04bae3e917664vboxsync        {
7af218a7441de38fc9e814919db04bae3e917664vboxsync            if (RTStrSpaceInsert(&pThis->Names, &pSymbol->NameCore))
7af218a7441de38fc9e814919db04bae3e917664vboxsync            {
7af218a7441de38fc9e814919db04bae3e917664vboxsync
7af218a7441de38fc9e814919db04bae3e917664vboxsync            }
7af218a7441de38fc9e814919db04bae3e917664vboxsync        }
7af218a7441de38fc9e814919db04bae3e917664vboxsync    }
7af218a7441de38fc9e814919db04bae3e917664vboxsync#endif
7af218a7441de38fc9e814919db04bae3e917664vboxsyncint rc = VERR_NOT_IMPLEMENTED;
7af218a7441de38fc9e814919db04bae3e917664vboxsync
7af218a7441de38fc9e814919db04bae3e917664vboxsync    return rc;
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync}
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** Destroy a symbol node. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsyncstatic DECLCALLBACK(int)  rtDbgModContainer_DestroyTreeNode(PAVLRUINTPTRNODECORE pNode, void *pvUser)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    PRTDBGMODCONTAINERSYMBOL pSym = RT_FROM_MEMBER(pNode, RTDBGMODCONTAINERSYMBOL, AddrCore);
7af218a7441de38fc9e814919db04bae3e917664vboxsync    RTStrCacheRelease(g_hDbgModStrCache, pSym->NameCore.pszString);
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTMemFree(pSym);
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    return 0;
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync}
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** @copydoc RTDBGMODVTDBG::pfnClose */
de6e321f351aa489a6a62bed474390a0056e8093vboxsyncstatic DECLCALLBACK(int) rtDbgModContainer_Close(PRTDBGMODINT pMod)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    PRTDBGMODCONTAINER pThis = (PRTDBGMODCONTAINER)pMod->pvDbgPriv;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /*
de6e321f351aa489a6a62bed474390a0056e8093vboxsync     * Destroy the symbols and instance data.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync     */
7af218a7441de38fc9e814919db04bae3e917664vboxsync    RTAvlrUIntPtrDestroy(&pThis->Addresses, rtDbgModContainer_DestroyTreeNode, NULL);
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pThis->Names = NULL;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTMemFree(pThis->paSegs);
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pThis->paSegs = NULL;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    RTMemFree(pThis);
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    return VINF_SUCCESS;
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync}
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/** @copydoc RTDBGMODVTDBG::pfnTryOpen */
de6e321f351aa489a6a62bed474390a0056e8093vboxsyncstatic DECLCALLBACK(int) rtDbgModContainer_TryOpen(PRTDBGMODINT pMod)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    return VERR_INTERNAL_ERROR_5;
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync}
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync/** Virtual function table for the debug info container. */
de6e321f351aa489a6a62bed474390a0056e8093vboxsyncstatic RTDBGMODVTDBG const g_rtDbgModVtDbgContainer =
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync{
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.u32Magic = */            RTDBGMODVTDBG_MAGIC,
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.fSupports = */           0, ///@todo iprt/types.h isn't up to date...
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    /*.pszName = */             "container",
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.pfnTryOpen = */          rtDbgModContainer_TryOpen,
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.pfnClose = */            rtDbgModContainer_Close,
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.pfnSymbolAdd = */        rtDbgModContainer_SymbolAdd,
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.pfnSymbolByName = */     rtDbgModContainer_SymbolByName,
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.pfnSymbolByAddr = */     rtDbgModContainer_SymbolByAddr,
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.pfnLineByAddr = */       rtDbgModContainer_LineByAddr,
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync    /*.u32EndMagic = */         RTDBGMODVTDBG_MAGIC
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync};
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync/**
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Creates a generic debug info container and associates it with the module.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync *
de6e321f351aa489a6a62bed474390a0056e8093vboxsync * @returns IPRT status code.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync * @param   pMod        The module instance.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync * @param   cb          The module size.
de6e321f351aa489a6a62bed474390a0056e8093vboxsync */
de6e321f351aa489a6a62bed474390a0056e8093vboxsyncint rtDbgModContainerCreate(PRTDBGMODINT pMod, RTUINTPTR cb)
de6e321f351aa489a6a62bed474390a0056e8093vboxsync{
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    PRTDBGMODCONTAINER pThis = (PRTDBGMODCONTAINER)RTMemAlloc(sizeof(*pThis));
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    if (!pThis)
de6e321f351aa489a6a62bed474390a0056e8093vboxsync        return VERR_NO_MEMORY;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pThis->Names = NULL;
7af218a7441de38fc9e814919db04bae3e917664vboxsync    pThis->Addresses = NULL;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pThis->paSegs = NULL;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pThis->cSegs = 0;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pThis->cb = cb;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pMod->pDbgVt = &g_rtDbgModVtDbgContainer;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    pMod->pvDbgPriv = pThis;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync    return VINF_SUCCESS;
de6e321f351aa489a6a62bed474390a0056e8093vboxsync}
de6e321f351aa489a6a62bed474390a0056e8093vboxsync