ldr.h@ 76059

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

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

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

Download in other formats: