ldr.h@ 71986

Last change on this file since 71986 was 70313, checked in by vboxsync, 7 years ago
IPRT/ldr: Made RTLdrEnumSymbols report forwards with value RTLDR_ENUM_SYMBOL_FWD_ADDRESS instead of skipping them.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 44.7 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	/** End of the valid values. */
355	RTLDRARCH_END,
356	/** Make sure the type is a full 32-bit. */
357	RTLDRARCH_32BIT_HACK = 0x7fffffff
358	} RTLDRARCH;
359	/** Pointer to a RTLDRARCH. */
360	typedef RTLDRARCH *PRTLDRARCH;
361
362	/** @name RTLDR_O_XXX - RTLdrOpen flags.
363	* @{ */
364	/** Open for debugging or introspection reasons.
365	* This will skip a few of the stricter validations when loading images. */
366	#define RTLDR_O_FOR_DEBUG RT_BIT_32(0)
367	/** Open for signature validation. */
368	#define RTLDR_O_FOR_VALIDATION RT_BIT_32(1)
369	/** The arch specification is just a guideline for FAT binaries. */
370	#define RTLDR_O_WHATEVER_ARCH RT_BIT_32(2)
371	/** Ignore the architecture specification if there is no code. */
372	#define RTLDR_O_IGNORE_ARCH_IF_NO_CODE RT_BIT_32(3)
373	/** Mask of valid flags. */
374	#define RTLDR_O_VALID_MASK UINT32_C(0x0000000f)
375	/** @} */
376
377	/**
378	* Open a binary image file.
379	*
380	* @returns iprt status code.
381	* @param pszFilename Image filename.
382	* @param fFlags Valid RTLDR_O_XXX combination.
383	* @param enmArch CPU architecture specifier for the image to be loaded.
384	* @param phLdrMod Where to store the handle to the loader module.
385	*/
386	RTDECL(int) RTLdrOpen(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod);
387
388	/**
389	* Open a binary image file, extended version.
390	*
391	* @returns iprt status code.
392	* @param pszFilename Image filename.
393	* @param fFlags Valid RTLDR_O_XXX combination.
394	* @param enmArch CPU architecture specifier for the image to be loaded.
395	* @param phLdrMod Where to store the handle to the loader module.
396	* @param pErrInfo Where to return extended error information. Optional.
397	*/
398	RTDECL(int) RTLdrOpenEx(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod, PRTERRINFO pErrInfo);
399
400	/**
401	* Opens a binary image file using kLdr.
402	*
403	* @returns iprt status code.
404	* @param pszFilename Image filename.
405	* @param phLdrMod Where to store the handle to the loaded module.
406	* @param fFlags Valid RTLDR_O_XXX combination.
407	* @param enmArch CPU architecture specifier for the image to be loaded.
408	* @remark Primarily for testing the loader.
409	*/
410	RTDECL(int) RTLdrOpenkLdr(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phLdrMod);
411
412	/**
413	* Open a binary image file allowing VFS chains in the filename.
414	*
415	* @returns iprt status code.
416	* @param pszFilename Image filename, VFS chain specifiers allowed.
417	* @param fFlags Valid RTLDR_O_XXX combination.
418	* @param enmArch CPU architecture specifier for the image to be loaded.
419	* @param phLdrMod Where to store the handle to the loader module.
420	* @param poffError Where to return the offset into @a pszFilename of an VFS
421	* chain element causing trouble. Optional.
422	* @param pErrInfo Where to return extended error information. Optional.
423	*/
424	RTDECL(int) RTLdrOpenVfsChain(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch,
425	PRTLDRMOD phLdrMod, uint32_t *poffError, PRTERRINFO pErrInfo);
426
427	/**
428	* Open a binary image file using kLdr allowing VFS chains in the filename.
429	*
430	* @returns iprt status code.
431	* @param pszFilename Image filename.
432	* @param fFlags Reserved, MBZ.
433	* @param enmArch CPU architecture specifier for the image to be loaded.
434	* @param phLdrMod Where to store the handle to the loaded module.
435	* @param poffError Where to return the offset into @a pszFilename of an VFS
436	* chain element causing trouble. Optional.
437	* @param pErrInfo Where to return extended error information. Optional.
438	* @remark Primarily for testing the loader.
439	*/
440	RTDECL(int) RTLdrOpenVfsChainkLdr(const char *pszFilename, uint32_t fFlags, RTLDRARCH enmArch,
441	PRTLDRMOD phLdrMod, uint32_t *poffError, PRTERRINFO pErrInfo);
442
443	/**
444	* Open part with reader.
445	*
446	* @returns iprt status code.
447	* @param pReader The loader reader instance which will provide the raw
448	* image bits. The reader instance will be consumed on
449	* success. On failure, the caller has to do the cleaning
450	* up.
451	* @param fFlags Valid RTLDR_O_XXX combination.
452	* @param enmArch Architecture specifier.
453	* @param phMod Where to store the handle.
454	* @param pErrInfo Where to return extended error information. Optional.
455	*/
456	RTDECL(int) RTLdrOpenWithReader(PRTLDRREADER pReader, uint32_t fFlags, RTLDRARCH enmArch, PRTLDRMOD phMod, PRTERRINFO pErrInfo);
457
458	/**
459	* Called to read @a cb bytes at @a off into @a pvBuf.
460	*
461	* @returns IPRT status code
462	* @param pvBuf The output buffer.
463	* @param cb The number of bytes to read.
464	* @param off Where to start reading.
465	* @param pvUser The user parameter.
466	*/
467	typedef DECLCALLBACK(int) FNRTLDRRDRMEMREAD(void pvBuf, size_t cb, size_t off, void pvUser);
468	/** Pointer to a RTLdrOpenInMemory reader callback. */
469	typedef FNRTLDRRDRMEMREAD *PFNRTLDRRDRMEMREAD;
470
471	/**
472	* Called to when the module is unloaded (or done loading) to release resources
473	* associated with it (@a pvUser).
474	*
475	* @returns IPRT status code
476	* @param pvUser The user parameter.
477	*/
478	typedef DECLCALLBACK(void) FNRTLDRRDRMEMDTOR(void *pvUser);
479	/** Pointer to a RTLdrOpenInMemory destructor callback. */
480	typedef FNRTLDRRDRMEMDTOR *PFNRTLDRRDRMEMDTOR;
481
482	/**
483	* Open a in-memory image or an image with a custom reader callback.
484	*
485	* @returns IPRT status code.
486	* @param pszName The image name.
487	* @param fFlags Valid RTLDR_O_XXX combination.
488	* @param enmArch CPU architecture specifier for the image to be loaded.
489	* @param cbImage The size of the image (fake file).
490	* @param pfnRead The read function. If NULL is passed in, a default
491	* reader function is provided that assumes @a pvUser
492	* points to the raw image bits, at least @a cbImage of
493	* valid memory.
494	* @param pfnDtor The destructor function. If NULL is passed, a default
495	* destructor will be provided that passes @a pvUser to
496	* RTMemFree.
497	* @param pvUser The user argument or, if any of the callbacks are NULL,
498	* a pointer to a memory block.
499	* @param phLdrMod Where to return the module handle.
500	*
501	* @remarks With the exception of invalid @a pfnDtor and/or @a pvUser
502	* parameters, the pfnDtor methods (or the default one if NULL) will
503	* always be invoked. The destruction of pvUser is entirely in the
504	* hands of this method once it's called.
505	*/
506	RTDECL(int) RTLdrOpenInMemory(const char *pszName, uint32_t fFlags, RTLDRARCH enmArch, size_t cbImage,
507	PFNRTLDRRDRMEMREAD pfnRead, PFNRTLDRRDRMEMDTOR pfnDtor, void *pvUser,
508	PRTLDRMOD phLdrMod);
509
510	/**
511	* Closes a loader module handle.
512	*
513	* The handle can be obtained using any of the RTLdrLoad(), RTLdrOpen()
514	* and RTLdrOpenInMemory() functions.
515	*
516	* @returns iprt status code.
517	* @param hLdrMod The loader module handle.
518	*/
519	RTDECL(int) RTLdrClose(RTLDRMOD hLdrMod);
520
521	/**
522	* Gets the address of a named exported symbol.
523	*
524	* @returns iprt status code.
525	* @retval VERR_LDR_FORWARDER forwarder, use pfnQueryForwarderInfo. Buffer size
526	* hint in @a ppvValue.
527	* @param hLdrMod The loader module handle.
528	* @param pszSymbol Symbol name.
529	* @param ppvValue Where to store the symbol value. Note that this is restricted to the
530	* pointer size used on the host!
531	*/
532	RTDECL(int) RTLdrGetSymbol(RTLDRMOD hLdrMod, const char pszSymbol, void *ppvValue);
533
534	/**
535	* Gets the address of a named exported symbol.
536	*
537	* This function differs from the plain one in that it can deal with
538	* both GC and HC address sizes, and that it can calculate the symbol
539	* value relative to any given base address.
540	*
541	* @returns iprt status code.
542	* @retval VERR_LDR_FORWARDER forwarder, use pfnQueryForwarderInfo. Buffer size
543	* hint in @a pValue.
544	* @param hLdrMod The loader module handle.
545	* @param pvBits Optional pointer to the loaded image.
546	* Set this to NULL if no RTLdrGetBits() processed image bits are available.
547	* Not supported for RTLdrLoad() images.
548	* @param BaseAddress Image load address.
549	* Not supported for RTLdrLoad() images.
550	* @param iOrdinal Symbol ordinal number, pass UINT32_MAX if pszSymbol
551	* should be used instead.
552	* @param pszSymbol Symbol name.
553	* @param pValue Where to store the symbol value.
554	*/
555	RTDECL(int) RTLdrGetSymbolEx(RTLDRMOD hLdrMod, const void *pvBits, RTLDRADDR BaseAddress,
556	uint32_t iOrdinal, const char *pszSymbol, PRTLDRADDR pValue);
557
558	/**
559	* Gets the address of a named exported function.
560	*
561	* Same as RTLdrGetSymbol, but skips the status code and pointer to return
562	* variable stuff.
563	*
564	* @returns Pointer to the function if found, NULL if not.
565	* @param hLdrMod The loader module handle.
566	* @param pszSymbol Function name.
567	*/
568	RTDECL(PFNRT) RTLdrGetFunction(RTLDRMOD hLdrMod, const char *pszSymbol);
569
570	/**
571	* Information about an imported symbol.
572	*/
573	typedef struct RTLDRIMPORTINFO
574	{
575	/** Symbol table entry number, UINT32_MAX if not available. */
576	uint32_t iSelfOrdinal;
577	/** The ordinal of the imported symbol in szModule, UINT32_MAX if not used. */
578	uint32_t iOrdinal;
579	/** The symbol name, NULL if not used. This points to the char immediately
580	* following szModule when returned by RTLdrQueryForwarderInfo. */
581	const char *pszSymbol;
582	/** The name of the module being imported from. */
583	char szModule[1];
584	} RTLDRIMPORTINFO;
585	/** Pointer to information about an imported symbol. */
586	typedef RTLDRIMPORTINFO *PRTLDRIMPORTINFO;
587	/** Pointer to const information about an imported symbol. */
588	typedef RTLDRIMPORTINFO const *PCRTLDRIMPORTINFO;
589
590	/**
591	* Query information about a forwarded symbol.
592	*
593	* @returns IPRT status code.
594	* @param hLdrMod The loader module handle.
595	* @param pvBits Optional pointer to the loaded image.
596	* Set this to NULL if no RTLdrGetBits() processed image bits are available.
597	* Not supported for RTLdrLoad() images.
598	* @param iOrdinal Symbol ordinal number, pass UINT32_MAX if pszSymbol
599	* should be used instead.
600	* @param pszSymbol Symbol name.
601	* @param pInfo Where to return the forwarder info.
602	* @param cbInfo Size of the buffer @a pInfo points to. For a size
603	* hint, see @a pValue when RTLdrGetSymbolEx returns
604	* VERR_LDR_FORWARDER.
605	*/
606	RTDECL(int) RTLdrQueryForwarderInfo(RTLDRMOD hLdrMod, const void pvBits, uint32_t iOrdinal, const char pszSymbol,
607	PRTLDRIMPORTINFO pInfo, size_t cbInfo);
608
609
610	/**
611	* Gets the size of the loaded image.
612	*
613	* This is not necessarily available for images that has been loaded using
614	* RTLdrLoad().
615	*
616	* @returns image size (in bytes).
617	* @returns ~(size_t)0 on if not available.
618	* @param hLdrMod Handle to the loader module.
619	*/
620	RTDECL(size_t) RTLdrSize(RTLDRMOD hLdrMod);
621
622	/**
623	* Resolve an external symbol during RTLdrGetBits().
624	*
625	* @returns iprt status code.
626	* @param hLdrMod The loader module handle.
627	* @param pszModule Module name.
628	* @param pszSymbol Symbol name, NULL if uSymbol should be used.
629	* @param uSymbol Symbol ordinal, ~0 if pszSymbol should be used.
630	* @param pValue Where to store the symbol value (address).
631	* @param pvUser User argument.
632	*/
633	typedef DECLCALLBACK(int) FNRTLDRIMPORT(RTLDRMOD hLdrMod, const char pszModule, const char pszSymbol, unsigned uSymbol,
634	PRTLDRADDR pValue, void *pvUser);
635	/** Pointer to a FNRTLDRIMPORT() callback function. */
636	typedef FNRTLDRIMPORT *PFNRTLDRIMPORT;
637
638	/**
639	* Loads the image into a buffer provided by the user and applies fixups
640	* for the given base address.
641	*
642	* @returns iprt status code.
643	* @param hLdrMod The load module handle.
644	* @param pvBits Where to put the bits.
645	* Must be as large as RTLdrSize() suggests.
646	* @param BaseAddress The base address.
647	* @param pfnGetImport Callback function for resolving imports one by one.
648	* @param pvUser User argument for the callback.
649	* @remark Not supported for RTLdrLoad() images.
650	*/
651	RTDECL(int) RTLdrGetBits(RTLDRMOD hLdrMod, void pvBits, RTLDRADDR BaseAddress, PFNRTLDRIMPORT pfnGetImport, void pvUser);
652
653	/**
654	* Relocates bits after getting them.
655	* Useful for code which moves around a bit.
656	*
657	* @returns iprt status code.
658	* @param hLdrMod The loader module handle.
659	* @param pvBits Where the image bits are.
660	* Must have been passed to RTLdrGetBits().
661	* @param NewBaseAddress The new base address.
662	* @param OldBaseAddress The old base address.
663	* @param pfnGetImport Callback function for resolving imports one by one.
664	* @param pvUser User argument for the callback.
665	* @remark Not supported for RTLdrLoad() images.
666	*/
667	RTDECL(int) RTLdrRelocate(RTLDRMOD hLdrMod, void *pvBits, RTLDRADDR NewBaseAddress, RTLDRADDR OldBaseAddress,
668	PFNRTLDRIMPORT pfnGetImport, void *pvUser);
669
670	/**
671	* Enumeration callback function used by RTLdrEnumSymbols().
672	*
673	* @returns iprt status code. Failure will stop the enumeration.
674	* @param hLdrMod The loader module handle.
675	* @param pszSymbol Symbol name. NULL if ordinal only.
676	* @param uSymbol Symbol ordinal, ~0 if not used.
677	* @param Value Symbol value.
678	* @param pvUser The user argument specified to RTLdrEnumSymbols().
679	*/
680	typedef DECLCALLBACK(int) FNRTLDRENUMSYMS(RTLDRMOD hLdrMod, const char pszSymbol, unsigned uSymbol, RTLDRADDR Value, void pvUser);
681	/** Pointer to a FNRTLDRENUMSYMS() callback function. */
682	typedef FNRTLDRENUMSYMS *PFNRTLDRENUMSYMS;
683
684	/**
685	* Enumerates all symbols in a module.
686	*
687	* @returns iprt status code.
688	* @param hLdrMod The loader module handle.
689	* @param fFlags Flags indicating what to return and such.
690	* @param pvBits Optional pointer to the loaded image. (RTLDR_ENUM_SYMBOL_FLAGS_*)
691	* Set this to NULL if no RTLdrGetBits() processed image bits are available.
692	* @param BaseAddress Image load address.
693	* @param pfnCallback Callback function.
694	* @param pvUser User argument for the callback.
695	* @remark Not supported for RTLdrLoad() images.
696	*/
697	RTDECL(int) RTLdrEnumSymbols(RTLDRMOD hLdrMod, unsigned fFlags, const void pvBits, RTLDRADDR BaseAddress, PFNRTLDRENUMSYMS pfnCallback, void pvUser);
698
699	/** @name RTLdrEnumSymbols flags.
700	* @{ */
701	/** Returns ALL kinds of symbols. The default is to only return public/exported symbols. */
702	#define RTLDR_ENUM_SYMBOL_FLAGS_ALL RT_BIT(1)
703	/** Ignore forwarders rather than reporting them with RTLDR_ENUM_SYMBOL_FWD_ADDRESS as value. */
704	#define RTLDR_ENUM_SYMBOL_FLAGS_NO_FWD RT_BIT(2)
705	/** @} */
706
707	/** Special symbol for forwarder symbols, since they cannot be resolved with
708	* the current API. */
709	#if (HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64)
710	# define RTLDR_ENUM_SYMBOL_FWD_ADDRESS UINT64_C(0xff4242fffd4242fd)
711	#else
712	# define RTLDR_ENUM_SYMBOL_FWD_ADDRESS UINT32_C(0xff4242fd)
713	#endif
714
715
716	/**
717	* Debug info type (as far the loader can tell).
718	*/
719	typedef enum RTLDRDBGINFOTYPE
720	{
721	/** The invalid 0 value. */
722	RTLDRDBGINFOTYPE_INVALID = 0,
723	/** Unknown debug info format. */
724	RTLDRDBGINFOTYPE_UNKNOWN,
725	/** Stabs. */
726	RTLDRDBGINFOTYPE_STABS,
727	/** Debug With Arbitrary Record Format (DWARF). */
728	RTLDRDBGINFOTYPE_DWARF,
729	/** Debug With Arbitrary Record Format (DWARF), in external file (DWO). */
730	RTLDRDBGINFOTYPE_DWARF_DWO,
731	/** Microsoft Codeview debug info. */
732	RTLDRDBGINFOTYPE_CODEVIEW,
733	/** Microsoft Codeview debug info, in external v2.0+ program database (PDB). */
734	RTLDRDBGINFOTYPE_CODEVIEW_PDB20,
735	/** Microsoft Codeview debug info, in external v7.0+ program database (PDB). */
736	RTLDRDBGINFOTYPE_CODEVIEW_PDB70,
737	/** Microsoft Codeview debug info, in external file (DBG). */
738	RTLDRDBGINFOTYPE_CODEVIEW_DBG,
739	/** Microsoft COFF debug info. */
740	RTLDRDBGINFOTYPE_COFF,
741	/** Watcom debug info. */
742	RTLDRDBGINFOTYPE_WATCOM,
743	/** IBM High Level Language debug info. */
744	RTLDRDBGINFOTYPE_HLL,
745	/** The end of the valid debug info values (exclusive). */
746	RTLDRDBGINFOTYPE_END,
747	/** Blow the type up to 32-bits. */
748	RTLDRDBGINFOTYPE_32BIT_HACK = 0x7fffffff
749	} RTLDRDBGINFOTYPE;
750
751
752	/**
753	* Debug info details for the enumeration callback.
754	*/
755	typedef struct RTLDRDBGINFO
756	{
757	/** The kind of debug info. */
758	RTLDRDBGINFOTYPE enmType;
759	/** The debug info ordinal number / id. */
760	uint32_t iDbgInfo;
761	/** The file offset if this type has one specific location in the executable
762	* image file. This is -1 if there isn't any specific file location. */
763	RTFOFF offFile;
764	/** The link address of the debug info if it's loadable. NIL_RTLDRADDR if not
765	* loadable*/
766	RTLDRADDR LinkAddress;
767	/** The size of the debug information. -1 is used if this isn't applicable.*/
768	RTLDRADDR cb;
769	/** This is set if the debug information is found in an external file. NULL
770	* if no external file involved.
771	* @note Putting it outside the union to allow lazy callback implementation. */
772	const char *pszExtFile;
773	/** Type (enmType) specific information. */
774	union
775	{
776	/** RTLDRDBGINFOTYPE_DWARF */
777	struct
778	{
779	/** The section name. */
780	const char *pszSection;
781	} Dwarf;
782
783	/** RTLDRDBGINFOTYPE_DWARF_DWO */
784	struct
785	{
786	/** The CRC32 of the external file. */
787	uint32_t uCrc32;
788	} Dwo;
789
790	/** RTLDRDBGINFOTYPE_CODEVIEW, RTLDRDBGINFOTYPE_COFF */
791	struct
792	{
793	/** The PE image size. */
794	uint32_t cbImage;
795	/** The timestamp. */
796	uint32_t uTimestamp;
797	/** The major version from the entry. */
798	uint32_t uMajorVer;
799	/** The minor version from the entry. */
800	uint32_t uMinorVer;
801	} Cv, Coff;
802
803	/** RTLDRDBGINFOTYPE_CODEVIEW_DBG */
804	struct
805	{
806	/** The PE image size. */
807	uint32_t cbImage;
808	/** The timestamp. */
809	uint32_t uTimestamp;
810	} Dbg;
811
812	/** RTLDRDBGINFOTYPE_CODEVIEW_PDB20*/
813	struct
814	{
815	/** The PE image size. */
816	uint32_t cbImage;
817	/** The timestamp. */
818	uint32_t uTimestamp;
819	/** The PDB age. */
820	uint32_t uAge;
821	} Pdb20;
822
823	/** RTLDRDBGINFOTYPE_CODEVIEW_PDB70 */
824	struct
825	{
826	/** The PE image size. */
827	uint32_t cbImage;
828	/** The PDB age. */
829	uint32_t uAge;
830	/** The UUID. */
831	RTUUID Uuid;
832	} Pdb70;
833	} u;
834	} RTLDRDBGINFO;
835	/** Pointer to debug info details. */
836	typedef RTLDRDBGINFO *PRTLDRDBGINFO;
837	/** Pointer to read only debug info details. */
838	typedef RTLDRDBGINFO const *PCRTLDRDBGINFO;
839
840
841	/**
842	* Debug info enumerator callback.
843	*
844	* @returns VINF_SUCCESS to continue the enumeration. Any other status code
845	* will cause RTLdrEnumDbgInfo to immediately return with that status.
846	*
847	* @param hLdrMod The module handle.
848	* @param pDbgInfo Pointer to a read only structure with the details.
849	* @param pvUser The user parameter specified to RTLdrEnumDbgInfo.
850	*/
851	typedef DECLCALLBACK(int) FNRTLDRENUMDBG(RTLDRMOD hLdrMod, PCRTLDRDBGINFO pDbgInfo, void *pvUser);
852	/** Pointer to a debug info enumerator callback. */
853	typedef FNRTLDRENUMDBG *PFNRTLDRENUMDBG;
854
855	/**
856	* Enumerate the debug info contained in the executable image.
857	*
858	* @returns IPRT status code or whatever pfnCallback returns.
859	*
860	* @param hLdrMod The module handle.
861	* @param pvBits Optional pointer to bits returned by
862	* RTLdrGetBits(). This can be used by some module
863	* interpreters to reduce memory consumption.
864	* @param pfnCallback The callback function.
865	* @param pvUser The user argument.
866	*/
867	RTDECL(int) RTLdrEnumDbgInfo(RTLDRMOD hLdrMod, const void pvBits, PFNRTLDRENUMDBG pfnCallback, void pvUser);
868
869
870	/**
871	* Loader segment.
872	*/
873	typedef struct RTLDRSEG
874	{
875	/** The segment name. Always set to something. */
876	const char *pszName;
877	/** The length of the segment name. */
878	uint32_t cchName;
879	/** The flat selector to use for the segment (i.e. data/code).
880	* Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
881	uint16_t SelFlat;
882	/** The 16-bit selector to use for the segment.
883	* Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
884	uint16_t Sel16bit;
885	/** Segment flags. */
886	uint32_t fFlags;
887	/** The segment protection (RTMEM_PROT_XXX). */
888	uint32_t fProt;
889	/** The size of the segment. */
890	RTLDRADDR cb;
891	/** The required segment alignment.
892	* The to 0 if the segment isn't supposed to be mapped. */
893	RTLDRADDR Alignment;
894	/** The link address.
895	* Set to NIL_RTLDRADDR if the segment isn't supposed to be mapped or if
896	* the image doesn't have link addresses. */
897	RTLDRADDR LinkAddress;
898	/** File offset of the segment.
899	* Set to -1 if no file backing (like BSS). */
900	RTFOFF offFile;
901	/** Size of the file bits of the segment.
902	* Set to -1 if no file backing (like BSS). */
903	RTFOFF cbFile;
904	/** The relative virtual address when mapped.
905	* Set to NIL_RTLDRADDR if the segment isn't supposed to be mapped. */
906	RTLDRADDR RVA;
907	/** The size of the segment including the alignment gap up to the next segment when mapped.
908	* This is set to NIL_RTLDRADDR if not implemented. */
909	RTLDRADDR cbMapped;
910	} RTLDRSEG;
911	/** Pointer to a loader segment. */
912	typedef RTLDRSEG *PRTLDRSEG;
913	/** Pointer to a read only loader segment. */
914	typedef RTLDRSEG const *PCRTLDRSEG;
915
916
917	/** @name Segment flags
918	* @{ */
919	/** The segment is 16-bit. When not set the default of the target architecture is assumed. */
920	#define RTLDRSEG_FLAG_16BIT UINT32_C(1)
921	/** The segment requires a 16-bit selector alias. (OS/2) */
922	#define RTLDRSEG_FLAG_OS2_ALIAS16 UINT32_C(2)
923	/** Conforming segment (x86 weirdness). (OS/2) */
924	#define RTLDRSEG_FLAG_OS2_CONFORM UINT32_C(4)
925	/** IOPL (ring-2) segment. (OS/2) */
926	#define RTLDRSEG_FLAG_OS2_IOPL UINT32_C(8)
927	/** @} */
928
929	/**
930	* Segment enumerator callback.
931	*
932	* @returns VINF_SUCCESS to continue the enumeration. Any other status code
933	* will cause RTLdrEnumSegments to immediately return with that
934	* status.
935	*
936	* @param hLdrMod The module handle.
937	* @param pSeg The segment information.
938	* @param pvUser The user parameter specified to RTLdrEnumSegments.
939	*/
940	typedef DECLCALLBACK(int) FNRTLDRENUMSEGS(RTLDRMOD hLdrMod, PCRTLDRSEG pSeg, void *pvUser);
941	/** Pointer to a segment enumerator callback. */
942	typedef FNRTLDRENUMSEGS *PFNRTLDRENUMSEGS;
943
944	/**
945	* Enumerate the debug info contained in the executable image.
946	*
947	* @returns IPRT status code or whatever pfnCallback returns.
948	*
949	* @param hLdrMod The module handle.
950	* @param pfnCallback The callback function.
951	* @param pvUser The user argument.
952	*/
953	RTDECL(int) RTLdrEnumSegments(RTLDRMOD hLdrMod, PFNRTLDRENUMSEGS pfnCallback, void *pvUser);
954
955	/**
956	* Converts a link address to a segment:offset address.
957	*
958	* @returns IPRT status code.
959	*
960	* @param hLdrMod The module handle.
961	* @param LinkAddress The link address to convert.
962	* @param piSeg Where to return the segment index.
963	* @param poffSeg Where to return the segment offset.
964	*/
965	RTDECL(int) RTLdrLinkAddressToSegOffset(RTLDRMOD hLdrMod, RTLDRADDR LinkAddress, uint32_t *piSeg, PRTLDRADDR poffSeg);
966
967	/**
968	* Converts a link address to an image relative virtual address (RVA).
969	*
970	* @returns IPRT status code.
971	*
972	* @param hLdrMod The module handle.
973	* @param LinkAddress The link address to convert.
974	* @param pRva Where to return the RVA.
975	*/
976	RTDECL(int) RTLdrLinkAddressToRva(RTLDRMOD hLdrMod, RTLDRADDR LinkAddress, PRTLDRADDR pRva);
977
978	/**
979	* Converts an image relative virtual address (RVA) to a segment:offset.
980	*
981	* @returns IPRT status code.
982	*
983	* @param hLdrMod The module handle.
984	* @param iSeg The segment index.
985	* @param offSeg The segment offset.
986	* @param pRva Where to return the RVA.
987	*/
988	RTDECL(int) RTLdrSegOffsetToRva(RTLDRMOD hLdrMod, uint32_t iSeg, RTLDRADDR offSeg, PRTLDRADDR pRva);
989
990	/**
991	* Converts a segment:offset into an image relative virtual address (RVA).
992	*
993	* @returns IPRT status code.
994	*
995	* @param hLdrMod The module handle.
996	* @param Rva The link address to convert.
997	* @param piSeg Where to return the segment index.
998	* @param poffSeg Where to return the segment offset.
999	*/
1000	RTDECL(int) RTLdrRvaToSegOffset(RTLDRMOD hLdrMod, RTLDRADDR Rva, uint32_t *piSeg, PRTLDRADDR poffSeg);
1001
1002	/**
1003	* Gets the image format.
1004	*
1005	* @returns Valid image format on success. RTLDRFMT_INVALID on invalid handle or
1006	* other errors.
1007	* @param hLdrMod The module handle.
1008	*/
1009	RTDECL(RTLDRFMT) RTLdrGetFormat(RTLDRMOD hLdrMod);
1010
1011	/**
1012	* Gets the image type.
1013	*
1014	* @returns Valid image type value on success. RTLDRTYPE_INVALID on
1015	* invalid handle or other errors.
1016	* @param hLdrMod The module handle.
1017	*/
1018	RTDECL(RTLDRTYPE) RTLdrGetType(RTLDRMOD hLdrMod);
1019
1020	/**
1021	* Gets the image endian-ness.
1022	*
1023	* @returns Valid image endian value on success. RTLDRENDIAN_INVALID on invalid
1024	* handle or other errors.
1025	* @param hLdrMod The module handle.
1026	*/
1027	RTDECL(RTLDRENDIAN) RTLdrGetEndian(RTLDRMOD hLdrMod);
1028
1029	/**
1030	* Gets the image endian-ness.
1031	*
1032	* @returns Valid image architecture value on success.
1033	* RTLDRARCH_INVALID on invalid handle or other errors.
1034	* @param hLdrMod The module handle.
1035	*/
1036	RTDECL(RTLDRARCH) RTLdrGetArch(RTLDRMOD hLdrMod);
1037
1038	/**
1039	* Loader properties that can be queried thru RTLdrQueryProp.
1040	*/
1041	typedef enum RTLDRPROP
1042	{
1043	RTLDRPROP_INVALID = 0,
1044	/** The image UUID (Mach-O).
1045	* Returns a RTUUID in the buffer. */
1046	RTLDRPROP_UUID,
1047	/** The image timestamp in seconds, genrally since unix epoc.
1048	* Returns a 32-bit or 64-bit signed integer value in the buffer. */
1049	RTLDRPROP_TIMESTAMP_SECONDS,
1050	/** Checks if the image is signed.
1051	* Returns a bool. */
1052	RTLDRPROP_IS_SIGNED,
1053	/** Retrives the PKCS \#7 SignedData blob that signs the image.
1054	* Returns variable sized buffer containing the ASN.1 BER encoding.
1055	*
1056	* @remarks This generally starts with a PKCS \#7 Content structure, the
1057	* SignedData bit is found a few levels down into this as per RFC. */
1058	RTLDRPROP_PKCS7_SIGNED_DATA,
1059
1060	/** Query whether code signature checks are enabled. */
1061	RTLDRPROP_SIGNATURE_CHECKS_ENFORCED,
1062
1063	/** Number of import or needed modules. */
1064	RTLDRPROP_IMPORT_COUNT,
1065	/** Import module by index (32-bit) stored in the buffer. */
1066	RTLDRPROP_IMPORT_MODULE,
1067	/** The file offset of the main executable header.
1068	* This is mainly for PE, NE and LX headers, but also Mach-O FAT. */
1069	RTLDRPROP_FILE_OFF_HEADER,
1070	/** The internal module name.
1071	* This is the SONAME for ELF, export table name for PE, and zero'th resident
1072	* name table entry for LX.
1073	* Returns zero terminated string. */
1074	RTLDRPROP_INTERNAL_NAME,
1075
1076	/** End of valid properties. */
1077	RTLDRPROP_END,
1078	/** Blow the type up to 32 bits. */
1079	RTLDRPROP_32BIT_HACK = 0x7fffffff
1080	} RTLDRPROP;
1081
1082	/**
1083	* Generic method for querying image properties.
1084	*
1085	* @returns IPRT status code.
1086	* @retval VERR_NOT_SUPPORTED if the property query isn't supported (either all
1087	* or that specific property). The caller must handle this result.
1088	* @retval VERR_NOT_FOUND the property was not found in the module. The caller
1089	* must also normally deal with this.
1090	* @retval VERR_INVALID_FUNCTION if the function value is wrong.
1091	* @retval VERR_INVALID_PARAMETER if the buffer size is wrong.
1092	* @retval VERR_BUFFER_OVERFLOW if the function doesn't have a fixed size
1093	* buffer and the buffer isn't big enough. Use RTLdrQueryPropEx.
1094	* @retval VERR_INVALID_HANDLE if the handle is invalid.
1095	*
1096	* @param hLdrMod The module handle.
1097	* @param enmProp The property to query.
1098	* @param pvBuf Pointer to the input / output buffer. In most cases
1099	* it's only used for returning data.
1100	* @param cbBuf The size of the buffer.
1101	*/
1102	RTDECL(int) RTLdrQueryProp(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void *pvBuf, size_t cbBuf);
1103
1104	/**
1105	* Generic method for querying image properties, extended version.
1106	*
1107	* @returns IPRT status code.
1108	* @retval VERR_NOT_SUPPORTED if the property query isn't supported (either all
1109	* or that specific property). The caller must handle this result.
1110	* @retval VERR_NOT_FOUND the property was not found in the module. The caller
1111	* must also normally deal with this.
1112	* @retval VERR_INVALID_FUNCTION if the function value is wrong.
1113	* @retval VERR_INVALID_PARAMETER if the fixed buffer size is wrong. Correct
1114	* size in @a *pcbRet.
1115	* @retval VERR_BUFFER_OVERFLOW if the function doesn't have a fixed size
1116	* buffer and the buffer isn't big enough. Correct size in @a *pcbRet.
1117	* @retval VERR_INVALID_HANDLE if the handle is invalid.
1118	*
1119	* @param hLdrMod The module handle.
1120	* @param enmProp The property to query.
1121	* @param pvBits Optional pointer to bits returned by
1122	* RTLdrGetBits(). This can be utilized by some module
1123	* interpreters to reduce memory consumption and file
1124	* access.
1125	* @param pvBuf Pointer to the input / output buffer. In most cases
1126	* it's only used for returning data.
1127	* @param cbBuf The size of the buffer.
1128	* @param pcbRet Where to return the amount of data returned. On
1129	* buffer size errors, this is set to the correct size.
1130	* Optional.
1131	*/
1132	RTDECL(int) RTLdrQueryPropEx(RTLDRMOD hLdrMod, RTLDRPROP enmProp, void pvBits, void pvBuf, size_t cbBuf, size_t *pcbRet);
1133
1134
1135	/**
1136	* Signature type, see FNRTLDRVALIDATESIGNEDDATA.
1137	*/
1138	typedef enum RTLDRSIGNATURETYPE
1139	{
1140	/** Invalid value. */
1141	RTLDRSIGNATURETYPE_INVALID = 0,
1142	/** A RTPKCS7CONTENTINFO structure w/ RTPKCS7SIGNEDDATA inside.
1143	* It's parsed, so the whole binary ASN.1 representation can be found by
1144	* using RTASN1CORE_GET_RAW_ASN1_PTR() and RTASN1CORE_GET_RAW_ASN1_SIZE(). */
1145	RTLDRSIGNATURETYPE_PKCS7_SIGNED_DATA,
1146	/** End of valid values. */
1147	RTLDRSIGNATURETYPE_END,
1148	/** Make sure the size is 32-bit. */
1149	RTLDRSIGNATURETYPE_32BIT_HACK = 0x7fffffff
1150	} RTLDRSIGNATURETYPE;
1151
1152	/**
1153	* Callback used by RTLdrVerifySignature to verify the signature and associated
1154	* certificates.
1155	*
1156	* @returns IPRT status code.
1157	* @param hLdrMod The module handle.
1158	* @param enmSignature The signature format.
1159	* @param pvSignature The signature data. Format given by @a enmSignature.
1160	* @param cbSignature The size of the buffer @a pvSignature points to.
1161	* @param pErrInfo Pointer to an error info buffer, optional.
1162	* @param pvUser User argument.
1163	*
1164	*/
1165	typedef DECLCALLBACK(int) FNRTLDRVALIDATESIGNEDDATA(RTLDRMOD hLdrMod, RTLDRSIGNATURETYPE enmSignature, void const *pvSignature, size_t cbSignature,
1166	PRTERRINFO pErrInfo, void *pvUser);
1167	/** Pointer to a signature verification callback. */
1168	typedef FNRTLDRVALIDATESIGNEDDATA *PFNRTLDRVALIDATESIGNEDDATA;
1169
1170	/**
1171	* Verify the image signature.
1172	*
1173	* This may permform additional integrity checks on the image structures that
1174	* was not done when opening the image.
1175	*
1176	* @returns IPRT status code.
1177	* @retval VERR_LDRVI_NOT_SIGNED if not signed.
1178	*
1179	* @param hLdrMod The module handle.
1180	* @param pfnCallback Callback that does the signature and certificate
1181	* verficiation.
1182	* @param pvUser User argument for the callback.
1183	* @param pErrInfo Pointer to an error info buffer. Optional.
1184	*/
1185	RTDECL(int) RTLdrVerifySignature(RTLDRMOD hLdrMod, PFNRTLDRVALIDATESIGNEDDATA pfnCallback, void *pvUser, PRTERRINFO pErrInfo);
1186
1187	/**
1188	* Calculate the image hash according the image signing rules.
1189	*
1190	* @returns IPRT status code.
1191	* @param hLdrMod The module handle.
1192	* @param enmDigest Which kind of digest.
1193	* @param pszDigest Where to store the image digest.
1194	* @param cbDigest Size of the buffer @a pszDigest points at.
1195	*/
1196	RTDECL(int) RTLdrHashImage(RTLDRMOD hLdrMod, RTDIGESTTYPE enmDigest, char *pszDigest, size_t cbDigest);
1197
1198	RT_C_DECLS_END
1199
1200	/** @} */
1201
1202	#endif
1203

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

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

Download in other formats: