ldr.h@ 73358

Last change on this file since 73358 was 73150, checked in by vboxsync, 6 years ago

VMM,DBGC,IPRT: In memory

VMM: Morphed part of the NT kernel digger into DBGFR3ModInMem.
DBGC: Added 'loadinmem' command for accessing the DBGFR3ModInMem functionality.
IPRT: Modified RTDbgModCreateFromPeImage to clearly indicate to caller whether the loader module was consumed or not (missing direct ref counting).
IPRT: Added RTLdrGetHostArch for resolving RTLDRARCH_HOST.
IPRT: Added RTLdrArchName for naming a RTLDRARCH value.

Property svn:eol-style set to native
Property svn:keywords set to Author Date Id Revision

File size: 45.2 KB

Line
1	/** @file
2	* IPRT - Loader.
3	*/
4
5	/*
6	* Copyright (C) 2006-2017 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___iprt_ldr_h
27	#define ___iprt_ldr_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31
32
33	/** @defgroup grp_ldr RTLdr - Loader
34	* @ingroup grp_rt
35	* @{
36	*/
37
38
39	RT_C_DECLS_BEGIN
40
41	/** Loader address (unsigned integer). */
42	typedef RTUINTPTR RTLDRADDR;
43	/** Pointer to a loader address. */
44	typedef RTLDRADDR *PRTLDRADDR;
45	/** Pointer to a const loader address. */
46	typedef RTLDRADDR const *PCRTLDRADDR;
47	/** The max loader address value. */
48	#define RTLDRADDR_MAX RTUINTPTR_MAX
49	/** NIL loader address value. */
50	#define NIL_RTLDRADDR RTLDRADDR_MAX
51
52
53	/**
54	* Loader module format.
55	*/
56	typedef enum RTLDRFMT
57	{
58	/** The usual invalid 0 format. */
59	RTLDRFMT_INVALID = 0,
60	/** The native OS loader. */
61	RTLDRFMT_NATIVE,
62	/** The AOUT loader. */
63	RTLDRFMT_AOUT,
64	/** The ELF loader. */
65	RTLDRFMT_ELF,
66	/** The LX loader. */
67	RTLDRFMT_LX,
68	/** The Mach-O loader. */
69	RTLDRFMT_MACHO,
70	/** The PE loader. */
71	RTLDRFMT_PE,
72	/** The end of the valid format values (exclusive). */
73	RTLDRFMT_END,
74	/** Hack to blow the type up to 32-bit. */
75	RTLDRFMT_32BIT_HACK = 0x7fffffff
76	} RTLDRFMT;
77
78
79	/**
80	* Loader module type.
81	*/
82	typedef enum RTLDRTYPE
83	{
84	/** The usual invalid 0 type. */
85	RTLDRTYPE_INVALID = 0,
86	/** Object file. */
87	RTLDRTYPE_OBJECT,
88	/** Executable module, fixed load address. */
89	RTLDRTYPE_EXECUTABLE_FIXED,
90	/** Executable module, relocatable, non-fixed load address. */
91	RTLDRTYPE_EXECUTABLE_RELOCATABLE,
92	/** Executable module, position independent code, non-fixed load address. */
93	RTLDRTYPE_EXECUTABLE_PIC,
94	/** Shared library, fixed load address.
95	* Typically a system library. */
96	RTLDRTYPE_SHARED_LIBRARY_FIXED,
97	/** Shared library, relocatable, non-fixed load address. */
98	RTLDRTYPE_SHARED_LIBRARY_RELOCATABLE,
99	/** Shared library, position independent code, non-fixed load address. */
100	RTLDRTYPE_SHARED_LIBRARY_PIC,
101	/** DLL that contains no code or data only imports and exports. (Chiefly OS/2.) */
102	RTLDRTYPE_FORWARDER_DLL,
103	/** Core or dump. */
104	RTLDRTYPE_CORE,
105	/** Debug module (debug info with empty code & data segments). */
106	RTLDRTYPE_DEBUG_INFO,
107	/** The end of the valid types values (exclusive). */
108	RTLDRTYPE_END,
109	/** Hack to blow the type up to 32-bit. */
110	RTLDRTYPE_32BIT_HACK = 0x7fffffff
111	} RTLDRTYPE;
112
113
114	/**
115	* Loader endian indicator.
116	*/
117	typedef enum RTLDRENDIAN
118	{
119	/** The usual invalid endian. */
120	RTLDRENDIAN_INVALID,
121	/** Little endian. */
122	RTLDRENDIAN_LITTLE,
123	/** Bit endian. */
124	RTLDRENDIAN_BIG,
125	/** Endianness doesn't have a meaning in the context. */
126	RTLDRENDIAN_NA,
127	/** The end of the valid endian values (exclusive). */
128	RTLDRENDIAN_END,
129	/** Hack to blow the type up to 32-bit. */
130	RTLDRENDIAN_32BIT_HACK = 0x7fffffff
131	} RTLDRENDIAN;
132
133
134	/** Pointer to a loader reader instance. */
135	typedef struct RTLDRREADER *PRTLDRREADER;
136	/**
137	* Loader image reader instance.
138	*
139	* @remarks The reader will typically have a larger structure wrapping this one
140	* for storing necessary instance variables.
141	*
142	* The loader ASSUMES the caller serializes all access to the
143	* individual loader module handlers, thus no serialization is required
144	* when implementing this interface.
145	*/
146	typedef struct RTLDRREADER
147	{
148	/** Magic value (RTLDRREADER_MAGIC). */
149	uintptr_t uMagic;
150
151	/**
152	* Reads bytes at a give place in the raw image.
153	*
154	* @returns iprt status code.
155	* @param pReader Pointer to the reader instance.
156	* @param pvBuf Where to store the bits.
157	* @param cb Number of bytes to read.
158	* @param off Where to start reading relative to the start of the raw image.
159	*/
160	DECLCALLBACKMEMBER(int, pfnRead)(PRTLDRREADER pReader, void *pvBuf, size_t cb, RTFOFF off);
161
162	/**
163	* Tells end position of last read.
164	*
165	* @returns position relative to start of the raw image.
166	* @param pReader Pointer to the reader instance.
167	*/
168	DECLCALLBACKMEMBER(RTFOFF, pfnTell)(PRTLDRREADER pReader);
169
170	/**
171	* Gets the size of the raw image bits.
172	*
173	* @returns size of raw image bits in bytes.
174	* @param pReader Pointer to the reader instance.
175	*/
176	DECLCALLBACKMEMBER(RTFOFF, pfnSize)(PRTLDRREADER pReader);
177
178	/**
179	* Map the bits into memory.
180	*
181	* The mapping will be freed upon calling pfnDestroy() if not pfnUnmap()
182	* is called before that. The mapping is read only.
183	*
184	* @returns iprt status code.
185	* @param pReader Pointer to the reader instance.
186	* @param ppvBits Where to store the address of the memory mapping on success.
187	* The size of the mapping can be obtained by calling pfnSize().
188	*/
189	DECLCALLBACKMEMBER(int, pfnMap)(PRTLDRREADER pReader, const void **ppvBits);
190
191	/**
192	* Unmap bits.
193	*
194	* @returns iprt status code.
195	* @param pReader Pointer to the reader instance.
196	* @param pvBits Memory pointer returned by pfnMap().
197	*/
198	DECLCALLBACKMEMBER(int, pfnUnmap)(PRTLDRREADER pReader, const void *pvBits);
199
200	/**
201	* Gets the most appropriate log name.
202	*
203	* @returns Pointer to readonly log name.
204	* @param pReader Pointer to the reader instance.
205	*/
206	DECLCALLBACKMEMBER(const char *, pfnLogName)(PRTLDRREADER pReader);
207
208	/**
209	* Releases all resources associated with the reader instance.
210	* The instance is invalid after this call returns.
211	*
212	* @returns iprt status code.
213	* @param pReader Pointer to the reader instance.
214	*/
215	DECLCALLBACKMEMBER(int, pfnDestroy)(PRTLDRREADER pReader);
216	} RTLDRREADER;
217
218	/** Magic value for RTLDRREADER (Gordon Matthew Thomas Sumner / Sting). */
219	#define RTLDRREADER_MAGIC UINT32_C(0x19511002)
220
221
222	/**
223	* Gets the default file suffix for DLL/SO/DYLIB/whatever.
224	*
225	* @returns The stuff (readonly).
226	*/
227	RTDECL(const char *) RTLdrGetSuff(void);
228
229	/**
230	* Checks if a library is loadable or not.
231	*
232	* This may attempt load and unload the library.
233	*
234	* @returns true/false accordingly.
235	* @param pszFilename Image filename.
236	*/
237	RTDECL(bool) RTLdrIsLoadable(const char *pszFilename);
238
239	/**
240	* Loads a dynamic load library (/shared object) image file using native
241	* OS facilities.
242	*
243	* The filename will be appended the default DLL/SO extension of
244	* the platform if it have been omitted. This means that it's not
245	* possible to load DLLs/SOs with no extension using this interface,
246	* but that's not a bad tradeoff.
247	*
248	* If no path is specified in the filename, the OS will usually search it's library
249	* path to find the image file.
250	*
251	* @returns iprt status code.
252	* @param pszFilename Image filename.
253	* @param phLdrMod Where to store the handle to the loader module.
254	*/
255	RTDECL(int) RTLdrLoad(const char *pszFilename, PRTLDRMOD phLdrMod);
256
257	/**
258	* Loads a dynamic load library (/shared object) image file using native
259	* OS facilities.
260	*
261	* The filename will be appended the default DLL/SO extension of
262	* the platform if it have been omitted. This means that it's not
263	* possible to load DLLs/SOs with no extension using this interface,
264	* but that's not a bad tradeoff.
265	*
266	* If no path is specified in the filename, the OS will usually search it's library
267	* path to find the image file.
268	*
269	* @returns iprt status code.
270	* @param pszFilename Image filename.
271	* @param phLdrMod Where to store the handle to the loader module.
272	* @param fFlags See RTLDRLOAD_FLAGS_XXX.
273	* @param pErrInfo Where to return extended error information. Optional.
274	*/
275	RTDECL(int) RTLdrLoadEx(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo);
276
277	/** @defgroup RTLDRLOAD_FLAGS_XXX RTLdrLoadEx flags.
278	* @{ */
279	/** Symbols defined in this library are not made available to resolve
280	* references in subsequently loaded libraries (default). */
281	#define RTLDRLOAD_FLAGS_LOCAL UINT32_C(0)
282	/** Symbols defined in this library will be made available for symbol
283	* resolution of subsequently loaded libraries. */
284	#define RTLDRLOAD_FLAGS_GLOBAL RT_BIT_32(0)
285	/** Do not unload the library upon RTLdrClose. (For system libs.) */
286	#define RTLDRLOAD_FLAGS_NO_UNLOAD RT_BIT_32(1)
287	/** Windows/NT: Search the DLL load directory for imported DLLs - W7,
288	* Vista, and W2K8 requires KB2533623 to be installed to support this; not
289	* supported on XP, W2K3 or earlier. Ignored on other platforms. */
290	#define RTLDRLOAD_FLAGS_NT_SEARCH_DLL_LOAD_DIR RT_BIT_32(2)
291	/** The mask of valid flag bits. */
292	#define RTLDRLOAD_FLAGS_VALID_MASK UINT32_C(0x00000007)
293	/** @} */
294
295	/**
296	* Loads a dynamic load library (/shared object) image file residing in one of
297	* the default system library locations.
298	*
299	* Only the system library locations are searched. No suffix is required.
300	*
301	* @returns iprt status code.
302	* @param pszFilename Image filename. No path.
303	* @param fNoUnload Do not unload the library when RTLdrClose is called.
304	* @param phLdrMod Where to store the handle to the loaded module.
305	*/
306	RTDECL(int) RTLdrLoadSystem(const char *pszFilename, bool fNoUnload, PRTLDRMOD phLdrMod);
307
308	/**
309	* Combines RTLdrLoadSystem and RTLdrGetSymbol, with fNoUnload set to true.
310	*
311	* @returns The symbol value, NULL on failure. (If you care for a less boolean
312	* status, go thru the necessary API calls yourself.)
313	* @param pszFilename Image filename. No path.
314	* @param pszSymbol Symbol name.
315	*/
316	RTDECL(void ) RTLdrGetSystemSymbol(const char pszFilename, const char *pszSymbol);
317
318	/**
319	* Loads a dynamic load library (/shared object) image file residing in the
320	* RTPathAppPrivateArch() directory.
321	*
322	* Suffix is not required.
323	*
324	* @returns iprt status code.
325	* @param pszFilename Image filename. No path.
326	* @param phLdrMod Where to store the handle to the loaded module.
327	*/
328	RTDECL(int) RTLdrLoadAppPriv(const char *pszFilename, PRTLDRMOD phLdrMod);
329
330	/**
331	* Gets the native module handle for a module loaded by RTLdrLoad, RTLdrLoadEx,
332	* RTLdrLoadSystem, or RTLdrLoadAppPriv.
333	*
334	* @returns Native handle on success, ~(uintptr_t)0 on failure.
335	* @param hLdrMod The loader module handle.
336	*/
337	RTDECL(uintptr_t) RTLdrGetNativeHandle(RTLDRMOD hLdrMod);
338
339
340	/**
341	* Image architecuture specifier for RTLdrOpenEx.
342	*/
343	typedef enum RTLDRARCH
344	{
345	RTLDRARCH_INVALID = 0,
346	/** Whatever. */
347	RTLDRARCH_WHATEVER,
348	/** The host architecture. */
349	RTLDRARCH_HOST,
350	/** 32-bit x86. */
351	RTLDRARCH_X86_32,
352	/** AMD64 (64-bit x86 if you like). */
353	RTLDRARCH_AMD64,
354	/** 32-bit ARM. */
355	RTLDRARCH_ARM32,
356	/** 64-bit ARM. */
357	RTLDRARCH_ARM64,
358	/** End of the valid values. */
359	RTLDRARCH_END,
360	/** Make sure the type is a full 32-bit. */
361	RTLDRARCH_32BIT_HACK = 0x7fffffff
362	} RTLDRARCH;
363	/** Pointer to a RTLDRARCH. */
364	typedef RTLDRARCH *PRTLDRARCH;
365
366	/**
367	* Translates a RTLDRARCH value to a string.
368	*
369	* @returns Name corresponding to @a enmArch
370	* @param enmArch The value to name.
371	*/
372	RTDECL(const char *) RTLdrArchName(RTLDRARCH enmArch);
373
374	/**
375	* Returns the host architecture.
376	*
377	* @returns Host architecture or RTLDRARCH_WHATEVER if no match.
378	*/
379	RTDECL(RTLDRARCH) RTLdrGetHostArch(void);
380
381
382	/** @name RTLDR_O_XXX - RTLdrOpen flags.
383	* @{ */
384	/** Open for debugging or introspection reasons.
385	* This will skip a few of the stricter validations when loading images. */
386	#define RTLDR_O_FOR_DEBUG RT_BIT_32(0)
387	/** Open for signature validation. */
388	#define RTLDR_O_FOR_VALIDATION RT_BIT_32(1)
389	/** The arch specification is just a guideline for FAT binaries. */
390	#define RTLDR_O_WHATEVER_ARCH RT_BIT_32(2)
391	/** Ignore the architecture specification if there is no code. */
392	#define RTLDR_O_IGNORE_ARCH_IF_NO_CODE RT_BIT_32(3)
393	/** Mask of valid flags. */
394	#define RTLDR_O_VALID_MASK UINT32_C(0x0000000f)
395	/** @} */
396
397	/**
398	* Open a binary image file.
399	*
400	* @returns iprt status code.
401	* @param pszFilename Image filename.
402	* @param fFlags Valid RTLDR_O_XXX combination.
403	* @param enmArch CPU architecture specifier for the image to be loaded.
404	* @param phLdrMod Where to store the handle to the loader module.
405	*/
406	RTDECL(int) RTLdrOpen(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod);
407
408	/**
409	* Open a binary image file, extended version.
410	*
411	* @returns iprt status code.
412	* @param pszFilename Image filename.
413	* @param fFlags Valid RTLDR_O_XXX combination.
414	* @param enmArch CPU architecture specifier for the image to be loaded.
415	* @param phLdrMod Where to store the handle to the loader module.
416	* @param pErrInfo Where to return extended error information. Optional.
417	*/
418	RTDECL(int) RTLdrOpenEx(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod, PRTERRINFO pErrInfo);
419
420	/**
421	* Opens a binary image file using kLdr.
422	*
423	* @returns iprt status code.
424	* @param pszFilename Image filename.
425	* @param phLdrMod Where to store the handle to the loaded module.
426	* @param fFlags Valid RTLDR_O_XXX combination.
427	* @param enmArch CPU architecture specifier for the image to be loaded.
428	* @remark Primarily for testing the loader.
429	*/
430	RTDECL(int) RTLdrOpenkLdr(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod);
431
432	/**
433	* Open a binary image file allowing VFS chains in the filename.
434	*
435	* @returns iprt status code.
436	* @param pszFilename Image filename, VFS chain specifiers allowed.
437	* @param fFlags Valid RTLDR_O_XXX combination.
438	* @param enmArch CPU architecture specifier for the image to be loaded.
439	* @param phLdrMod Where to store the handle to the loader module.
440	* @param poffError Where to return the offset into @a pszFilename of an VFS
441	* chain element causing trouble. Optional.
442	* @param pErrInfo Where to return extended error information. Optional.
443	*/
444	RTDECL(int) RTLdrOpenVfsChain(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch,
445	PRTLDRMOD phLdrMod, uint32_t *poffError, PRTERRINFO pErrInfo);
446
447	/**
448	* Open a binary image file using kLdr allowing VFS chains in the filename.
449	*
450	* @returns iprt status code.
451	* @param pszFilename Image filename.
452	* @param fFlags Reserved, MBZ.
453	* @param enmArch CPU architecture specifier for the image to be loaded.
454	* @param phLdrMod Where to store the handle to the loaded module.
455	* @param poffError Where to return the offset into @a pszFilename of an VFS
456	* chain element causing trouble. Optional.
457	* @param pErrInfo Where to return extended error information. Optional.
458	* @remark Primarily for testing the loader.
459	*/
460	RTDECL(int) RTLdrOpenVfsChainkLdr(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch,
461	PRTLDRMOD phLdrMod, uint32_t *poffError, PRTERRINFO pErrInfo);
462
463	/**
464	* Open part with reader.
465	*
466	* @returns iprt status code.
467	* @param pReader The loader reader instance which will provide the raw
468	* image bits. The reader instance will be consumed on
469	* success. On failure, the caller has to do the cleaning
470	* up.
471	* @param fFlags Valid RTLDR_O_XXX combination.
472	* @param enmArch Architecture specifier.
473	* @param phMod Where to store the handle.
474	* @param pErrInfo Where to return extended error information. Optional.
475	*/
476	RTDECL(int) RTLdrOpenWithReader(PRTLDRREADER pReader, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phMod, PRTERRINFO pErrInfo);
477
478	/**
479	* Called to read @a cb bytes at @a off into @a pvBuf.
480	*
481	* @returns IPRT status code
482	* @param pvBuf The output buffer.
483	* @param cb The number of bytes to read.
484	* @param off Where to start reading.
485	* @param pvUser The user parameter.
486	*/
487	typedef DECLCALLBACK(int) FNRTLDRRDRMEMREAD(void pvBuf, size_t cb, size_t off, void pvUser);
488	/** Pointer to a RTLdrOpenInMemory reader callback. */
489	typedef FNRTLDRRDRMEMREAD *PFNRTLDRRDRMEMREAD;
490
491	/**
492	* Called to when the module is unloaded (or done loading) to release resources
493	* associated with it (@a pvUser).
494	*
495	* @returns IPRT status code
496	* @param pvUser The user parameter.
497	*/
498	typedef DECLCALLBACK(void) FNRTLDRRDRMEMDTOR(void *pvUser);
499	/** Pointer to a RTLdrOpenInMemory destructor callback. */
500	typedef FNRTLDRRDRMEMDTOR *PFNRTLDRRDRMEMDTOR;
501
502	/**
503	* Open a in-memory image or an image with a custom reader callback.
504	*
505	* @returns IPRT status code.
506	* @param pszName The image name.
507	* @param fFlags Valid RTLDR_O_XXX combination.
508	* @param enmArch CPU architecture specifier for the image to be loaded.
509	* @param cbImage The size of the image (fake file).
510	* @param pfnRead The read function. If NULL is passed in, a default
511	* reader function is provided that assumes @a pvUser
512	* points to the raw image bits, at least @a cbImage of
513	* valid memory.
514	* @param pfnDtor The destructor function. If NULL is passed, a default
515	* destructor will be provided that passes @a pvUser to
516	* RTMemFree.
517	* @param pvUser The user argument or, if any of the callbacks are NULL,
518	* a pointer to a memory block.
519	* @param phLdrMod Where to return the module handle.
520	* @param pErrInfo Pointer to an error info buffer, optional.
521	*
522	* @remarks With the exception of invalid @a pfnDtor and/or @a pvUser
523	* parameters, the pfnDtor methods (or the default one if NULL) will
524	* always be invoked. The destruction of pvUser is entirely in the
525	* hands of this method once it's called.
526	*/
527	RTDECL(int) RTLdrOpenInMemory(const char *pszName, uint32_t fFlags, RTLDRARCH enmArch, size_t cbImage,
528	PFNRTLDRRDRMEMREAD pfnRead, PFNRTLDRRDRMEMDTOR pfnDtor, void *pvUser,
529	PRTLDRMOD phLdrMod, PRTERRINFO pErrInfo);
530
531	/**
532	* Closes a loader module handle.
533	*
534	* The handle can be obtained using any of the RTLdrLoad(), RTLdrOpen()
535	* and RTLdrOpenInMemory() functions.
536	*
537	* @returns iprt status code.
538	* @param hLdrMod The loader module handle.
539	*/
540	RTDECL(int) RTLdrClose(RTLDRMOD hLdrMod);
541
542	/**
543	* Gets the address of a named exported symbol.
544	*
545	* @returns iprt status code.
546	* @retval VERR_LDR_FORWARDER forwarder, use pfnQueryForwarderInfo. Buffer size
547	* hint in @a ppvValue.
548	* @param hLdrMod The loader module handle.
549	* @param pszSymbol Symbol name.
550	* @param ppvValue Where to store the symbol value. Note that this is restricted to the
551	* pointer size used on the host!
552	*/
553	RTDECL(int) RTLdrGetSymbol(RTLDRMOD hLdrMod, const char pszSymbol, void *ppvValue);
554
555	/**
556	* Gets the address of a named exported symbol.
557	*
558	* This function differs from the plain one in that it can deal with
559	* both GC and HC address sizes, and that it can calculate the symbol
560	* value relative to any given base address.
561	*
562	* @returns iprt status code.
563	* @retval VERR_LDR_FORWARDER forwarder, use pfnQueryForwarderInfo. Buffer size
564	* hint in @a pValue.
565	* @param hLdrMod The loader module handle.
566	* @param pvBits Optional pointer to the loaded image.
567	* Set this to NULL if no RTLdrGetBits() processed image bits are available.
568	* Not supported for RTLdrLoad() images.
569	* @param BaseAddress Image load address.
570	* Not supported for RTLdrLoad() images.
571	* @param iOrdinal Symbol ordinal number, pass UINT32_MAX if pszSymbol
572	* should be used instead.
573	* @param pszSymbol Symbol name.
574	* @param pValue Where to store the symbol value.
575	*/
576	RTDECL(int) RTLdrGetSymbolEx(RTLDRMOD hLdrMod, const void *pvBits, RTLDRADDR BaseAddress,
577	uint32_t iOrdinal, const char *pszSymbol, PRTLDRADDR pValue);
578
579	/**
580	* Gets the address of a named exported function.
581	*
582	* Same as RTLdrGetSymbol, but skips the status code and pointer to return
583	* variable stuff.
584	*
585	* @returns Pointer to the function if found, NULL if not.
586	* @param hLdrMod The loader module handle.
587	* @param pszSymbol Function name.
588	*/
589	RTDECL(PFNRT) RTLdrGetFunction(RTLDRMOD hLdrMod, const char *pszSymbol);
590
591	/**
592	* Information about an imported symbol.
593	*/
594	typedef struct RTLDRIMPORTINFO
595	{
596	/** Symbol table entry number, UINT32_MAX if not available. */
597	uint32_t iSelfOrdinal;
598	/** The ordinal of the imported symbol in szModule, UINT32_MAX if not used. */
599	uint32_t iOrdinal;
600	/** The symbol name, NULL if not used. This points to the char immediately
601	* following szModule when returned by RTLdrQueryForwarderInfo. */
602	const char *pszSymbol;
603	/** The name of the module being imported from. */
604	char szModule[1];
605	} RTLDRIMPORTINFO;
606	/** Pointer to information about an imported symbol. */
607	typedef RTLDRIMPORTINFO *PRTLDRIMPORTINFO;
608	/** Pointer to const information about an imported symbol. */
609	typedef RTLDRIMPORTINFO const *PCRTLDRIMPORTINFO;
610
611	/**
612	* Query information about a forwarded symbol.
613	*
614	* @returns IPRT status code.
615	* @param hLdrMod The loader module handle.
616	* @param pvBits Optional pointer to the loaded image.
617	* Set this to NULL if no RTLdrGetBits() processed image bits are available.
618	* Not supported for RTLdrLoad() images.
619	* @param iOrdinal Symbol ordinal number, pass UINT32_MAX if pszSymbol
620	* should be used instead.
621	* @param pszSymbol Symbol name.
622	* @param pInfo Where to return the forwarder info.
623	* @param cbInfo Size of the buffer @a pInfo points to. For a size
624	* hint, see @a pValue when RTLdrGetSymbolEx returns
625	* VERR_LDR_FORWARDER.
626	*/
627	RTDECL(int) RTLdrQueryForwarderInfo(RTLDRMOD hLdrMod, const void pvBits, uint32_t iOrdinal, const char pszSymbol,
628	PRTLDRIMPORTINFO pInfo, size_t cbInfo);
629
630
631	/**
632	* Gets the size of the loaded image.
633	*
634	* This is not necessarily available for images that has been loaded using
635	* RTLdrLoad().
636	*
637	* @returns image size (in bytes).
638	* @returns ~(size_t)0 on if not available.
639	* @param hLdrMod Handle to the loader module.
640	*/
641	RTDECL(size_t) RTLdrSize(RTLDRMOD hLdrMod);
642
643	/**
644	* Resolve an external symbol during RTLdrGetBits().
645	*
646	* @returns iprt status code.
647	* @param hLdrMod The loader module handle.
648	* @param pszModule Module name.
649	* @param pszSymbol Symbol name, NULL if uSymbol should be used.
650	* @param uSymbol Symbol ordinal, ~0 if pszSymbol should be used.
651	* @param pValue Where to store the symbol value (address).
652	* @param pvUser User argument.
653	*/
654	typedef DECLCALLBACK(int) FNRTLDRIMPORT(RTLDRMOD hLdrMod, const char pszModule, const char pszSymbol, unsigned uSymbol,
655	PRTLDRADDR pValue, void *pvUser);
656	/** Pointer to a FNRTLDRIMPORT() callback function. */
657	typedef FNRTLDRIMPORT *PFNRTLDRIMPORT;
658
659	/**
660	* Loads the image into a buffer provided by the user and applies fixups
661	* for the given base address.
662	*
663	* @returns iprt status code.
664	* @param hLdrMod The load module handle.
665	* @param pvBits Where to put the bits.
666	* Must be as large as RTLdrSize() suggests.
667	* @param BaseAddress The base address.
668	* @param pfnGetImport Callback function for resolving imports one by one.
669	* @param pvUser User argument for the callback.
670	* @remark Not supported for RTLdrLoad() images.
671	*/
672	RTDECL(int) RTLdrGetBits(RTLDRMOD hLdrMod, void pvBits, RTLDRADDR BaseAddress, PFNRTLDRIMPORT pfnGetImport, void pvUser);
673
674	/**
675	* Relocates bits after getting them.
676	* Useful for code which moves around a bit.
677	*
678	* @returns iprt status code.
679	* @param hLdrMod The loader module handle.
680	* @param pvBits Where the image bits are.
681	* Must have been passed to RTLdrGetBits().
682	* @param NewBaseAddress The new base address.
683	* @param OldBaseAddress The old base address.
684	* @param pfnGetImport Callback function for resolving imports one by one.
685	* @param pvUser User argument for the callback.
686	* @remark Not supported for RTLdrLoad() images.
687	*/
688	RTDECL(int) RTLdrRelocate(RTLDRMOD hLdrMod, void *pvBits, RTLDRADDR NewBaseAddress, RTLDRADDR OldBaseAddress,
689	PFNRTLDRIMPORT pfnGetImport, void *pvUser);
690
691	/**
692	* Enumeration callback function used by RTLdrEnumSymbols().
693	*
694	* @returns iprt status code. Failure will stop the enumeration.
695	* @param hLdrMod The loader module handle.
696	* @param pszSymbol Symbol name. NULL if ordinal only.
697	* @param uSymbol Symbol ordinal, ~0 if not used.
698	* @param Value Symbol value.
699	* @param pvUser The user argument specified to RTLdrEnumSymbols().
700	*/
701	typedef DECLCALLBACK(int) FNRTLDRENUMSYMS(RTLDRMOD hLdrMod, const char pszSymbol, unsigned uSymbol, RTLDRADDR Value, void pvUser);
702	/** Pointer to a FNRTLDRENUMSYMS() callback function. */
703	typedef FNRTLDRENUMSYMS *PFNRTLDRENUMSYMS;
704
705	/**
706	* Enumerates all symbols in a module.
707	*
708	* @returns iprt status code.
709	* @param hLdrMod The loader module handle.
710	* @param fFlags Flags indicating what to return and such.
711	* @param pvBits Optional pointer to the loaded image. (RTLDR_ENUM_SYMBOL_FLAGS_*)
712	* Set this to NULL if no RTLdrGetBits() processed image bits are available.
713	* @param BaseAddress Image load address.
714	* @param pfnCallback Callback function.
715	* @param pvUser User argument for the callback.
716	* @remark Not supported for RTLdrLoad() images.
717	*/
718	RTDECL(int) RTLdrEnumSymbols(RTLDRMOD hLdrMod, unsigned fFlags, const void pvBits, RTLDRADDR BaseAddress, PFNRTLDRENUMSYMS pfnCallback, void pvUser);
719
720	/** @name RTLdrEnumSymbols flags.
721	* @{ */
722	/** Returns ALL kinds of symbols. The default is to only return public/exported symbols. */
723	#define RTLDR_ENUM_SYMBOL_FLAGS_ALL RT_BIT(1)
724	/** Ignore forwarders rather than reporting them with RTLDR_ENUM_SYMBOL_FWD_ADDRESS as value. */
725	#define RTLDR_ENUM_SYMBOL_FLAGS_NO_FWD RT_BIT(2)
726	/** @} */
727
728	/** Special symbol for forwarder symbols, since they cannot be resolved with
729	* the current API. */
730	#if (HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64)
731	# define RTLDR_ENUM_SYMBOL_FWD_ADDRESS UINT64_C(0xff4242fffd4242fd)
732	#else
733	# define RTLDR_ENUM_SYMBOL_FWD_ADDRESS UINT32_C(0xff4242fd)
734	#endif
735
736
737	/**
738	* Debug info type (as far the loader can tell).
739	*/
740	typedef enum RTLDRDBGINFOTYPE
741	{
742	/** The invalid 0 value. */
743	RTLDRDBGINFOTYPE_INVALID = 0,
744	/** Unknown debug info format. */
745	RTLDRDBGINFOTYPE_UNKNOWN,
746	/** Stabs. */
747	RTLDRDBGINFOTYPE_STABS,
748	/** Debug With Arbitrary Record Format (DWARF). */
749	RTLDRDBGINFOTYPE_DWARF,
750	/** Debug With Arbitrary Record Format (DWARF), in external file (DWO). */
751	RTLDRDBGINFOTYPE_DWARF_DWO,
752	/** Microsoft Codeview debug info. */
753	RTLDRDBGINFOTYPE_CODEVIEW,
754	/** Microsoft Codeview debug info, in external v2.0+ program database (PDB). */
755	RTLDRDBGINFOTYPE_CODEVIEW_PDB20,
756	/** Microsoft Codeview debug info, in external v7.0+ program database (PDB). */
757	RTLDRDBGINFOTYPE_CODEVIEW_PDB70,
758	/** Microsoft Codeview debug info, in external file (DBG). */
759	RTLDRDBGINFOTYPE_CODEVIEW_DBG,
760	/** Microsoft COFF debug info. */
761	RTLDRDBGINFOTYPE_COFF,
762	/** Watcom debug info. */
763	RTLDRDBGINFOTYPE_WATCOM,
764	/** IBM High Level Language debug info. */
765	RTLDRDBGINFOTYPE_HLL,
766	/** The end of the valid debug info values (exclusive). */
767	RTLDRDBGINFOTYPE_END,
768	/** Blow the type up to 32-bits. */
769	RTLDRDBGINFOTYPE_32BIT_HACK = 0x7fffffff
770	} RTLDRDBGINFOTYPE;
771
772
773	/**
774	* Debug info details for the enumeration callback.
775	*/
776	typedef struct RTLDRDBGINFO
777	{
778	/** The kind of debug info. */
779	RTLDRDBGINFOTYPE enmType;
780	/** The debug info ordinal number / id. */
781	uint32_t iDbgInfo;
782	/** The file offset if this type has one specific location in the executable
783	* image file. This is -1 if there isn't any specific file location. */
784	RTFOFF offFile;
785	/** The link address of the debug info if it's loadable. NIL_RTLDRADDR if not
786	* loadable*/
787	RTLDRADDR LinkAddress;
788	/** The size of the debug information. -1 is used if this isn't applicable.*/
789	RTLDRADDR cb;
790	/** This is set if the debug information is found in an external file. NULL
791	* if no external file involved.
792	* @note Putting it outside the union to allow lazy callback implementation. */
793	const char *pszExtFile;
794	/** Type (enmType) specific information. */
795	union
796	{
797	/** RTLDRDBGINFOTYPE_DWARF */
798	struct
799	{
800	/** The section name. */
801	const char *pszSection;
802	} Dwarf;
803
804	/** RTLDRDBGINFOTYPE_DWARF_DWO */
805	struct
806	{
807	/** The CRC32 of the external file. */
808	uint32_t uCrc32;
809	} Dwo;
810
811	/** RTLDRDBGINFOTYPE_CODEVIEW, RTLDRDBGINFOTYPE_COFF */
812	struct
813	{
814	/** The PE image size. */
815	uint32_t cbImage;
816	/** The timestamp. */
817	uint32_t uTimestamp;
818	/** The major version from the entry. */
819	uint32_t uMajorVer;
820	/** The minor version from the entry. */
821	uint32_t uMinorVer;
822	} Cv, Coff;
823
824	/** RTLDRDBGINFOTYPE_CODEVIEW_DBG */
825	struct
826	{
827	/** The PE image size. */
828	uint32_t cbImage;
829	/** The timestamp. */
830	uint32_t uTimestamp;
831	} Dbg;
832
833	/** RTLDRDBGINFOTYPE_CODEVIEW_PDB20*/
834	struct
835	{
836	/** The PE image size. */
837	uint32_t cbImage;
838	/** The timestamp. */
839	uint32_t uTimestamp;
840	/** The PDB age. */
841	uint32_t uAge;
842	} Pdb20;
843
844	/** RTLDRDBGINFOTYPE_CODEVIEW_PDB70 */
845	struct
846	{
847	/** The PE image size. */
848	uint32_t cbImage;
849	/** The PDB age. */
850	uint32_t uAge;
851	/** The UUID. */
852	RTUUID Uuid;
853	} Pdb70;
854	} u;
855	} RTLDRDBGINFO;
856	/** Pointer to debug info details. */
857	typedef RTLDRDBGINFO *PRTLDRDBGINFO;
858	/** Pointer to read only debug info details. */
859	typedef RTLDRDBGINFO const *PCRTLDRDBGINFO;
860
861
862	/**
863	* Debug info enumerator callback.
864	*
865	* @returns VINF_SUCCESS to continue the enumeration. Any other status code
866	* will cause RTLdrEnumDbgInfo to immediately return with that status.
867	*
868	* @param hLdrMod The module handle.
869	* @param pDbgInfo Pointer to a read only structure with the details.
870	* @param pvUser The user parameter specified to RTLdrEnumDbgInfo.
871	*/
872	typedef DECLCALLBACK(int) FNRTLDRENUMDBG(RTLDRMOD hLdrMod, PCRTLDRDBGINFO pDbgInfo, void *pvUser);
873	/** Pointer to a debug info enumerator callback. */
874	typedef FNRTLDRENUMDBG *PFNRTLDRENUMDBG;
875
876	/**
877	* Enumerate the debug info contained in the executable image.
878	*
879	* @returns IPRT status code or whatever pfnCallback returns.
880	*
881	* @param hLdrMod The module handle.
882	* @param pvBits Optional pointer to bits returned by
883	* RTLdrGetBits(). This can be used by some module
884	* interpreters to reduce memory consumption.
885	* @param pfnCallback The callback function.
886	* @param pvUser The user argument.
887	*/
888	RTDECL(int) RTLdrEnumDbgInfo(RTLDRMOD hLdrMod, const void pvBits, PFNRTLDRENUMDBG pfnCallback, void pvUser);
889
890
891	/**
892	* Loader segment.
893	*/
894	typedef struct RTLDRSEG
895	{
896	/** The segment name. Always set to something. */
897	const char *pszName;
898	/** The length of the segment name. */
899	uint32_t cchName;
900	/** The flat selector to use for the segment (i.e. data/code).
901	* Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
902	uint16_t SelFlat;
903	/** The 16-bit selector to use for the segment.
904	* Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
905	uint16_t Sel16bit;
906	/** Segment flags. */
907	uint32_t fFlags;
908	/** The segment protection (RTMEM_PROT_XXX). */
909	uint32_t fProt;
910	/** The size of the segment. */
911	RTLDRADDR cb;
912	/** The required segment alignment.
913	* The to 0 if the segment isn't supposed to be mapped. */
914	RTLDRADDR Alignment;
915	/** The link address.
916	* Set to NIL_RTLDRADDR if the segment isn't supposed to be mapped or if
917	* the image doesn't have link addresses. */
918	RTLDRADDR LinkAddress;
919	/** File offset of the segment.
920	* Set to -1 if no file backing (like BSS). */
921	RTFOFF offFile;
922	/** Size of the file bits of the segment.
923	* Set to -1 if no file backing (like BSS). */
924	RTFOFF cbFile;
925	/** The relative virtual address when mapped.
926	* Set to NIL_RTLDRADDR if the segment isn't supposed to be mapped. */
927	RTLDRADDR RVA;
928	/** The size of the segment including the alignment gap up to the next segment when mapped.
929	* This is set to NIL_RTLDRADDR if not implemented. */
930	RTLDRADDR cbMapped;
931	} RTLDRSEG;
932	/** Pointer to a loader segment. */
933	typedef RTLDRSEG *PRTLDRSEG;
934	/** Pointer to a read only loader segment. */
935	typedef RTLDRSEG const *PCRTLDRSEG;
936
937
938	/** @name Segment flags
939	* @{ */
940	/** The segment is 16-bit. When not set the default of the target architecture is assumed. */
941	#define RTLDRSEG_FLAG_16BIT UINT32_C(1)
942	/** The segment requires a 16-bit selector alias. (OS/2) */
943	#define RTLDRSEG_FLAG_OS2_ALIAS16 UINT32_C(2)
944	/** Conforming segment (x86 weirdness). (OS/2) */
945	#define RTLDRSEG_FLAG_OS2_CONFORM UINT32_C(4)
946	/** IOPL (ring-2) segment. (OS/2) */
947	#define RTLDRSEG_FLAG_OS2_IOPL UINT32_C(8)
948	/** @} */
949
950	/**
951	* Segment enumerator callback.
952	*
953	* @returns VINF_SUCCESS to continue the enumeration. Any other status code
954	* will cause RTLdrEnumSegments to immediately return with that
955	* status.
956	*
957	* @param hLdrMod The module handle.
958	* @param pSeg The segment information.
959	* @param pvUser The user parameter specified to RTLdrEnumSegments.
960	*/
961	typedef DECLCALLBACK(int) FNRTLDRENUMSEGS(RTLDRMOD hLdrMod, PCRTLDRSEG pSeg, void *pvUser);
962	/** Pointer to a segment enumerator callback. */
963	typedef FNRTLDRENUMSEGS *PFNRTLDRENUMSEGS;
964
965	/**
966	* Enumerate the debug info contained in the executable image.
967	*
968	* @returns IPRT status code or whatever pfnCallback returns.
969	*
970	* @param hLdrMod The module handle.
971	* @param pfnCallback The callback function.
972	* @param pvUser The user argument.
973	*/
974	RTDECL(int) RTLdrEnumSegments(RTLDRMOD hLdrMod, PFNRTLDRENUMSEGS pfnCallback, void *pvUser);
975
976	/**
977	* Converts a link address to a segment:offset address.
978	*
979	* @returns IPRT status code.
980	*
981	* @param hLdrMod The module handle.
982	* @param LinkAddress The link address to convert.
983	* @param piSeg Where to return the segment index.
984	* @param poffSeg Where to return the segment offset.
985	*/
986	RTDECL(int) RTLdrLinkAddressToSegOffset(RTLDRMOD hLdrMod, RTLDRADDR LinkAddress, uint32_t *piSeg, PRTLDRADDR poffSeg);
987
988	/**
989	* Converts a link address to an image relative virtual address (RVA).
990	*
991	* @returns IPRT status code.
992	*
993	* @param hLdrMod The module handle.
994	* @param LinkAddress The link address to convert.
995	* @param pRva Where to return the RVA.
996	*/
997	RTDECL(int) RTLdrLinkAddressToRva(RTLDRMOD hLdrMod, RTLDRADDR LinkAddress, PRTLDRADDR pRva);
998
999	/**
1000	* Converts an image relative virtual address (RVA) to a segment:offset.
1001	*
1002	* @returns IPRT status code.
1003	*
1004	* @param hLdrMod The module handle.
1005	* @param iSeg The segment index.
1006	* @param offSeg The segment offset.
1007	* @param pRva Where to return the RVA.
1008	*/
1009	RTDECL(int) RTLdrSegOffsetToRva(RTLDRMOD hLdrMod, uint32_t iSeg, RTLDRADDR offSeg, PRTLDRADDR pRva);
1010
1011	/**
1012	* Converts a segment:offset into an image relative virtual address (RVA).
1013	*
1014	* @returns IPRT status code.
1015	*
1016	* @param hLdrMod The module handle.
1017	* @param Rva The link address to convert.
1018	* @param piSeg Where to return the segment index.
1019	* @param poffSeg Where to return the segment offset.
1020	*/
1021	RTDECL(int) RTLdrRvaToSegOffset(RTLDRMOD hLdrMod, RTLDRADDR Rva, uint32_t *piSeg, PRTLDRADDR poffSeg);
1022
1023	/**
1024	* Gets the image format.
1025	*
1026	* @returns Valid image format on success. RTLDRFMT_INVALID on invalid handle or
1027	* other errors.
1028	* @param hLdrMod The module handle.
1029	*/
1030	RTDECL(RTLDRFMT) RTLdrGetFormat(RTLDRMOD hLdrMod);
1031
1032	/**
1033	* Gets the image type.
1034	*
1035	* @returns Valid image type value on success. RTLDRTYPE_INVALID on
1036	* invalid handle or other errors.
1037	* @param hLdrMod The module handle.
1038	*/
1039	RTDECL(RTLDRTYPE) RTLdrGetType(RTLDRMOD hLdrMod);
1040
1041	/**
1042	* Gets the image endian-ness.
1043	*
1044	* @returns Valid image endian value on success. RTLDRENDIAN_INVALID on invalid
1045	* handle or other errors.
1046	* @param hLdrMod The module handle.
1047	*/
1048	RTDECL(RTLDRENDIAN) RTLdrGetEndian(RTLDRMOD hLdrMod);
1049
1050	/**
1051	* Gets the image endian-ness.
1052	*
1053	* @returns Valid image architecture value on success.
1054	* RTLDRARCH_INVALID on invalid handle or other errors.
1055	* @param hLdrMod The module handle.
1056	*/
1057	RTDECL(RTLDRARCH) RTLdrGetArch(RTLDRMOD hLdrMod);
1058
1059	/**
1060	* Loader properties that can be queried thru RTLdrQueryProp.
1061	*/
1062	typedef enum RTLDRPROP
1063	{
1064	RTLDRPROP_INVALID = 0,
1065	/** The image UUID (Mach-O).
1066	* Returns a RTUUID in the buffer. */
1067	RTLDRPROP_UUID,
1068	/** The image timestamp in seconds, genrally since unix epoc.
1069	* Returns a 32-bit or 64-bit signed integer value in the buffer. */
1070	RTLDRPROP_TIMESTAMP_SECONDS,
1071	/** Checks if the image is signed.
1072	* Returns a bool. */
1073	RTLDRPROP_IS_SIGNED,
1074	/** Retrives the PKCS \#7 SignedData blob that signs the image.
1075	* Returns variable sized buffer containing the ASN.1 BER encoding.
1076	*
1077	* @remarks This generally starts with a PKCS \#7 Content structure, the
1078	* SignedData bit is found a few levels down into this as per RFC. */
1079	RTLDRPROP_PKCS7_SIGNED_DATA,
1080
1081	/** Query whether code signature checks are enabled. */
1082	RTLDRPROP_SIGNATURE_CHECKS_ENFORCED,
1083
1084	/** Number of import or needed modules. */
1085	RTLDRPROP_IMPORT_COUNT,
1086	/** Import module by index (32-bit) stored in the buffer. */
1087	RTLDRPROP_IMPORT_MODULE,
1088	/** The file offset of the main executable header.
1089	* This is mainly for PE, NE and LX headers, but also Mach-O FAT. */
1090	RTLDRPROP_FILE_OFF_HEADER,
1091	/** The internal module name.
1092	* This is the SONAME for ELF, export table name for PE, and zero'th resident
1093	* name table entry for LX.
1094	* Returns zero terminated string. */
1095	RTLDRPROP_INTERNAL_NAME,
1096
1097	/** End of valid properties. */
1098	RTLDRPROP_END,
1099	/** Blow the type up to 32 bits. */
1100	RTLDRPROP_32BIT_HACK = 0x7fffffff
1101	} RTLDRPROP;
1102
1103	/**
1104	* Generic method for querying image properties.
1105	*
1106	* @returns IPRT status code.
1107	* @retval VERR_NOT_SUPPORTED if the property query isn't supported (either all
1108	* or that specific property). The caller must handle this result.
1109	* @retval VERR_NOT_FOUND the property was not found in the module. The caller
1110	* must also normally deal with this.
1111	* @retval VERR_INVALID_FUNCTION if the function value is wrong.
1112	* @retval VERR_INVALID_PARAMETER if the buffer size is wrong.
1113	* @retval VERR_BUFFER_OVERFLOW if the function doesn't have a fixed size
1114	* buffer and the buffer isn't big enough. Use RTLdrQueryPropEx.
1115	* @retval VERR_INVALID_HANDLE if the handle is invalid.
1116	*
1117	* @param hLdrMod The module handle.
1118	* @param enmProp The property to query.
1119	* @param pvBuf Pointer to the input / output buffer. In most cases
1120	* it's only used for returning data.
1121	* @param cbBuf The size of the buffer.
1122	*/
1123	RTDECL(int) RTLdrQueryProp(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void *pvBuf, size_t cbBuf);
1124
1125	/**
1126	* Generic method for querying image properties, extended version.
1127	*
1128	* @returns IPRT status code.
1129	* @retval VERR_NOT_SUPPORTED if the property query isn't supported (either all
1130	* or that specific property). The caller must handle this result.
1131	* @retval VERR_NOT_FOUND the property was not found in the module. The caller
1132	* must also normally deal with this.
1133	* @retval VERR_INVALID_FUNCTION if the function value is wrong.
1134	* @retval VERR_INVALID_PARAMETER if the fixed buffer size is wrong. Correct
1135	* size in @a *pcbRet.
1136	* @retval VERR_BUFFER_OVERFLOW if the function doesn't have a fixed size
1137	* buffer and the buffer isn't big enough. Correct size in @a *pcbRet.
1138	* @retval VERR_INVALID_HANDLE if the handle is invalid.
1139	*
1140	* @param hLdrMod The module handle.
1141	* @param enmProp The property to query.
1142	* @param pvBits Optional pointer to bits returned by
1143	* RTLdrGetBits(). This can be utilized by some module
1144	* interpreters to reduce memory consumption and file
1145	* access.
1146	* @param pvBuf Pointer to the input / output buffer. In most cases
1147	* it's only used for returning data.
1148	* @param cbBuf The size of the buffer.
1149	* @param pcbRet Where to return the amount of data returned. On
1150	* buffer size errors, this is set to the correct size.
1151	* Optional.
1152	*/
1153	RTDECL(int) RTLdrQueryPropEx(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void pvBits, void pvBuf, size_t cbBuf, size_t *pcbRet);
1154
1155
1156	/**
1157	* Signature type, see FNRTLDRVALIDATESIGNEDDATA.
1158	*/
1159	typedef enum RTLDRSIGNATURETYPE
1160	{
1161	/** Invalid value. */
1162	RTLDRSIGNATURETYPE_INVALID = 0,
1163	/** A RTPKCS7CONTENTINFO structure w/ RTPKCS7SIGNEDDATA inside.
1164	* It's parsed, so the whole binary ASN.1 representation can be found by
1165	* using RTASN1CORE_GET_RAW_ASN1_PTR() and RTASN1CORE_GET_RAW_ASN1_SIZE(). */
1166	RTLDRSIGNATURETYPE_PKCS7_SIGNED_DATA,
1167	/** End of valid values. */
1168	RTLDRSIGNATURETYPE_END,
1169	/** Make sure the size is 32-bit. */
1170	RTLDRSIGNATURETYPE_32BIT_HACK = 0x7fffffff
1171	} RTLDRSIGNATURETYPE;
1172
1173	/**
1174	* Callback used by RTLdrVerifySignature to verify the signature and associated
1175	* certificates.
1176	*
1177	* @returns IPRT status code.
1178	* @param hLdrMod The module handle.
1179	* @param enmSignature The signature format.
1180	* @param pvSignature The signature data. Format given by @a enmSignature.
1181	* @param cbSignature The size of the buffer @a pvSignature points to.
1182	* @param pErrInfo Pointer to an error info buffer, optional.
1183	* @param pvUser User argument.
1184	*
1185	*/
1186	typedef DECLCALLBACK(int) FNRTLDRVALIDATESIGNEDDATA(RTLDRMOD hLdrMod, RTLDRSIGNATURETYPE enmSignature, void const *pvSignature, size_t cbSignature,
1187	PRTERRINFO pErrInfo, void *pvUser);
1188	/** Pointer to a signature verification callback. */
1189	typedef FNRTLDRVALIDATESIGNEDDATA *PFNRTLDRVALIDATESIGNEDDATA;
1190
1191	/**
1192	* Verify the image signature.
1193	*
1194	* This may permform additional integrity checks on the image structures that
1195	* was not done when opening the image.
1196	*
1197	* @returns IPRT status code.
1198	* @retval VERR_LDRVI_NOT_SIGNED if not signed.
1199	*
1200	* @param hLdrMod The module handle.
1201	* @param pfnCallback Callback that does the signature and certificate
1202	* verficiation.
1203	* @param pvUser User argument for the callback.
1204	* @param pErrInfo Pointer to an error info buffer. Optional.
1205	*/
1206	RTDECL(int) RTLdrVerifySignature(RTLDRMOD hLdrMod, PFNRTLDRVALIDATESIGNEDDATA pfnCallback, void *pvUser, PRTERRINFO pErrInfo);
1207
1208	/**
1209	* Calculate the image hash according the image signing rules.
1210	*
1211	* @returns IPRT status code.
1212	* @param hLdrMod The module handle.
1213	* @param enmDigest Which kind of digest.
1214	* @param pszDigest Where to store the image digest.
1215	* @param cbDigest Size of the buffer @a pszDigest points at.
1216	*/
1217	RTDECL(int) RTLdrHashImage(RTLDRMOD hLdrMod, RTDIGESTTYPE enmDigest, char *pszDigest, size_t cbDigest);
1218
1219	RT_C_DECLS_END
1220
1221	/** @} */
1222
1223	#endif
1224

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/ldr.h@ 73358

Download in other formats: