summaryrefslogtreecommitdiffstats
path: root/include/iprt/ldr.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-11 08:17:27 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-11 08:17:27 +0000
commitf215e02bf85f68d3a6106c2a1f4f7f063f819064 (patch)
tree6bb5b92c046312c4e95ac2620b10ddf482d3fa8b /include/iprt/ldr.h
parentInitial commit. (diff)
downloadvirtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.tar.xz
virtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.zip
Adding upstream version 7.0.14-dfsg.upstream/7.0.14-dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'include/iprt/ldr.h')
-rw-r--r--include/iprt/ldr.h1339
1 files changed, 1339 insertions, 0 deletions
diff --git a/include/iprt/ldr.h b/include/iprt/ldr.h
new file mode 100644
index 00000000..bcce2481
--- /dev/null
+++ b/include/iprt/ldr.h
@@ -0,0 +1,1339 @@
+/** @file
+ * IPRT - Loader.
+ */
+
+/*
+ * Copyright (C) 2006-2023 Oracle and/or its affiliates.
+ *
+ * This file is part of VirtualBox base platform packages, as
+ * available from https://www.virtualbox.org.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, in version 3 of the
+ * License.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <https://www.gnu.org/licenses>.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
+ * in the VirtualBox 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.
+ *
+ * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
+ */
+
+#ifndef IPRT_INCLUDED_ldr_h
+#define IPRT_INCLUDED_ldr_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include <iprt/cdefs.h>
+#include <iprt/types.h>
+
+
+/** @defgroup grp_ldr RTLdr - Loader
+ * @ingroup grp_rt
+ * @{
+ */
+
+
+RT_C_DECLS_BEGIN
+
+/** Loader address (unsigned integer). */
+typedef RTUINTPTR RTLDRADDR;
+/** Pointer to a loader address. */
+typedef RTLDRADDR *PRTLDRADDR;
+/** Pointer to a const loader address. */
+typedef RTLDRADDR const *PCRTLDRADDR;
+/** The max loader address value. */
+#define RTLDRADDR_MAX RTUINTPTR_MAX
+/** NIL loader address value. */
+#define NIL_RTLDRADDR RTLDRADDR_MAX
+
+
+/**
+ * Loader module format.
+ */
+typedef enum RTLDRFMT
+{
+ /** The usual invalid 0 format. */
+ RTLDRFMT_INVALID = 0,
+ /** The native OS loader. */
+ RTLDRFMT_NATIVE,
+ /** The AOUT loader. */
+ RTLDRFMT_AOUT,
+ /** The ELF loader. */
+ RTLDRFMT_ELF,
+ /** The LX loader. */
+ RTLDRFMT_LX,
+ /** The Mach-O loader. */
+ RTLDRFMT_MACHO,
+ /** The PE loader. */
+ RTLDRFMT_PE,
+ /** The end of the valid format values (exclusive). */
+ RTLDRFMT_END,
+ /** Hack to blow the type up to 32-bit. */
+ RTLDRFMT_32BIT_HACK = 0x7fffffff
+} RTLDRFMT;
+
+
+/**
+ * Loader module type.
+ */
+typedef enum RTLDRTYPE
+{
+ /** The usual invalid 0 type. */
+ RTLDRTYPE_INVALID = 0,
+ /** Object file. */
+ RTLDRTYPE_OBJECT,
+ /** Executable module, fixed load address. */
+ RTLDRTYPE_EXECUTABLE_FIXED,
+ /** Executable module, relocatable, non-fixed load address. */
+ RTLDRTYPE_EXECUTABLE_RELOCATABLE,
+ /** Executable module, position independent code, non-fixed load address. */
+ RTLDRTYPE_EXECUTABLE_PIC,
+ /** Shared library, fixed load address.
+ * Typically a system library. */
+ RTLDRTYPE_SHARED_LIBRARY_FIXED,
+ /** Shared library, relocatable, non-fixed load address. */
+ RTLDRTYPE_SHARED_LIBRARY_RELOCATABLE,
+ /** Shared library, position independent code, non-fixed load address. */
+ RTLDRTYPE_SHARED_LIBRARY_PIC,
+ /** DLL that contains no code or data only imports and exports. (Chiefly OS/2.) */
+ RTLDRTYPE_FORWARDER_DLL,
+ /** Core or dump. */
+ RTLDRTYPE_CORE,
+ /** Debug module (debug info with empty code & data segments). */
+ RTLDRTYPE_DEBUG_INFO,
+ /** The end of the valid types values (exclusive). */
+ RTLDRTYPE_END,
+ /** Hack to blow the type up to 32-bit. */
+ RTLDRTYPE_32BIT_HACK = 0x7fffffff
+} RTLDRTYPE;
+
+
+/**
+ * Loader endian indicator.
+ */
+typedef enum RTLDRENDIAN
+{
+ /** The usual invalid endian. */
+ RTLDRENDIAN_INVALID,
+ /** Little endian. */
+ RTLDRENDIAN_LITTLE,
+ /** Bit endian. */
+ RTLDRENDIAN_BIG,
+ /** Endianness doesn't have a meaning in the context. */
+ RTLDRENDIAN_NA,
+ /** The end of the valid endian values (exclusive). */
+ RTLDRENDIAN_END,
+ /** Hack to blow the type up to 32-bit. */
+ RTLDRENDIAN_32BIT_HACK = 0x7fffffff
+} RTLDRENDIAN;
+
+
+/** Pointer to a loader reader instance. */
+typedef struct RTLDRREADER *PRTLDRREADER;
+/**
+ * Loader image reader instance.
+ *
+ * @remarks The reader will typically have a larger structure wrapping this one
+ * for storing necessary instance variables.
+ *
+ * The loader ASSUMES the caller serializes all access to the
+ * individual loader module handlers, thus no serialization is required
+ * when implementing this interface.
+ */
+typedef struct RTLDRREADER
+{
+ /** Magic value (RTLDRREADER_MAGIC). */
+ uintptr_t uMagic;
+
+ /**
+ * Reads bytes at a give place in the raw image.
+ *
+ * @returns iprt status code.
+ * @param pReader Pointer to the reader instance.
+ * @param pvBuf Where to store the bits.
+ * @param cb Number of bytes to read.
+ * @param off Where to start reading relative to the start of the raw image.
+ */
+ DECLCALLBACKMEMBER(int, pfnRead,(PRTLDRREADER pReader, void *pvBuf, size_t cb, RTFOFF off));
+
+ /**
+ * Tells end position of last read.
+ *
+ * @returns position relative to start of the raw image.
+ * @param pReader Pointer to the reader instance.
+ */
+ DECLCALLBACKMEMBER(RTFOFF, pfnTell,(PRTLDRREADER pReader));
+
+ /**
+ * Gets the size of the raw image bits.
+ *
+ * @returns size of raw image bits in bytes.
+ * @param pReader Pointer to the reader instance.
+ */
+ DECLCALLBACKMEMBER(uint64_t, pfnSize,(PRTLDRREADER pReader));
+
+ /**
+ * Map the bits into memory.
+ *
+ * The mapping will be freed upon calling pfnDestroy() if not pfnUnmap()
+ * is called before that. The mapping is read only.
+ *
+ * @returns iprt status code.
+ * @param pReader Pointer to the reader instance.
+ * @param ppvBits Where to store the address of the memory mapping on success.
+ * The size of the mapping can be obtained by calling pfnSize().
+ */
+ DECLCALLBACKMEMBER(int, pfnMap,(PRTLDRREADER pReader, const void **ppvBits));
+
+ /**
+ * Unmap bits.
+ *
+ * @returns iprt status code.
+ * @param pReader Pointer to the reader instance.
+ * @param pvBits Memory pointer returned by pfnMap().
+ */
+ DECLCALLBACKMEMBER(int, pfnUnmap,(PRTLDRREADER pReader, const void *pvBits));
+
+ /**
+ * Gets the most appropriate log name.
+ *
+ * @returns Pointer to readonly log name.
+ * @param pReader Pointer to the reader instance.
+ */
+ DECLCALLBACKMEMBER(const char *, pfnLogName,(PRTLDRREADER pReader));
+
+ /**
+ * Releases all resources associated with the reader instance.
+ * The instance is invalid after this call returns.
+ *
+ * @returns iprt status code.
+ * @param pReader Pointer to the reader instance.
+ */
+ DECLCALLBACKMEMBER(int, pfnDestroy,(PRTLDRREADER pReader));
+} RTLDRREADER;
+
+/** Magic value for RTLDRREADER (Gordon Matthew Thomas Sumner / Sting). */
+#define RTLDRREADER_MAGIC UINT32_C(0x19511002)
+
+
+/**
+ * Gets the default file suffix for DLL/SO/DYLIB/whatever.
+ *
+ * @returns The stuff (readonly).
+ */
+RTDECL(const char *) RTLdrGetSuff(void);
+
+/**
+ * Checks if a library is loadable or not.
+ *
+ * This may attempt load and unload the library.
+ *
+ * @returns true/false accordingly.
+ * @param pszFilename Image filename.
+ */
+RTDECL(bool) RTLdrIsLoadable(const char *pszFilename);
+
+/**
+ * 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 loader module.
+ */
+RTDECL(int) RTLdrLoad(const char *pszFilename, PRTLDRMOD phLdrMod);
+
+/**
+ * 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 loader module.
+ * @param fFlags See RTLDRLOAD_FLAGS_XXX.
+ * @param pErrInfo Where to return extended error information. Optional.
+ */
+RTDECL(int) RTLdrLoadEx(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo);
+
+/** @defgroup RTLDRLOAD_FLAGS_XXX Flags for RTLdrLoadEx, RTLdrLoadSystemEx and RTLdrGetSystemSymbolEx
+ * @{ */
+/** Symbols defined in this library are not made available to resolve
+ * references in subsequently loaded libraries (default). */
+#define RTLDRLOAD_FLAGS_LOCAL UINT32_C(0)
+/** Symbols defined in this library will be made available for symbol
+ * resolution of subsequently loaded libraries. */
+#define RTLDRLOAD_FLAGS_GLOBAL RT_BIT_32(0)
+/** Do not unload the library upon RTLdrClose. (For system libs.) */
+#define RTLDRLOAD_FLAGS_NO_UNLOAD RT_BIT_32(1)
+/** Windows/NT: Search the DLL load directory for imported DLLs - W7,
+ * Vista, and W2K8 requires KB2533623 to be installed to support this; not
+ * supported on XP, W2K3 or earlier. Ignored on other platforms. */
+#define RTLDRLOAD_FLAGS_NT_SEARCH_DLL_LOAD_DIR RT_BIT_32(2)
+/** Do not append default suffix. */
+#define RTLDRLOAD_FLAGS_NO_SUFFIX RT_BIT_32(3)
+/** Shift for the first .so.MAJOR version number to try.
+ * Only applicable to RTLdrLoadSystemEx() and RTLdrGetSystemSymbolEx(). */
+#define RTLDRLOAD_FLAGS_SO_VER_BEGIN_SHIFT 12
+/** Mask for the first .so.MAJOR version number to try.
+ * Only applicable to RTLdrLoadSystemEx() and RTLdrGetSystemSymbolEx(). */
+#define RTLDRLOAD_FLAGS_SO_VER_BEGIN_MASK UINT32_C(0x003ff000)
+/** Shift for the end .so.MAJOR version number (exclusive).
+ * Only applicable to RTLdrLoadSystemEx() and RTLdrGetSystemSymbolEx(). */
+#define RTLDRLOAD_FLAGS_SO_VER_END_SHIFT 22
+/** Mask for the end .so.MAJOR version number (exclusive).
+ * Only applicable to RTLdrLoadSystemEx() and RTLdrGetSystemSymbolEx(). */
+#define RTLDRLOAD_FLAGS_SO_VER_END_MASK UINT32_C(0xffc00000)
+/** Specifies the range for the .so.MAJOR version number.
+ * Only applicable to RTLdrLoadSystemEx() and RTLdrGetSystemSymbolEx().
+ * Ignored on systems not using .so.
+ * @param a_uBegin The first version to try.
+ * @param a_uEnd The version number to stop at (exclusive).
+ */
+#define RTLDRLOAD_FLAGS_SO_VER_RANGE(a_uBegin, a_uEnd) \
+ ( ((a_uBegin) << RTLDRLOAD_FLAGS_SO_VER_BEGIN_SHIFT) | ((a_uEnd) << RTLDRLOAD_FLAGS_SO_VER_END_SHIFT) )
+/** The mask of valid flag bits.
+ * The shared object major version range is excluded. */
+#define RTLDRLOAD_FLAGS_VALID_MASK UINT32_C(0x0000000f)
+/** @} */
+
+/**
+ * Loads a dynamic load library (/shared object) image file residing in one of
+ * the default system library locations.
+ *
+ * Only the system library locations are searched. No suffix is required.
+ *
+ * @returns iprt status code.
+ * @param pszFilename Image filename. No path.
+ * @param fNoUnload Do not unload the library when RTLdrClose is called.
+ * @param phLdrMod Where to store the handle to the loaded module.
+ */
+RTDECL(int) RTLdrLoadSystem(const char *pszFilename, bool fNoUnload, PRTLDRMOD phLdrMod);
+
+/**
+ * Loads a dynamic load library (/shared object) image file residing in one of
+ * the default system library locations, extended version.
+ *
+ * Only the system library locations are searched. No suffix is required.
+ *
+ * @returns iprt status code.
+ * @param pszFilename Image filename. No path.
+ * @param fFlags RTLDRLOAD_FLAGS_XXX, including RTLDRLOAD_FLAGS_SO_VER_XXX.
+ * @param phLdrMod Where to store the handle to the loaded module.
+ */
+RTDECL(int) RTLdrLoadSystemEx(const char *pszFilename, uint32_t fFlags, PRTLDRMOD phLdrMod);
+
+/**
+ * Combines RTLdrLoadSystem and RTLdrGetSymbol, with fNoUnload set to true.
+ *
+ * @returns The symbol value, NULL on failure. (If you care for a less boolean
+ * status, go thru the necessary API calls yourself.)
+ * @param pszFilename Image filename. No path.
+ * @param pszSymbol Symbol name.
+ */
+RTDECL(void *) RTLdrGetSystemSymbol(const char *pszFilename, const char *pszSymbol);
+
+/**
+ * Combines RTLdrLoadSystemEx and RTLdrGetSymbol.
+ *
+ * @returns The symbol value, NULL on failure. (If you care for a less boolean
+ * status, go thru the necessary API calls yourself.)
+ * @param pszFilename Image filename. No path.
+ * @param pszSymbol Symbol name.
+ * @param fFlags RTLDRLOAD_FLAGS_XXX, including RTLDRLOAD_FLAGS_SO_VER_XXX.
+ */
+RTDECL(void *) RTLdrGetSystemSymbolEx(const char *pszFilename, const char *pszSymbol, uint32_t fFlags);
+
+/**
+ * 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);
+
+/**
+ * Gets the native module handle for a module loaded by RTLdrLoad, RTLdrLoadEx,
+ * RTLdrLoadSystem, or RTLdrLoadAppPriv.
+ *
+ * @returns Native handle on success, ~(uintptr_t)0 on failure.
+ * @param hLdrMod The loader module handle.
+ */
+RTDECL(uintptr_t) RTLdrGetNativeHandle(RTLDRMOD hLdrMod);
+
+
+/**
+ * Image architecuture specifier for RTLdrOpenEx.
+ */
+typedef enum RTLDRARCH
+{
+ RTLDRARCH_INVALID = 0,
+ /** Whatever. */
+ RTLDRARCH_WHATEVER,
+ /** The host architecture. */
+ RTLDRARCH_HOST,
+ /** 16-bit x86. */
+ RTLDRARCH_X86_16,
+ /** 32-bit x86. */
+ RTLDRARCH_X86_32,
+ /** AMD64 (64-bit x86 if you like). */
+ RTLDRARCH_AMD64,
+ /** 32-bit ARM. */
+ RTLDRARCH_ARM32,
+ /** 64-bit ARM. */
+ RTLDRARCH_ARM64,
+ /** End of the valid values. */
+ RTLDRARCH_END,
+ /** Make sure the type is a full 32-bit. */
+ RTLDRARCH_32BIT_HACK = 0x7fffffff
+} RTLDRARCH;
+/** Pointer to a RTLDRARCH. */
+typedef RTLDRARCH *PRTLDRARCH;
+
+/**
+ * Translates a RTLDRARCH value to a string.
+ *
+ * @returns Name corresponding to @a enmArch
+ * @param enmArch The value to name.
+ */
+RTDECL(const char *) RTLdrArchName(RTLDRARCH enmArch);
+
+/**
+ * Returns the host architecture.
+ *
+ * @returns Host architecture or RTLDRARCH_WHATEVER if no match.
+ */
+RTDECL(RTLDRARCH) RTLdrGetHostArch(void);
+
+
+/** @name RTLDR_O_XXX - RTLdrOpen flags.
+ * @{ */
+/** Open for debugging or introspection reasons.
+ * This will skip a few of the stricter validations when loading images. */
+#define RTLDR_O_FOR_DEBUG RT_BIT_32(0)
+/** Open for signature validation. */
+#define RTLDR_O_FOR_VALIDATION RT_BIT_32(1)
+/** The arch specification is just a guideline for FAT binaries. */
+#define RTLDR_O_WHATEVER_ARCH RT_BIT_32(2)
+/** Ignore the architecture specification if there is no code. */
+#define RTLDR_O_IGNORE_ARCH_IF_NO_CODE RT_BIT_32(3)
+/** Mach-O: Include the __LINKEDIT segment (ignored by the others). */
+#define RTLDR_O_MACHO_LOAD_LINKEDIT RT_BIT_32(4)
+/** Mask of valid flags. */
+#define RTLDR_O_VALID_MASK UINT32_C(0x0000001f)
+/** @} */
+
+/**
+ * Open a binary image file.
+ *
+ * @returns iprt status code.
+ * @param pszFilename Image filename.
+ * @param fFlags Valid RTLDR_O_XXX combination.
+ * @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);
+
+/**
+ * Open a binary image file, extended version.
+ *
+ * @returns iprt status code.
+ * @param pszFilename Image filename.
+ * @param fFlags Valid RTLDR_O_XXX combination.
+ * @param enmArch CPU architecture specifier for the image to be loaded.
+ * @param phLdrMod Where to store the handle to the loader module.
+ * @param pErrInfo Where to return extended error information. Optional.
+ */
+RTDECL(int) RTLdrOpenEx(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod, PRTERRINFO pErrInfo);
+
+/**
+ * Open a binary image file allowing VFS chains in the filename.
+ *
+ * @returns iprt status code.
+ * @param pszFilename Image filename, VFS chain specifiers allowed.
+ * @param fFlags Valid RTLDR_O_XXX combination.
+ * @param enmArch CPU architecture specifier for the image to be loaded.
+ * @param phLdrMod Where to store the handle to the loader module.
+ * @param poffError Where to return the offset into @a pszFilename of an VFS
+ * chain element causing trouble. Optional.
+ * @param pErrInfo Where to return extended error information. Optional.
+ */
+RTDECL(int) RTLdrOpenVfsChain(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch,
+ PRTLDRMOD phLdrMod, uint32_t *poffError, PRTERRINFO pErrInfo);
+
+/**
+ * Open part with reader.
+ *
+ * @returns iprt status code.
+ * @param pReader The loader reader instance which will provide the raw
+ * image bits. The reader instance will be consumed on
+ * success. On failure, the caller has to do the cleaning
+ * up.
+ * @param fFlags Valid RTLDR_O_XXX combination.
+ * @param enmArch Architecture specifier.
+ * @param phMod Where to store the handle.
+ * @param pErrInfo Where to return extended error information. Optional.
+ */
+RTDECL(int) RTLdrOpenWithReader(PRTLDRREADER pReader, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phMod, PRTERRINFO pErrInfo);
+
+/**
+ * Called to read @a cb bytes at @a off into @a pvBuf.
+ *
+ * @returns IPRT status code
+ * @param pvBuf The output buffer.
+ * @param cb The number of bytes to read.
+ * @param off Where to start reading.
+ * @param pvUser The user parameter.
+ */
+typedef DECLCALLBACKTYPE(int, FNRTLDRRDRMEMREAD,(void *pvBuf, size_t cb, size_t off, void *pvUser));
+/** Pointer to a RTLdrOpenInMemory reader callback. */
+typedef FNRTLDRRDRMEMREAD *PFNRTLDRRDRMEMREAD;
+
+/**
+ * Called to when the module is unloaded (or done loading) to release resources
+ * associated with it (@a pvUser).
+ *
+ * @param pvUser The user parameter.
+ * @param cbImage The image size.
+ */
+typedef DECLCALLBACKTYPE(void, FNRTLDRRDRMEMDTOR,(void *pvUser, size_t cbImage));
+/** Pointer to a RTLdrOpenInMemory destructor callback. */
+typedef FNRTLDRRDRMEMDTOR *PFNRTLDRRDRMEMDTOR;
+
+/**
+ * Open a in-memory image or an image with a custom reader callback.
+ *
+ * @returns IPRT status code.
+ * @param pszName The image name.
+ * @param fFlags Valid RTLDR_O_XXX combination.
+ * @param enmArch CPU architecture specifier for the image to be loaded.
+ * @param cbImage The size of the image (fake file).
+ * @param pfnRead The read function. If NULL is passed in, a default
+ * reader function is provided that assumes @a pvUser
+ * points to the raw image bits, at least @a cbImage of
+ * valid memory.
+ * @param pfnDtor The destructor function. If NULL is passed, a default
+ * destructor will be provided that passes @a pvUser to
+ * RTMemFree.
+ * @param pvUser The user argument or, if any of the callbacks are NULL,
+ * a pointer to a memory block.
+ * @param phLdrMod Where to return the module handle.
+ * @param pErrInfo Pointer to an error info buffer, optional.
+ *
+ * @remarks With the exception of invalid @a pfnDtor and/or @a pvUser
+ * parameters, the pfnDtor methods (or the default one if NULL) will
+ * always be invoked. The destruction of pvUser is entirely in the
+ * hands of this method once it's called.
+ */
+RTDECL(int) RTLdrOpenInMemory(const char *pszName, uint32_t fFlags, RTLDRARCH enmArch, size_t cbImage,
+ PFNRTLDRRDRMEMREAD pfnRead, PFNRTLDRRDRMEMDTOR pfnDtor, void *pvUser,
+ PRTLDRMOD phLdrMod, PRTERRINFO pErrInfo);
+
+/**
+ * Closes a loader module handle.
+ *
+ * The handle can be obtained using any of the RTLdrLoad(), RTLdrOpen()
+ * and RTLdrOpenInMemory() functions.
+ *
+ * @returns iprt status code.
+ * @param hLdrMod The loader module handle.
+ */
+RTDECL(int) RTLdrClose(RTLDRMOD hLdrMod);
+
+/**
+ * Gets the address of a named exported symbol.
+ *
+ * @returns iprt status code.
+ * @retval VERR_LDR_FORWARDER forwarder, use pfnQueryForwarderInfo. Buffer size
+ * hint in @a ppvValue.
+ * @param hLdrMod The loader module handle.
+ * @param pszSymbol Symbol name.
+ * @param ppvValue Where to store the symbol value. Note that this is restricted to the
+ * pointer size used on the host!
+ */
+RTDECL(int) RTLdrGetSymbol(RTLDRMOD hLdrMod, const char *pszSymbol, void **ppvValue);
+
+/**
+ * Gets the address of a named exported symbol.
+ *
+ * This function differs from the plain one in that it can deal with
+ * both GC and HC address sizes, and that it can calculate the symbol
+ * value relative to any given base address.
+ *
+ * @returns iprt status code.
+ * @retval VERR_LDR_FORWARDER forwarder, use pfnQueryForwarderInfo. Buffer size
+ * hint in @a pValue.
+ * @param hLdrMod The loader module handle.
+ * @param pvBits Optional pointer to the loaded image.
+ * Set this to NULL if no RTLdrGetBits() processed image bits are available.
+ * Not supported for RTLdrLoad() images.
+ * @param BaseAddress Image load address.
+ * Not supported for RTLdrLoad() images.
+ * @param iOrdinal Symbol ordinal number, pass UINT32_MAX if pszSymbol
+ * should be used instead.
+ * @param pszSymbol Symbol name.
+ * @param pValue Where to store the symbol value.
+ */
+RTDECL(int) RTLdrGetSymbolEx(RTLDRMOD hLdrMod, const void *pvBits, RTLDRADDR BaseAddress,
+ uint32_t iOrdinal, const char *pszSymbol, PRTLDRADDR pValue);
+
+/**
+ * Gets the address of a named exported function.
+ *
+ * Same as RTLdrGetSymbol, but skips the status code and pointer to return
+ * variable stuff.
+ *
+ * @returns Pointer to the function if found, NULL if not.
+ * @param hLdrMod The loader module handle.
+ * @param pszSymbol Function name.
+ */
+RTDECL(PFNRT) RTLdrGetFunction(RTLDRMOD hLdrMod, const char *pszSymbol);
+
+/**
+ * Information about an imported symbol.
+ */
+typedef struct RTLDRIMPORTINFO
+{
+ /** Symbol table entry number, UINT32_MAX if not available. */
+ uint32_t iSelfOrdinal;
+ /** The ordinal of the imported symbol in szModule, UINT32_MAX if not used. */
+ uint32_t iOrdinal;
+ /** The symbol name, NULL if not used. This points to the char immediately
+ * following szModule when returned by RTLdrQueryForwarderInfo. */
+ const char *pszSymbol;
+ /** The name of the module being imported from. */
+ char szModule[1];
+} RTLDRIMPORTINFO;
+/** Pointer to information about an imported symbol. */
+typedef RTLDRIMPORTINFO *PRTLDRIMPORTINFO;
+/** Pointer to const information about an imported symbol. */
+typedef RTLDRIMPORTINFO const *PCRTLDRIMPORTINFO;
+
+/**
+ * Query information about a forwarded symbol.
+ *
+ * @returns IPRT status code.
+ * @param hLdrMod The loader module handle.
+ * @param pvBits Optional pointer to the loaded image.
+ * Set this to NULL if no RTLdrGetBits() processed image bits are available.
+ * Not supported for RTLdrLoad() images.
+ * @param iOrdinal Symbol ordinal number, pass UINT32_MAX if pszSymbol
+ * should be used instead.
+ * @param pszSymbol Symbol name.
+ * @param pInfo Where to return the forwarder info.
+ * @param cbInfo Size of the buffer @a pInfo points to. For a size
+ * hint, see @a pValue when RTLdrGetSymbolEx returns
+ * VERR_LDR_FORWARDER.
+ */
+RTDECL(int) RTLdrQueryForwarderInfo(RTLDRMOD hLdrMod, const void *pvBits, uint32_t iOrdinal, const char *pszSymbol,
+ PRTLDRIMPORTINFO pInfo, size_t cbInfo);
+
+
+/**
+ * Gets the size of the loaded image.
+ *
+ * This is not necessarily available for images that has been loaded using
+ * RTLdrLoad().
+ *
+ * @returns image size (in bytes).
+ * @returns ~(size_t)0 on if not available.
+ * @param hLdrMod Handle to the loader module.
+ */
+RTDECL(size_t) RTLdrSize(RTLDRMOD hLdrMod);
+
+/**
+ * Resolve an external symbol during RTLdrGetBits().
+ *
+ * @returns iprt status code.
+ * @param hLdrMod The loader module handle.
+ * @param pszModule Module name.
+ * @param pszSymbol Symbol name, NULL if uSymbol should be used.
+ * @param uSymbol Symbol ordinal, ~0 if pszSymbol should be used.
+ * @param pValue Where to store the symbol value (address).
+ * @param pvUser User argument.
+ */
+typedef DECLCALLBACKTYPE(int, FNRTLDRIMPORT,(RTLDRMOD hLdrMod, const char *pszModule, const char *pszSymbol, unsigned uSymbol,
+ PRTLDRADDR pValue, void *pvUser));
+/** Pointer to a FNRTLDRIMPORT() callback function. */
+typedef FNRTLDRIMPORT *PFNRTLDRIMPORT;
+
+/**
+ * Loads the image into a buffer provided by the user and applies fixups
+ * for the given base address.
+ *
+ * @returns iprt status code.
+ * @param hLdrMod The load module handle.
+ * @param pvBits Where to put the bits.
+ * Must be as large as RTLdrSize() suggests.
+ * @param BaseAddress The base address.
+ * @param pfnGetImport Callback function for resolving imports one by one.
+ * @param pvUser User argument for the callback.
+ * @remark Not supported for RTLdrLoad() images.
+ */
+RTDECL(int) RTLdrGetBits(RTLDRMOD hLdrMod, void *pvBits, RTLDRADDR BaseAddress, PFNRTLDRIMPORT pfnGetImport, void *pvUser);
+
+/**
+ * Relocates bits after getting them.
+ * Useful for code which moves around a bit.
+ *
+ * @returns iprt status code.
+ * @param hLdrMod The loader module handle.
+ * @param pvBits Where the image bits are.
+ * Must have been passed to RTLdrGetBits().
+ * @param NewBaseAddress The new base address.
+ * @param OldBaseAddress The old base address.
+ * @param pfnGetImport Callback function for resolving imports one by one.
+ * @param pvUser User argument for the callback.
+ * @remark Not supported for RTLdrLoad() images.
+ */
+RTDECL(int) RTLdrRelocate(RTLDRMOD hLdrMod, void *pvBits, RTLDRADDR NewBaseAddress, RTLDRADDR OldBaseAddress,
+ PFNRTLDRIMPORT pfnGetImport, void *pvUser);
+
+/**
+ * Enumeration callback function used by RTLdrEnumSymbols().
+ *
+ * @returns iprt status code. Failure will stop the enumeration.
+ * @param hLdrMod The loader module handle.
+ * @param pszSymbol Symbol name. NULL if ordinal only.
+ * @param uSymbol Symbol ordinal, ~0 if not used.
+ * @param Value Symbol value.
+ * @param pvUser The user argument specified to RTLdrEnumSymbols().
+ */
+typedef DECLCALLBACKTYPE(int, FNRTLDRENUMSYMS,(RTLDRMOD hLdrMod, const char *pszSymbol, unsigned uSymbol, RTLDRADDR Value, void *pvUser));
+/** Pointer to a FNRTLDRENUMSYMS() callback function. */
+typedef FNRTLDRENUMSYMS *PFNRTLDRENUMSYMS;
+
+/**
+ * Enumerates all symbols in a module.
+ *
+ * @returns iprt status code.
+ * @param hLdrMod The loader module handle.
+ * @param fFlags Flags indicating what to return and such.
+ * @param pvBits Optional pointer to the loaded image. (RTLDR_ENUM_SYMBOL_FLAGS_*)
+ * Set this to NULL if no RTLdrGetBits() processed image bits are available.
+ * @param BaseAddress Image load address.
+ * @param pfnCallback Callback function.
+ * @param pvUser User argument for the callback.
+ * @remark Not supported for RTLdrLoad() images.
+ */
+RTDECL(int) RTLdrEnumSymbols(RTLDRMOD hLdrMod, unsigned fFlags, const void *pvBits, RTLDRADDR BaseAddress, PFNRTLDRENUMSYMS pfnCallback, void *pvUser);
+
+/** @name RTLdrEnumSymbols flags.
+ * @{ */
+/** Returns ALL kinds of symbols. The default is to only return public/exported symbols. */
+#define RTLDR_ENUM_SYMBOL_FLAGS_ALL RT_BIT(1)
+/** Ignore forwarders rather than reporting them with RTLDR_ENUM_SYMBOL_FWD_ADDRESS as value. */
+#define RTLDR_ENUM_SYMBOL_FLAGS_NO_FWD RT_BIT(2)
+/** @} */
+
+/** Special symbol for forwarder symbols, since they cannot be resolved with
+ * the current API. */
+#if (HC_ARCH_BITS == 64 || GC_ARCH_BITS == 64)
+# define RTLDR_ENUM_SYMBOL_FWD_ADDRESS UINT64_C(0xff4242fffd4242fd)
+#else
+# define RTLDR_ENUM_SYMBOL_FWD_ADDRESS UINT32_C(0xff4242fd)
+#endif
+
+
+/**
+ * Debug info type (as far the loader can tell).
+ */
+typedef enum RTLDRDBGINFOTYPE
+{
+ /** The invalid 0 value. */
+ RTLDRDBGINFOTYPE_INVALID = 0,
+ /** Unknown debug info format. */
+ RTLDRDBGINFOTYPE_UNKNOWN,
+ /** Stabs. */
+ RTLDRDBGINFOTYPE_STABS,
+ /** Debug With Arbitrary Record Format (DWARF). */
+ RTLDRDBGINFOTYPE_DWARF,
+ /** Debug With Arbitrary Record Format (DWARF), in external file (DWO). */
+ RTLDRDBGINFOTYPE_DWARF_DWO,
+ /** Microsoft Codeview debug info. */
+ RTLDRDBGINFOTYPE_CODEVIEW,
+ /** Microsoft Codeview debug info, in external v2.0+ program database (PDB). */
+ RTLDRDBGINFOTYPE_CODEVIEW_PDB20,
+ /** Microsoft Codeview debug info, in external v7.0+ program database (PDB). */
+ RTLDRDBGINFOTYPE_CODEVIEW_PDB70,
+ /** Microsoft Codeview debug info, in external file (DBG). */
+ RTLDRDBGINFOTYPE_CODEVIEW_DBG,
+ /** Microsoft COFF debug info. */
+ RTLDRDBGINFOTYPE_COFF,
+ /** Watcom debug info. */
+ RTLDRDBGINFOTYPE_WATCOM,
+ /** IBM High Level Language debug info. */
+ RTLDRDBGINFOTYPE_HLL,
+ /** The end of the valid debug info values (exclusive). */
+ RTLDRDBGINFOTYPE_END,
+ /** Blow the type up to 32-bits. */
+ RTLDRDBGINFOTYPE_32BIT_HACK = 0x7fffffff
+} RTLDRDBGINFOTYPE;
+
+
+/**
+ * Debug info details for the enumeration callback.
+ */
+typedef struct RTLDRDBGINFO
+{
+ /** The kind of debug info. */
+ RTLDRDBGINFOTYPE enmType;
+ /** The debug info ordinal number / id. */
+ uint32_t iDbgInfo;
+ /** The file offset *if* this type has one specific location in the executable
+ * image file. This is -1 if there isn't any specific file location. */
+ RTFOFF offFile;
+ /** The link address of the debug info if it's loadable. NIL_RTLDRADDR if not
+ * loadable*/
+ RTLDRADDR LinkAddress;
+ /** The size of the debug information. -1 is used if this isn't applicable.*/
+ RTLDRADDR cb;
+ /** This is set if the debug information is found in an external file. NULL
+ * if no external file involved.
+ * @note Putting it outside the union to allow lazy callback implementation. */
+ const char *pszExtFile;
+ /** Type (enmType) specific information. */
+ union
+ {
+ /** RTLDRDBGINFOTYPE_DWARF */
+ struct
+ {
+ /** The section name. */
+ const char *pszSection;
+ } Dwarf;
+
+ /** RTLDRDBGINFOTYPE_DWARF_DWO */
+ struct
+ {
+ /** The CRC32 of the external file. */
+ uint32_t uCrc32;
+ } Dwo;
+
+ /** RTLDRDBGINFOTYPE_CODEVIEW, RTLDRDBGINFOTYPE_COFF */
+ struct
+ {
+ /** The PE image size. */
+ uint32_t cbImage;
+ /** The timestamp. */
+ uint32_t uTimestamp;
+ /** The major version from the entry. */
+ uint32_t uMajorVer;
+ /** The minor version from the entry. */
+ uint32_t uMinorVer;
+ } Cv, Coff;
+
+ /** RTLDRDBGINFOTYPE_CODEVIEW_DBG */
+ struct
+ {
+ /** The PE image size. */
+ uint32_t cbImage;
+ /** The timestamp. */
+ uint32_t uTimestamp;
+ } Dbg;
+
+ /** RTLDRDBGINFOTYPE_CODEVIEW_PDB20*/
+ struct
+ {
+ /** The PE image size. */
+ uint32_t cbImage;
+ /** The timestamp. */
+ uint32_t uTimestamp;
+ /** The PDB age. */
+ uint32_t uAge;
+ } Pdb20;
+
+ /** RTLDRDBGINFOTYPE_CODEVIEW_PDB70 */
+ struct
+ {
+ /** The PE image size. */
+ uint32_t cbImage;
+ /** The PDB age. */
+ uint32_t uAge;
+ /** The UUID. */
+ RTUUID Uuid;
+ } Pdb70;
+ } u;
+} RTLDRDBGINFO;
+/** Pointer to debug info details. */
+typedef RTLDRDBGINFO *PRTLDRDBGINFO;
+/** Pointer to read only debug info details. */
+typedef RTLDRDBGINFO const *PCRTLDRDBGINFO;
+
+
+/**
+ * Debug info enumerator callback.
+ *
+ * @returns VINF_SUCCESS to continue the enumeration. Any other status code
+ * will cause RTLdrEnumDbgInfo to immediately return with that status.
+ *
+ * @param hLdrMod The module handle.
+ * @param pDbgInfo Pointer to a read only structure with the details.
+ * @param pvUser The user parameter specified to RTLdrEnumDbgInfo.
+ */
+typedef DECLCALLBACKTYPE(int, FNRTLDRENUMDBG,(RTLDRMOD hLdrMod, PCRTLDRDBGINFO pDbgInfo, void *pvUser));
+/** Pointer to a debug info enumerator callback. */
+typedef FNRTLDRENUMDBG *PFNRTLDRENUMDBG;
+
+/**
+ * Enumerate the debug info contained in the executable image.
+ *
+ * @returns IPRT status code or whatever pfnCallback returns.
+ *
+ * @param hLdrMod The module handle.
+ * @param pvBits Optional pointer to bits returned by
+ * RTLdrGetBits(). This can be used by some module
+ * interpreters to reduce memory consumption.
+ * @param pfnCallback The callback function.
+ * @param pvUser The user argument.
+ */
+RTDECL(int) RTLdrEnumDbgInfo(RTLDRMOD hLdrMod, const void *pvBits, PFNRTLDRENUMDBG pfnCallback, void *pvUser);
+
+
+/**
+ * Loader segment.
+ */
+typedef struct RTLDRSEG
+{
+ /** The segment name. Always set to something. */
+ const char *pszName;
+ /** The length of the segment name. */
+ uint32_t cchName;
+ /** The flat selector to use for the segment (i.e. data/code).
+ * Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
+ uint16_t SelFlat;
+ /** The 16-bit selector to use for the segment.
+ * Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
+ uint16_t Sel16bit;
+ /** Segment flags. */
+ uint32_t fFlags;
+ /** The segment protection (RTMEM_PROT_XXX). */
+ uint32_t fProt;
+ /** The size of the segment. */
+ RTLDRADDR cb;
+ /** The required segment alignment.
+ * The to 0 if the segment isn't supposed to be mapped. */
+ RTLDRADDR Alignment;
+ /** The link address.
+ * Set to NIL_RTLDRADDR if the segment isn't supposed to be mapped or if
+ * the image doesn't have link addresses. */
+ RTLDRADDR LinkAddress;
+ /** File offset of the segment.
+ * Set to -1 if no file backing (like BSS). */
+ RTFOFF offFile;
+ /** Size of the file bits of the segment.
+ * Set to -1 if no file backing (like BSS). */
+ RTFOFF cbFile;
+ /** The relative virtual address when mapped.
+ * Set to NIL_RTLDRADDR if the segment isn't supposed to be mapped. */
+ RTLDRADDR RVA;
+ /** The size of the segment including the alignment gap up to the next segment when mapped.
+ * This is set to NIL_RTLDRADDR if not implemented. */
+ RTLDRADDR cbMapped;
+} RTLDRSEG;
+/** Pointer to a loader segment. */
+typedef RTLDRSEG *PRTLDRSEG;
+/** Pointer to a read only loader segment. */
+typedef RTLDRSEG const *PCRTLDRSEG;
+
+
+/** @name Segment flags
+ * @{ */
+/** The segment is 16-bit. When not set the default of the target architecture is assumed. */
+#define RTLDRSEG_FLAG_16BIT UINT32_C(1)
+/** The segment requires a 16-bit selector alias. (OS/2) */
+#define RTLDRSEG_FLAG_OS2_ALIAS16 UINT32_C(2)
+/** Conforming segment (x86 weirdness). (OS/2) */
+#define RTLDRSEG_FLAG_OS2_CONFORM UINT32_C(4)
+/** IOPL (ring-2) segment. (OS/2) */
+#define RTLDRSEG_FLAG_OS2_IOPL UINT32_C(8)
+/** @} */
+
+/**
+ * Segment enumerator callback.
+ *
+ * @returns VINF_SUCCESS to continue the enumeration. Any other status code
+ * will cause RTLdrEnumSegments to immediately return with that
+ * status.
+ *
+ * @param hLdrMod The module handle.
+ * @param pSeg The segment information.
+ * @param pvUser The user parameter specified to RTLdrEnumSegments.
+ */
+typedef DECLCALLBACKTYPE(int, FNRTLDRENUMSEGS,(RTLDRMOD hLdrMod, PCRTLDRSEG pSeg, void *pvUser));
+/** Pointer to a segment enumerator callback. */
+typedef FNRTLDRENUMSEGS *PFNRTLDRENUMSEGS;
+
+/**
+ * Enumerate the debug info contained in the executable image.
+ *
+ * @returns IPRT status code or whatever pfnCallback returns.
+ *
+ * @param hLdrMod The module handle.
+ * @param pfnCallback The callback function.
+ * @param pvUser The user argument.
+ */
+RTDECL(int) RTLdrEnumSegments(RTLDRMOD hLdrMod, PFNRTLDRENUMSEGS pfnCallback, void *pvUser);
+
+/**
+ * Converts a link address to a segment:offset address.
+ *
+ * @returns IPRT status code.
+ *
+ * @param hLdrMod The module handle.
+ * @param LinkAddress The link address to convert.
+ * @param piSeg Where to return the segment index.
+ * @param poffSeg Where to return the segment offset.
+ */
+RTDECL(int) RTLdrLinkAddressToSegOffset(RTLDRMOD hLdrMod, RTLDRADDR LinkAddress, uint32_t *piSeg, PRTLDRADDR poffSeg);
+
+/**
+ * Converts a link address to an image relative virtual address (RVA).
+ *
+ * @returns IPRT status code.
+ *
+ * @param hLdrMod The module handle.
+ * @param LinkAddress The link address to convert.
+ * @param pRva Where to return the RVA.
+ */
+RTDECL(int) RTLdrLinkAddressToRva(RTLDRMOD hLdrMod, RTLDRADDR LinkAddress, PRTLDRADDR pRva);
+
+/**
+ * Converts an image relative virtual address (RVA) to a segment:offset.
+ *
+ * @returns IPRT status code.
+ *
+ * @param hLdrMod The module handle.
+ * @param iSeg The segment index.
+ * @param offSeg The segment offset.
+ * @param pRva Where to return the RVA.
+ */
+RTDECL(int) RTLdrSegOffsetToRva(RTLDRMOD hLdrMod, uint32_t iSeg, RTLDRADDR offSeg, PRTLDRADDR pRva);
+
+/**
+ * Converts a segment:offset into an image relative virtual address (RVA).
+ *
+ * @returns IPRT status code.
+ *
+ * @param hLdrMod The module handle.
+ * @param Rva The link address to convert.
+ * @param piSeg Where to return the segment index.
+ * @param poffSeg Where to return the segment offset.
+ */
+RTDECL(int) RTLdrRvaToSegOffset(RTLDRMOD hLdrMod, RTLDRADDR Rva, uint32_t *piSeg, PRTLDRADDR poffSeg);
+
+/**
+ * Gets the image format.
+ *
+ * @returns Valid image format on success. RTLDRFMT_INVALID on invalid handle or
+ * other errors.
+ * @param hLdrMod The module handle.
+ */
+RTDECL(RTLDRFMT) RTLdrGetFormat(RTLDRMOD hLdrMod);
+
+/**
+ * Gets the image type.
+ *
+ * @returns Valid image type value on success. RTLDRTYPE_INVALID on
+ * invalid handle or other errors.
+ * @param hLdrMod The module handle.
+ */
+RTDECL(RTLDRTYPE) RTLdrGetType(RTLDRMOD hLdrMod);
+
+/**
+ * Gets the image endian-ness.
+ *
+ * @returns Valid image endian value on success. RTLDRENDIAN_INVALID on invalid
+ * handle or other errors.
+ * @param hLdrMod The module handle.
+ */
+RTDECL(RTLDRENDIAN) RTLdrGetEndian(RTLDRMOD hLdrMod);
+
+/**
+ * Gets the image endian-ness.
+ *
+ * @returns Valid image architecture value on success.
+ * RTLDRARCH_INVALID on invalid handle or other errors.
+ * @param hLdrMod The module handle.
+ */
+RTDECL(RTLDRARCH) RTLdrGetArch(RTLDRMOD hLdrMod);
+
+/**
+ * Loader properties that can be queried thru RTLdrQueryProp.
+ */
+typedef enum RTLDRPROP
+{
+ RTLDRPROP_INVALID = 0,
+ /** The image UUID (Mach-O).
+ * Returns a RTUUID in the buffer. */
+ RTLDRPROP_UUID,
+ /** The image timestamp in seconds, genrally since unix epoc.
+ * Returns a 32-bit or 64-bit signed integer value in the buffer. */
+ RTLDRPROP_TIMESTAMP_SECONDS,
+ /** Checks if the image is signed.
+ * Returns a bool. */
+ RTLDRPROP_IS_SIGNED,
+ /** Retrives the PKCS \#7 SignedData blob that signs the image.
+ * Returns variable sized buffer containing the ASN.1 BER encoding.
+ *
+ * @remarks This generally starts with a PKCS \#7 Content structure, the
+ * SignedData bit is found a few levels down into this as per RFC. */
+ RTLDRPROP_PKCS7_SIGNED_DATA,
+ /** Query the number of pages that needs hashing.
+ * This is for RTLDRPROP_SHA1_PAGE_HASHES and RTLDRPROP_SHA256_PAGE_HASHES
+ * buffer size calculations. */
+ RTLDRPROP_HASHABLE_PAGES,
+ /** Query the SHA-1 page hashes.
+ * Returns an array with entries made of a 32-bit file offset and a SHA-1
+ * digest. Use RTLDRPROP_HASHABLE_PAGES to calculate the buffer size. */
+ RTLDRPROP_SHA1_PAGE_HASHES,
+ /** Query the SHA-256 page hashes.
+ * Returns an array with entries made of a 32-bit file offset and a SHA-256
+ * digest. Use RTLDRPROP_HASHABLE_PAGES to calculate the buffer size. */
+ RTLDRPROP_SHA256_PAGE_HASHES,
+
+ /** Query whether code signature checks are enabled. */
+ RTLDRPROP_SIGNATURE_CHECKS_ENFORCED,
+
+ /** Number of import or needed modules. */
+ RTLDRPROP_IMPORT_COUNT,
+ /** Import module by index (32-bit) stored in the buffer. */
+ RTLDRPROP_IMPORT_MODULE,
+ /** The file offset of the main executable header.
+ * This is mainly for PE, NE and LX headers, but also Mach-O FAT. */
+ RTLDRPROP_FILE_OFF_HEADER,
+ /** The internal module name.
+ * This is the SONAME for ELF, export table name for PE, and zero'th resident
+ * name table entry for LX.
+ * Returns zero terminated string. */
+ RTLDRPROP_INTERNAL_NAME,
+ /** The raw unwind table if available.
+ * For PE this means IMAGE_DIRECTORY_ENTRY_EXCEPTION content, for AMD64 this
+ * is the lookup table (IMAGE_RUNTIME_FUNCTION_ENTRY).
+ * Not implemented any others yet. */
+ RTLDRPROP_UNWIND_TABLE,
+ /** Read unwind info at given RVA and up to buffer size. The RVA is stored
+ * as uint32_t in the buffer when making the call.
+ * This is only implemented for PE. */
+ RTLDRPROP_UNWIND_INFO,
+ /** The image build-id (ELF/GNU).
+ * Returns usually a SHA1 checksum in the buffer. */
+ RTLDRPROP_BUILDID,
+
+ /** End of valid properties. */
+ RTLDRPROP_END,
+ /** Blow the type up to 32 bits. */
+ RTLDRPROP_32BIT_HACK = 0x7fffffff
+} RTLDRPROP;
+
+/**
+ * Generic method for querying image properties.
+ *
+ * @returns IPRT status code.
+ * @retval VERR_NOT_SUPPORTED if the property query isn't supported (either all
+ * or that specific property). The caller must handle this result.
+ * @retval VERR_NOT_FOUND the property was not found in the module. The caller
+ * must also normally deal with this.
+ * @retval VERR_INVALID_FUNCTION if the function value is wrong.
+ * @retval VERR_INVALID_PARAMETER if the buffer size is wrong.
+ * @retval VERR_BUFFER_OVERFLOW if the function doesn't have a fixed size
+ * buffer and the buffer isn't big enough. Use RTLdrQueryPropEx.
+ * @retval VERR_INVALID_HANDLE if the handle is invalid.
+ *
+ * @param hLdrMod The module handle.
+ * @param enmProp The property to query.
+ * @param pvBuf Pointer to the input / output buffer. In most cases
+ * it's only used for returning data.
+ * @param cbBuf The size of the buffer.
+ */
+RTDECL(int) RTLdrQueryProp(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void *pvBuf, size_t cbBuf);
+
+/**
+ * Generic method for querying image properties, extended version.
+ *
+ * @returns IPRT status code.
+ * @retval VERR_NOT_SUPPORTED if the property query isn't supported (either all
+ * or that specific property). The caller must handle this result.
+ * @retval VERR_NOT_FOUND the property was not found in the module. The caller
+ * must also normally deal with this.
+ * @retval VERR_INVALID_FUNCTION if the function value is wrong.
+ * @retval VERR_INVALID_PARAMETER if the fixed buffer size is wrong. Correct
+ * size in @a *pcbRet.
+ * @retval VERR_BUFFER_OVERFLOW if the function doesn't have a fixed size
+ * buffer and the buffer isn't big enough. Correct size in @a *pcbRet.
+ * @retval VERR_INVALID_HANDLE if the handle is invalid.
+ *
+ * @param hLdrMod The module handle.
+ * @param enmProp The property to query.
+ * @param pvBits Optional pointer to bits returned by
+ * RTLdrGetBits(). This can be utilized by some module
+ * interpreters to reduce memory consumption and file
+ * access.
+ * @param pvBuf Pointer to the input / output buffer. In most cases
+ * it's only used for returning data.
+ * @param cbBuf The size of the buffer.
+ * @param pcbRet Where to return the amount of data returned. On
+ * buffer size errors, this is set to the correct size.
+ * Optional.
+ */
+RTDECL(int) RTLdrQueryPropEx(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void *pvBits, void *pvBuf, size_t cbBuf, size_t *pcbRet);
+
+
+/**
+ * Signature type, see FNRTLDRVALIDATESIGNEDDATA.
+ */
+typedef enum RTLDRSIGNATURETYPE
+{
+ /** Invalid value. */
+ RTLDRSIGNATURETYPE_INVALID = 0,
+ /** A RTPKCS7CONTENTINFO structure w/ RTPKCS7SIGNEDDATA inside.
+ * It's parsed, so the whole binary ASN.1 representation can be found by
+ * using RTASN1CORE_GET_RAW_ASN1_PTR() and RTASN1CORE_GET_RAW_ASN1_SIZE(). */
+ RTLDRSIGNATURETYPE_PKCS7_SIGNED_DATA,
+ /** End of valid values. */
+ RTLDRSIGNATURETYPE_END,
+ /** Make sure the size is 32-bit. */
+ RTLDRSIGNATURETYPE_32BIT_HACK = 0x7fffffff
+} RTLDRSIGNATURETYPE;
+
+/**
+ * Signature information provided by FNRTLDRVALIDATESIGNEDDATA.
+ */
+typedef struct RTLDRSIGNATUREINFO
+{
+ /** The signature number (0-based). */
+ uint16_t iSignature;
+ /** The total number of signatures. */
+ uint16_t cSignatures;
+ /** Sginature format type. */
+ RTLDRSIGNATURETYPE enmType;
+ /** The signature data (formatted according to enmType). */
+ void const *pvSignature;
+ /** The size of the buffer pvSignature points to. */
+ size_t cbSignature;
+ /** Pointer to the signed data, if external.
+ * NULL if the data is internal to the signature structure. */
+ void const *pvExternalData;
+ /** Size of the signed data, if external.
+ * 0 if internal to the signature structure. */
+ size_t cbExternalData;
+} RTLDRSIGNATUREINFO;
+/** Pointer to a signature structure. */
+typedef RTLDRSIGNATUREINFO *PRTLDRSIGNATUREINFO;
+/** Pointer to a const signature structure. */
+typedef RTLDRSIGNATUREINFO const *PCRTLDRSIGNATUREINFO;
+
+/**
+ * Callback used by RTLdrVerifySignature to verify the signature and associated
+ * certificates.
+ *
+ * This is called multiple times when the executable contains more than one
+ * signature (PE only at the moment). The RTLDRSIGNATUREINFO::cSignatures gives
+ * the total number of signatures (and thereby callbacks) and
+ * RTLDRSIGNATUREINFO::iSignature indicates the current one.
+ *
+ * @returns IPRT status code. A status code other than VINF_SUCCESS will
+ * prevent callbacks the remaining signatures (if any).
+ * @param hLdrMod The module handle.
+ * @param pInfo Signature information.
+ * @param pErrInfo Pointer to an error info buffer, optional.
+ * @param pvUser User argument.
+ */
+typedef DECLCALLBACKTYPE(int, FNRTLDRVALIDATESIGNEDDATA,(RTLDRMOD hLdrMod, PCRTLDRSIGNATUREINFO pInfo,
+ PRTERRINFO pErrInfo, void *pvUser));
+/** Pointer to a signature verification callback. */
+typedef FNRTLDRVALIDATESIGNEDDATA *PFNRTLDRVALIDATESIGNEDDATA;
+
+/**
+ * Verify the image signature.
+ *
+ * This may permform additional integrity checks on the image structures that
+ * was not done when opening the image.
+ *
+ * @returns IPRT status code.
+ * @retval VERR_LDRVI_NOT_SIGNED if not signed.
+ *
+ * @param hLdrMod The module handle.
+ * @param pfnCallback Callback that does the signature and certificate
+ * verficiation.
+ * @param pvUser User argument for the callback.
+ * @param pErrInfo Pointer to an error info buffer. Optional.
+ */
+RTDECL(int) RTLdrVerifySignature(RTLDRMOD hLdrMod, PFNRTLDRVALIDATESIGNEDDATA pfnCallback, void *pvUser, PRTERRINFO pErrInfo);
+
+/**
+ * Calculate the image hash according the image signing rules.
+ *
+ * @returns IPRT status code.
+ * @param hLdrMod The module handle.
+ * @param enmDigest Which kind of digest.
+ * @param pabHash Where to store the image hash.
+ * @param cbHash Size of the buffer @a pabHash points at. The
+ * required and returned size can be derived from the
+ * digest type (@a enmDigest).
+ */
+RTDECL(int) RTLdrHashImage(RTLDRMOD hLdrMod, RTDIGESTTYPE enmDigest, uint8_t *pabHash, size_t cbHash);
+
+/**
+ * Try use unwind information to unwind one frame.
+ *
+ * @returns IPRT status code. Last informational status from stack reader callback.
+ * @retval VERR_DBG_NO_UNWIND_INFO if the module contains no unwind information.
+ * @retval VERR_DBG_UNWIND_INFO_NOT_FOUND if no unwind information was found
+ * for the location given by iSeg:off.
+ *
+ * @param hLdrMod The module handle.
+ * @param pvBits Optional pointer to bits returned by
+ * RTLdrGetBits(). This can be utilized by some module
+ * interpreters to reduce memory consumption and file
+ * access.
+ * @param iSeg The segment number of the program counter. UINT32_MAX if RVA.
+ * @param off The offset into @a iSeg. Together with @a iSeg
+ * this corresponds to the RTDBGUNWINDSTATE::uPc
+ * value pointed to by @a pState.
+ * @param pState The unwind state to work.
+ *
+ * @sa RTDbgModUnwindFrame
+ */
+RTDECL(int) RTLdrUnwindFrame(RTLDRMOD hLdrMod, void const *pvBits, uint32_t iSeg, RTLDRADDR off, PRTDBGUNWINDSTATE pState);
+
+RT_C_DECLS_END
+
+/** @} */
+
+#endif /* !IPRT_INCLUDED_ldr_h */
+