ldrFile.cpp revision e64031e20c39650a7bc902a3e1aba613b9415dee
/* $Id$ */
/** @file
* IPRT - Binary Image Loader, The File Oriented Parts.
*/
/*
* Copyright (C) 2006-2007 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#define LOG_GROUP RTLOGGROUP_LDR
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
/**
* File Reader instance.
* This provides raw image bits from a file.
*/
typedef struct RTLDRREADERFILE
{
/** The core. */
/** The file. */
/** The file size. */
/** The current offset. */
/** Number of users or the mapping. */
/** Pointer to the in memory mapping. */
void *pvMapping;
/** The filename (variable size). */
char szFilename[1];
/** @copydoc RTLDRREADER::pfnRead */
{
/*
* Seek.
*/
{
if (RT_FAILURE(rc))
{
return rc;
}
}
/*
* Read.
*/
if (RT_SUCCESS(rc))
else
return rc;
}
/** @copydoc RTLDRREADER::pfnTell */
{
return pFileReader->off;
}
/** @copydoc RTLDRREADER::pfnSize */
{
return pFileReader->cbFile;
}
/** @copydoc RTLDRREADER::pfnLogName */
{
return pFileReader->szFilename;
}
/** @copydoc RTLDRREADER::pfnMap */
{
/*
* Already mapped?
*/
if (pFileReader->pvMapping)
{
pFileReader->cMappings++;
return VINF_SUCCESS;
}
/*
* Allocate memory.
*/
return VERR_IMAGE_TOO_BIG;
if (!pFileReader->pvMapping)
return VERR_NO_MEMORY;
if (RT_SUCCESS(rc))
{
}
else
{
}
return rc;
}
/** @copydoc RTLDRREADER::pfnUnmap */
{
if (!--pFileReader->cMappings)
{
}
return VINF_SUCCESS;
}
/** @copydoc RTLDRREADER::pfnDestroy */
{
int rc = VINF_SUCCESS;
{
}
return rc;
}
/**
* Opens a loader file reader.
*
* @returns iprt status code.
* @param ppReader Where to store the reader instance on success.
* @param pszFilename The file to open.
*/
{
int rc = VERR_NO_MEMORY;
if (pFileReader)
{
rc = RTFileOpen(&pFileReader->File, pszFilename, RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_WRITE);
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
pFileReader->off = 0;
pFileReader->cMappings = 0;
return VINF_SUCCESS;
}
}
}
return rc;
}
/**
* Open a binary image file, extended version.
*
* @returns iprt status code.
* @param pszFilename Image filename.
* @param fFlags Reserved, MBZ.
* @param enmArch CPU architecture specifier for the image to be loaded.
* @param phLdrMod Where to store the handle to the loader module.
*/
RTDECL(int) RTLdrOpen(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod)
{
LogFlow(("RTLdrOpen: pszFilename=%p:{%s} fFlags=%#x enmArch=%d phLdrMod=%p\n",
AssertMsgReturn(enmArch > RTLDRARCH_INVALID && enmArch < RTLDRARCH_END, ("%d\n", enmArch), VERR_INVALID_PARAMETER);
/*
* Resolve RTLDRARCH_HOST.
*/
if (enmArch == RTLDRARCH_HOST)
#if defined(RT_ARCH_AMD64)
#elif defined(RT_ARCH_X86)
#else
#endif
/*
* Create file reader & invoke worker which identifies and calls the image interpreter.
*/
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
return rc;
}
}
*phLdrMod = NIL_RTLDRMOD;
return rc;
}
/**
* Opens a binary image file using kLdr.
*
* @returns iprt status code.
* @param pszFilename Image filename.
* @param fFlags Reserved, MBZ.
* @param enmArch CPU architecture specifier for the image to be loaded.
* @param phLdrMod Where to store the handle to the loaded module.
* @remark Primarily for testing the loader.
*/
RTDECL(int) RTLdrOpenkLdr(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod)
{
#ifdef LDR_WITH_KLDR
LogFlow(("RTLdrOpenkLdr: pszFilename=%p:{%s} fFlags=%#x enmArch=%d phLdrMod=%p\n",
/*
* Resolve RTLDRARCH_HOST.
*/
if (enmArch == RTLDRARCH_HOST)
# if defined(RT_ARCH_AMD64)
# elif defined(RT_ARCH_X86)
# else
# endif
/*
* Create file reader & invoke worker which identifies and calls the image interpreter.
*/
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
{
return rc;
}
}
*phLdrMod = NIL_RTLDRMOD;
return rc;
#else
#endif
}