| 1 | /* $Id: dbgmodexports.cpp 49768 2013-12-04 09:57:44Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Debug Module Using Image Exports.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2013 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 | * The contents of this file may alternatively be used under the terms
|
|---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 22 | *
|
|---|
| 23 | * You may elect to license modified versions of this file under the
|
|---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 |
|
|---|
| 28 | /*******************************************************************************
|
|---|
| 29 | * Header Files *
|
|---|
| 30 | *******************************************************************************/
|
|---|
| 31 | #define LOG_GROUP RTLOGGROUP_DBG
|
|---|
| 32 | #include <iprt/dbg.h>
|
|---|
| 33 | #include "internal/iprt.h"
|
|---|
| 34 |
|
|---|
| 35 | #include <iprt/alloca.h>
|
|---|
| 36 | #include <iprt/assert.h>
|
|---|
| 37 | #include <iprt/err.h>
|
|---|
| 38 | #include <iprt/log.h>
|
|---|
| 39 | #include <iprt/string.h>
|
|---|
| 40 | #include "internal/dbgmod.h"
|
|---|
| 41 |
|
|---|
| 42 |
|
|---|
| 43 | /*******************************************************************************
|
|---|
| 44 | * Structures and Typedefs *
|
|---|
| 45 | *******************************************************************************/
|
|---|
| 46 | typedef struct RTDBGMODEXPORTARGS
|
|---|
| 47 | {
|
|---|
| 48 | PRTDBGMODINT pDbgMod;
|
|---|
| 49 | RTLDRADDR uImageBase;
|
|---|
| 50 | RTLDRADDR uRvaNext;
|
|---|
| 51 | uint32_t cSegs;
|
|---|
| 52 | } RTDBGMODEXPORTARGS;
|
|---|
| 53 | /** Pointer to an argument package. */
|
|---|
| 54 | typedef RTDBGMODEXPORTARGS *PRTDBGMODEXPORTARGS;
|
|---|
| 55 |
|
|---|
| 56 |
|
|---|
| 57 | /** @callback_method_impl{FNRTLDRENUMSYMS,
|
|---|
| 58 | * Copies the symbols over into the container.} */
|
|---|
| 59 | static DECLCALLBACK(int) rtDbgModExportsAddSymbolCallback(RTLDRMOD hLdrMod, const char *pszSymbol, unsigned uSymbol,
|
|---|
| 60 | RTLDRADDR Value, void *pvUser)
|
|---|
| 61 | {
|
|---|
| 62 | PRTDBGMODEXPORTARGS pArgs = (PRTDBGMODEXPORTARGS)pvUser;
|
|---|
| 63 | NOREF(hLdrMod);
|
|---|
| 64 |
|
|---|
| 65 | if (Value >= pArgs->uImageBase)
|
|---|
| 66 | {
|
|---|
| 67 | int rc = RTDbgModSymbolAdd(pArgs->pDbgMod, pszSymbol, RTDBGSEGIDX_RVA, Value - pArgs->uImageBase,
|
|---|
| 68 | 0 /*cb*/, 0 /* fFlags */, NULL /*piOrdinal*/);
|
|---|
| 69 | Log(("Symbol #%05u %#018x %s [%Rrc]\n", uSymbol, Value, pszSymbol, rc)); NOREF(rc);
|
|---|
| 70 | }
|
|---|
| 71 | else
|
|---|
| 72 | Log(("Symbol #%05u %#018x %s [SKIPPED - INVALID ADDRESS]\n", uSymbol, Value, pszSymbol));
|
|---|
| 73 | return VINF_SUCCESS;
|
|---|
| 74 | }
|
|---|
| 75 |
|
|---|
| 76 |
|
|---|
| 77 | /** @callback_method_impl{FNRTLDRENUMSEGS,
|
|---|
| 78 | * Copies the segments over into the container.} */
|
|---|
| 79 | static DECLCALLBACK(int) rtDbgModExportsAddSegmentsCallback(RTLDRMOD hLdrMod, PCRTLDRSEG pSeg, void *pvUser)
|
|---|
| 80 | {
|
|---|
| 81 | PRTDBGMODEXPORTARGS pArgs = (PRTDBGMODEXPORTARGS)pvUser;
|
|---|
| 82 | Log(("Segment %.*s: LinkAddress=%#llx RVA=%#llx cb=%#llx\n",
|
|---|
| 83 | pSeg->cchName, pSeg->pszName, (uint64_t)pSeg->LinkAddress, (uint64_t)pSeg->RVA, pSeg->cb));
|
|---|
| 84 | NOREF(hLdrMod);
|
|---|
| 85 |
|
|---|
| 86 | pArgs->cSegs++;
|
|---|
| 87 |
|
|---|
| 88 | /* Add dummy segments for segments that doesn't get mapped. */
|
|---|
| 89 | if ( pSeg->LinkAddress == NIL_RTLDRADDR
|
|---|
| 90 | || pSeg->RVA == NIL_RTLDRADDR)
|
|---|
| 91 | return RTDbgModSegmentAdd(pArgs->pDbgMod, 0, 0, pSeg->pszName, 0 /*fFlags*/, NULL);
|
|---|
| 92 |
|
|---|
| 93 | RTLDRADDR uRva = pSeg->RVA;
|
|---|
| 94 | #if 0 /* Kluge for the .data..percpu segment in 64-bit linux kernels and similar. (Moved to ELF.) */
|
|---|
| 95 | if (uRva < pArgs->uRvaNext)
|
|---|
| 96 | uRva = RT_ALIGN_T(pArgs->uRvaNext, pSeg->Alignment, RTLDRADDR);
|
|---|
| 97 | #endif
|
|---|
| 98 |
|
|---|
| 99 | /* Find the best base address for the module. */
|
|---|
| 100 | if ( ( !pArgs->uImageBase
|
|---|
| 101 | || pArgs->uImageBase > pSeg->LinkAddress)
|
|---|
| 102 | && ( pSeg->LinkAddress != 0 /* .data..percpu again. */
|
|---|
| 103 | || pArgs->cSegs == 1))
|
|---|
| 104 | pArgs->uImageBase = pSeg->LinkAddress;
|
|---|
| 105 |
|
|---|
| 106 | /* Add it. */
|
|---|
| 107 | RTLDRADDR cb = RT_MAX(pSeg->cb, pSeg->cbMapped);
|
|---|
| 108 | pArgs->uRvaNext = uRva + cb;
|
|---|
| 109 | return RTDbgModSegmentAdd(pArgs->pDbgMod, uRva, cb, pSeg->pszName, 0 /*fFlags*/, NULL);
|
|---|
| 110 | }
|
|---|
| 111 |
|
|---|
| 112 |
|
|---|
| 113 | /**
|
|---|
| 114 | * Creates the debug info side of affairs based on exports and segments found in
|
|---|
| 115 | * the image part.
|
|---|
| 116 | *
|
|---|
| 117 | * The image part must be successfully initialized prior to the call, while the
|
|---|
| 118 | * debug bits must not be present of course.
|
|---|
| 119 | *
|
|---|
| 120 | * @returns IPRT status code
|
|---|
| 121 | * @param pDbgMod The debug module structure.
|
|---|
| 122 | */
|
|---|
| 123 | DECLHIDDEN(int) rtDbgModCreateForExports(PRTDBGMODINT pDbgMod)
|
|---|
| 124 | {
|
|---|
| 125 | AssertReturn(!pDbgMod->pDbgVt, VERR_DBG_MOD_IPE);
|
|---|
| 126 | AssertReturn(pDbgMod->pImgVt, VERR_DBG_MOD_IPE);
|
|---|
| 127 | RTUINTPTR cbImage = pDbgMod->pImgVt->pfnImageSize(pDbgMod);
|
|---|
| 128 | AssertReturn(cbImage > 0, VERR_DBG_MOD_IPE);
|
|---|
| 129 |
|
|---|
| 130 | /*
|
|---|
| 131 | * We simply use a container type for this work.
|
|---|
| 132 | */
|
|---|
| 133 | int rc = rtDbgModContainerCreate(pDbgMod, 0);
|
|---|
| 134 | if (RT_FAILURE(rc))
|
|---|
| 135 | return rc;
|
|---|
| 136 | pDbgMod->fExports = true;
|
|---|
| 137 |
|
|---|
| 138 | /*
|
|---|
| 139 | * Copy the segments and symbols.
|
|---|
| 140 | */
|
|---|
| 141 | RTDBGMODEXPORTARGS Args;
|
|---|
| 142 | Args.pDbgMod = pDbgMod;
|
|---|
| 143 | Args.uImageBase = 0;
|
|---|
| 144 | Args.uRvaNext = 0;
|
|---|
| 145 | Args.cSegs = 0;
|
|---|
| 146 | rc = pDbgMod->pImgVt->pfnEnumSegments(pDbgMod, rtDbgModExportsAddSegmentsCallback, &Args);
|
|---|
| 147 | if (RT_SUCCESS(rc))
|
|---|
| 148 | {
|
|---|
| 149 | rc = pDbgMod->pImgVt->pfnEnumSymbols(pDbgMod, RTLDR_ENUM_SYMBOL_FLAGS_ALL | RTLDR_ENUM_SYMBOL_FLAGS_NO_FWD,
|
|---|
| 150 | Args.uImageBase ? Args.uImageBase : 0x10000,
|
|---|
| 151 | rtDbgModExportsAddSymbolCallback, &Args);
|
|---|
| 152 | if (RT_FAILURE(rc))
|
|---|
| 153 | Log(("rtDbgModCreateForExports: Error during symbol enum: %Rrc\n", rc));
|
|---|
| 154 | }
|
|---|
| 155 | else
|
|---|
| 156 | Log(("rtDbgModCreateForExports: Error during segment enum: %Rrc\n", rc));
|
|---|
| 157 |
|
|---|
| 158 | /* This won't fail. */
|
|---|
| 159 | if (RT_SUCCESS(rc))
|
|---|
| 160 | rc = VINF_SUCCESS;
|
|---|
| 161 | else
|
|---|
| 162 | rc = -rc; /* Change it into a warning. */
|
|---|
| 163 | return rc;
|
|---|
| 164 | }
|
|---|
| 165 |
|
|---|
