ldr.h@ 74690

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

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

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

Download in other formats: