ldrNative.cpp revision 6805ae4b939ad0646ed7d4a52696b828e6554bf5
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos/* $Id$ */
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos/** @file
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * IPRT - Binary Image Loader, Native interface.
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos */
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos/*
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * Copyright (C) 2006-2013 Oracle Corporation
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos *
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * This file is part of VirtualBox Open Source Edition (OSE), as
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * available from http://www.virtualbox.org. This file is free software;
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * you can redistribute it and/or modify it under the terms of the GNU
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * General Public License (GPL) as published by the Free Software
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * Foundation, in version 2 as it comes in the "COPYING" file of the
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos *
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * The contents of this file may alternatively be used under the terms
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * of the Common Development and Distribution License Version 1.0
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * VirtualBox OSE distribution, in which case the provisions of the
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * CDDL are applicable instead of those of the GPL.
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos *
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * You may elect to license modified versions of this file under the
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos * terms and conditions of either the GPL or the CDDL or both.
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos */
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos/*******************************************************************************
88f2d7061bb42999901dcff81c37089b000d32e0Paul Bryan* Header Files *
27f054fe098cabdf56be9e73e3c689b9ebdacfc5Laszlo Hordos*******************************************************************************/
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos#define LOG_GROUP RTLOGGROUP_LDR
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include <iprt/ldr.h>
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include "internal/iprt.h"
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
7523c7f44ed55a9882212a3925629e54c1295daePaul Bryan#include <iprt/alloc.h>
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include <iprt/assert.h>
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include <iprt/log.h>
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include <iprt/param.h>
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include <iprt/path.h>
27f054fe098cabdf56be9e73e3c689b9ebdacfc5Laszlo Hordos#include <iprt/string.h>
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include <iprt/err.h>
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos#include "internal/ldr.h"
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos/** @copydoc RTLDROPS::pfnEnumSymbols */
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordosstatic DECLCALLBACK(int) rtldrNativeEnumSymbols(PRTLDRMODINTERNAL pMod, unsigned fFlags, const void *pvBits,
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos RTUINTPTR BaseAddress, PFNRTLDRENUMSYMS pfnCallback, void *pvUser)
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos{
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos NOREF(pMod); NOREF(fFlags); NOREF(pvBits); NOREF(BaseAddress); NOREF(pfnCallback); NOREF(pvUser);
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos return VERR_NOT_SUPPORTED;
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos}
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos/** @copydoc RTLDROPS::pfnDone */
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordosstatic DECLCALLBACK(int) rtldrNativeDone(PRTLDRMODINTERNAL pMod)
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos{
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos NOREF(pMod);
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos return VINF_SUCCESS;
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos}
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos/**
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos * Operations for a native module.
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos */
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordosstatic const RTLDROPS g_rtldrNativeOps =
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos{
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos "native",
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos rtldrNativeClose,
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos rtldrNativeGetSymbol,
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos rtldrNativeDone,
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos rtldrNativeEnumSymbols,
fe644a7302b3235c08aec5fd7992a329f2ee1364Laszlo Hordos /* ext: */
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos NULL,
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos NULL,
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos NULL,
426b667472214430e75fc5ab7f548d1fb57b725aLaszlo Hordos NULL,
88f2d7061bb42999901dcff81c37089b000d32e0Paul Bryan NULL,
0fdda69ce3627d501e4bb3103765f676bb1ab061Laszlo Hordos NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
42
};
/**
* Loads a dynamic load library (/shared object) image file using native
* OS facilities.
*
* The filename will be appended the default DLL/SO extension of
* the platform if it have been omitted. This means that it's not
* possible to load DLLs/SOs with no extension using this interface,
* but that's not a bad tradeoff.
*
* If no path is specified in the filename, the OS will usually search it's library
* path to find the image file.
*
* @returns iprt status code.
* @param pszFilename Image filename.
* @param phLdrMod Where to store the handle to the loaded module.
*/
RTDECL(int) RTLdrLoad(const char *pszFilename, PRTLDRMOD phLdrMod)
{
return RTLdrLoadEx(pszFilename, phLdrMod, RTLDRLOAD_FLAGS_LOCAL, NULL);
}
RT_EXPORT_SYMBOL(RTLdrLoad);
RTDECL(int) RTLdrLoadEx(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo)
{
LogFlow(("RTLdrLoadEx: pszFilename=%p:{%s} phLdrMod=%p fFlags=%#x pErrInfo=%p\n", pszFilename, pszFilename, phLdrMod, fFlags, pErrInfo));
/*
* Validate and massage the input.
*/
RTErrInfoClear(pErrInfo);
AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
AssertPtrReturn(phLdrMod, VERR_INVALID_POINTER);
AssertReturn(!(fFlags & ~RTLDRLOAD_FLAGS_VALID_MASK), VERR_INVALID_PARAMETER);
/*
* Allocate and initialize module structure.
*/
int rc = VERR_NO_MEMORY;
PRTLDRMODNATIVE pMod = (PRTLDRMODNATIVE)RTMemAlloc(sizeof(*pMod));
if (pMod)
{
pMod->Core.u32Magic = RTLDRMOD_MAGIC;
pMod->Core.eState = LDR_STATE_LOADED;
pMod->Core.pOps = &g_rtldrNativeOps;
pMod->Core.pReader = NULL;
pMod->Core.enmFormat = RTLDRFMT_NATIVE;
pMod->Core.enmType = RTLDRTYPE_SHARED_LIBRARY_RELOCATABLE; /* approx */
#ifdef RT_BIG_ENDIAN
pMod->Core.enmEndian = RTLDRENDIAN_BIG;
#else
pMod->Core.enmEndian = RTLDRENDIAN_LITTLE;
#endif
#ifdef RT_ARCH_AMD64
pMod->Core.enmArch = RTLDRARCH_AMD64;
#elif defined(RT_ARCH_X86)
pMod->Core.enmArch = RTLDRARCH_X86_32;
#else
pMod->Core.enmArch = RTLDRARCH_HOST;
#endif
pMod->hNative = ~(uintptr_t)0;
pMod->fFlags = fFlags;
/*
* Attempt to open the module.
*/
rc = rtldrNativeLoad(pszFilename, &pMod->hNative, fFlags, pErrInfo);
if (RT_SUCCESS(rc))
{
*phLdrMod = &pMod->Core;
LogFlow(("RTLdrLoad: returns %Rrc *phLdrMod=%RTldrm\n", rc, *phLdrMod));
return rc;
}
RTMemFree(pMod);
}
else
RTErrInfoSetF(pErrInfo, rc, "Failed to allocate %zu bytes for the module handle", sizeof(*pMod));
*phLdrMod = NIL_RTLDRMOD;
LogFlow(("RTLdrLoad: returns %Rrc\n", rc));
return rc;
}
RT_EXPORT_SYMBOL(RTLdrLoadEx);
RTDECL(int) RTLdrLoadSystem(const char *pszFilename, bool fNoUnload, PRTLDRMOD phLdrMod)
{
LogFlow(("RTLdrLoadSystem: pszFilename=%p:{%s} fNoUnload=%RTbool phLdrMod=%p\n",
pszFilename, pszFilename, fNoUnload, phLdrMod));
/*
* Validate input.
*/
AssertPtrReturn(phLdrMod, VERR_INVALID_PARAMETER);
*phLdrMod = NIL_RTLDRMOD;
AssertPtrReturn(pszFilename, VERR_INVALID_PARAMETER);
AssertMsgReturn(!RTPathHasPath(pszFilename), ("%s\n", pszFilename), VERR_INVALID_PARAMETER);
/*
* Check the filename.
*/
size_t cchFilename = strlen(pszFilename);
AssertMsgReturn(cchFilename < (RTPATH_MAX / 4) * 3, ("%zu\n", cchFilename), VERR_INVALID_PARAMETER);
const char *pszSuffix = "";
if (!RTPathHasSuffix(pszFilename))
pszSuffix = RTLdrGetSuff();
/*
* Let the platform specific code do the rest.
*/
int rc = rtldrNativeLoadSystem(pszFilename, pszSuffix, fNoUnload ? RTLDRLOAD_FLAGS_NO_UNLOAD : 0, phLdrMod);
LogFlow(("RTLdrLoadSystem: returns %Rrc\n", rc));
return rc;
}
RTDECL(void *) RTLdrGetSystemSymbol(const char *pszFilename, const char *pszSymbol)
{
void *pvRet = NULL;
RTLDRMOD hLdrMod;
int rc = RTLdrLoadSystem(pszFilename, true /*fNoUnload*/, &hLdrMod);
if (RT_SUCCESS(rc))
{
rc = RTLdrGetSymbol(hLdrMod, pszSymbol, &pvRet);
if (RT_FAILURE(rc))
pvRet = NULL; /* paranoia */
RTLdrClose(hLdrMod);
}
return pvRet;
}
/**
* Loads a dynamic load library (/shared object) image file residing in the
* RTPathAppPrivateArch() directory.
*
* Suffix is not required.
*
* @returns iprt status code.
* @param pszFilename Image filename. No path.
* @param phLdrMod Where to store the handle to the loaded module.
*/
RTDECL(int) RTLdrLoadAppPriv(const char *pszFilename, PRTLDRMOD phLdrMod)
{
LogFlow(("RTLdrLoadAppPriv: pszFilename=%p:{%s} phLdrMod=%p\n", pszFilename, pszFilename, phLdrMod));
/*
* Validate input.
*/
AssertPtrReturn(phLdrMod, VERR_INVALID_PARAMETER);
*phLdrMod = NIL_RTLDRMOD;
AssertPtrReturn(pszFilename, VERR_INVALID_PARAMETER);
AssertMsgReturn(!RTPathHasPath(pszFilename), ("%s\n", pszFilename), VERR_INVALID_PARAMETER);
/*
* Check the filename.
*/
size_t cchFilename = strlen(pszFilename);
AssertMsgReturn(cchFilename < (RTPATH_MAX / 4) * 3, ("%zu\n", cchFilename), VERR_INVALID_PARAMETER);
const char *pszSuffix = "";
size_t cchSuffix = 0;
if (!RTPathHasSuffix(pszFilename))
{
pszSuffix = RTLdrGetSuff();
cchSuffix = strlen(pszSuffix);
}
/*
* Construct the private arch path and check if the file exists.
*/
char szPath[RTPATH_MAX];
int rc = RTPathAppPrivateArch(szPath, sizeof(szPath) - 1 - cchSuffix - cchFilename);
AssertRCReturn(rc, rc);
char *psz = strchr(szPath, '\0');
*psz++ = RTPATH_SLASH;
memcpy(psz, pszFilename, cchFilename);
psz += cchFilename;
memcpy(psz, pszSuffix, cchSuffix + 1);
if (!RTPathExists(szPath))
{
LogRel(("RTLdrLoadAppPriv: \"%s\" not found\n", szPath));
return VERR_FILE_NOT_FOUND;
}
/*
* Pass it on to RTLdrLoad.
*/
rc = RTLdrLoad(szPath, phLdrMod);
LogFlow(("RTLdrLoadAppPriv: returns %Rrc\n", rc));
return rc;
}
RT_EXPORT_SYMBOL(RTLdrLoadAppPriv);
/**
* Gets the default file suffix for DLL/SO/DYLIB/whatever.
*
* @returns The stuff (readonly).
*/
RTDECL(const char *) RTLdrGetSuff(void)
{
#if defined(RT_OS_OS2) || defined(RT_OS_WINDOWS)
static const char s_szSuff[] = ".DLL";
#elif defined(RT_OS_L4)
static const char s_szSuff[] = ".s.so";
#elif defined(RT_OS_DARWIN)
static const char s_szSuff[] = ".dylib";
#else
static const char s_szSuff[] = ".so";
#endif
return s_szSuff;
}
RT_EXPORT_SYMBOL(RTLdrGetSuff);
RTDECL(uintptr_t) RTLdrGetNativeHandle(RTLDRMOD hLdrMod)
{
PRTLDRMODNATIVE pThis = (PRTLDRMODNATIVE)hLdrMod;
AssertPtrReturn(pThis, ~(uintptr_t)0);
AssertReturn(pThis->Core.u32Magic == RTLDRMOD_MAGIC, ~(uintptr_t)0);
AssertReturn(pThis->Core.pOps == &g_rtldrNativeOps, ~(uintptr_t)0);
return pThis->hNative;
}
RT_EXPORT_SYMBOL(RTLdrGetNativeHandle);