source: trunk/kLdr/kLdr.h@ 2965

Last change on this file since 2965 was 2965, checked in by bird, 19 years ago

messing about...
  • Property svn:keywords set to Id
File size: 59.1 KB
Line 
1/* $Id: kLdr.h 2965 2007-02-13 21:04:40Z bird $ */
2/** @file
3 *
4 * kLdr - The Dynamic Loader.
5 *
6 * Copyright (c) 2006 knut st. osmundsen <bird@anduin.net>
7 *
8 *
9 * This file is part of kLdr.
10 *
11 * kLdr is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * kLdr is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with kLdr; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 *
25 */
26
27#ifndef __kLdr_h__
28#define __kLdr_h__
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
34/*
35 * kLdr depend on size_t, [u]intNN_t, [u]intptr_t and some related constants.
36 * If KLDR_NO_KLDR_H_INCLUDES is defined, these has already been defined.
37 */
38#ifndef KLDR_NO_KLDR_H_INCLUDES
39# include <sys/types.h>
40# include <stddef.h>
41# ifdef _MSC_VER
42 typedef signed char int8_t;
43 typedef unsigned char uint8_t;
44 typedef signed short int16_t;
45 typedef unsigned short uint16_t;
46 typedef signed int int32_t;
47 typedef unsigned int uint32_t;
48 typedef signed __int64 int64_t;
49 typedef unsigned __int64 uint64_t;
50 typedef int64_t intmax_t;
51 typedef uint64_t uintmax_t;
52# define UINT8_C(c) (c)
53# define UINT16_C(c) (c)
54# define UINT32_C(c) (c ## U)
55# define UINT64_C(c) (c ## ULL)
56# define INT8_C(c) (c)
57# define INT16_C(c) (c)
58# define INT32_C(c) (c)
59# define INT64_C(c) (c ## LL)
60# define INT8_MIN (INT8_C(-0x7f) - 1)
61# define INT16_MIN (INT16_C(-0x7fff) - 1)
62# define INT32_MIN (INT32_C(-0x7fffffff) - 1)
63# define INT64_MIN (INT64_C(-0x7fffffffffffffff) - 1)
64# define INT8_MAX INT8_C(0x7f)
65# define INT16_MAX INT16_C(0x7fff)
66# define INT32_MAX INT32_C(0x7fffffff)
67# define INT64_MAX INT64_C(0x7fffffffffffffff)
68# define UINT8_MAX UINT8_C(0xff)
69# define UINT16_MAX UINT16_C(0xffff)
70# define UINT32_MAX UINT32_C(0xffffffff)
71# define UINT64_MAX UINT64_C(0xffffffffffffffff)
72# else
73# include <stdint.h>
74# endif
75#endif /* !KLDR_NO_KLDR_H_INCLUDES */
76
77
78/** @defgroup grp_kLdrBasic kLdr Basic Types
79 * @{ */
80
81/** The kLdr address type. */
82typedef uint64_t KLDRADDR;
83/** Pointer to a kLdr address. */
84typedef KLDRADDR *PKLDRADDR;
85/** Pointer to a const kLdr address. */
86typedef const KLDRADDR *PCKLDRADDR;
87
88/** NIL address. */
89#define NIL_KLDRADDR (~(uint64_t)0)
90
91/** @def PRI_KLDRADDR
92 * printf format type. */
93#ifdef _MSC_VER
94# define PRI_KLDRADDR "I64x"
95#else
96# define PRI_KLDRADDR "llx"
97#endif
98
99
100/** The kLdr size type. */
101typedef uint64_t KLDRSIZE;
102/** Pointer to a kLdr size. */
103typedef KLDRSIZE *PKLDRSIZE;
104/** Pointer to a const kLdr size. */
105typedef const KLDRSIZE *PCKLDRSIZE;
106
107/** @def PRI_KLDRSIZE
108 * printf format type. */
109#ifdef _MSC_VER
110# define PRI_KLDRSIZE "I64x"
111#else
112# define PRI_KLDRSIZE "llx"
113#endif
114
115
116/**
117 * Union of all the integer types.
118 */
119typedef union KLDRU
120{
121 int8_t i8; /**< int8_t view. */
122 uint8_t u8; /**< uint8_t view. */
123 int16_t i16; /**< int16_t view. */
124 uint16_t u16; /**< uint16_t view. */
125 int32_t i32; /**< int32_t view. */
126 uint32_t u32; /**< uint32_t view. */
127 int64_t i64; /**< int64_t view. */
128 uint64_t u64; /**< uint64_t view. */
129
130 int8_t ai8[8]; /**< int8_t array view . */
131 uint8_t au8[8]; /**< uint8_t array view. */
132 int16_t ai16[4];/**< int16_t array view . */
133 uint16_t au16[4];/**< uint16_t array view. */
134 int32_t ai32[2];/**< int32_t array view . */
135 uint32_t au32[2];/**< uint32_t array view. */
136
137 signed char ch; /**< signed char view. */
138 unsigned char uch; /**< unsigned char view. */
139 signed short s; /**< signed short view. */
140 unsigned short us; /**< unsigned short view. */
141 signed int i; /**< signed int view. */
142 unsigned int u; /**< unsigned int view. */
143 signed long l; /**< signed long view. */
144 unsigned long ul; /**< unsigned long view. */
145 void *pv; /**< void pointer view. */
146
147 KLDRADDR Addr; /**< kLdr address view. */
148 KLDRSIZE Size; /**< kLdr size view. */
149} KLDRU;
150/** Pointer to an integer union. */
151typedef KLDRU *PKLDRU;
152/** Pointer to a const integer union. */
153typedef const KLDRU *PCKLDRU;
154
155
156/**
157 * Union of pointers to all the integer types.
158 */
159typedef union KLDRPU
160{
161 int8_t *pi8; /**< int8_t view. */
162 uint8_t *pu8; /**< uint8_t view. */
163 int16_t *pi16; /**< int16_t view. */
164 uint16_t *pu16; /**< uint16_t view. */
165 int32_t *pi32; /**< int32_t view. */
166 uint32_t *pu32; /**< uint32_t view. */
167 int64_t *pi64; /**< int64_t view. */
168 uint64_t *pu64; /**< uint64_t view. */
169
170 signed char *pch; /**< signed char view. */
171 unsigned char *puch; /**< unsigned char view. */
172 signed short *ps; /**< signed short view. */
173 unsigned short *pus; /**< unsigned short view. */
174 signed int *pi; /**< signed int view. */
175 unsigned int *pu; /**< unsigned int view. */
176 signed long *pl; /**< signed long view. */
177 unsigned long *pul; /**< unsigned long view. */
178 void *pv; /**< void pointer view. */
179} KLDRPU;
180/** Pointer to an integer pointer union. */
181typedef KLDRPU *PKLDRPU;
182/** Pointer to a const integer pointer union. */
183typedef const KLDRPU *PCKLDRPU;
184
185
186/**
187 * Memory Mapping Protections.
188 *
189 * @remark Shared segments can be mapped using the non copy-on-write variant.
190 * (Normally the copy-on-write variant is used because changes must
191 * be private and not shared with other processes mapping the file.)
192 */
193typedef enum KLDRPROT
194{
195 /** The usual invalid 0. */
196 KLDRPROT_INVALID = 0,
197 /** No access (page not present). */
198 KLDRPROT_NOACCESS,
199 /** Read only. */
200 KLDRPROT_READONLY,
201 /** Read & write. */
202 KLDRPROT_READWRITE,
203 /** Read & copy on write. */
204 KLDRPROT_WRITECOPY,
205 /** Execute only. */
206 KLDRPROT_EXECUTE,
207 /** Execute & read. */
208 KLDRPROT_EXECUTE_READ,
209 /** Execute, read & write. */
210 KLDRPROT_EXECUTE_READWRITE,
211 /** Execute, read & copy on write. */
212 KLDRPROT_EXECUTE_WRITECOPY,
213 /** The usual end value. (exclusive) */
214 KLDRPROT_END,
215 /** Blow the type up to 32-bits. */
216 KLDRPROT_32BIT_HACK = 0x7fffffff
217} KLDRPROT;
218
219/** Pointer to a loader segment. */
220typedef struct KLDRSEG *PKLDRSEG;
221/** Pointer to a loader segment. */
222typedef const struct KLDRSEG *PCKLDRSEG;
223
224/** @} */
225
226
227/** @defgroup grp_kLdrRdr kLdrRdr - The file provider
228 * @{ */
229
230/** Pointer to a file provider instance core. */
231typedef struct KLDRRDR *PKLDRRDR;
232/** Pointer to a file provider instance core pointer. */
233typedef struct KLDRRDR **PPKLDRRDR;
234
235/**
236 * File provider instance operations.
237 */
238typedef struct KLDRRDROPS
239{
240 /** The name of this file provider. */
241 const char *pszName;
242 /** Pointer to the next file provider. */
243 const struct KLDRRDROPS *pNext;
244
245 /** Try create a new file provider instance.
246 *
247 * @returns 0 on success, OS specific error code on failure.
248 * @param ppRdr Where to store the file provider instance.
249 * @param pszFilename The filename to open.
250 */
251 int (* pfnCreate)( PPKLDRRDR ppRdr, const char *pszFilename);
252 /** Destroy the file provider instance.
253 *
254 * @returns 0 on success, OS specific error code on failure.
255 * On failure, the file provider instance will be in an indeterminate state - don't touch it!
256 * @param pRdr The file provider instance.
257 */
258 int (* pfnDestroy)( PKLDRRDR pRdr);
259 /** @copydoc kLdrRdrRead */
260 int (* pfnRead)( PKLDRRDR pRdr, void *pvBuf, size_t cb, off_t off);
261 /** @copydoc kLdrRdrAllMap */
262 int (* pfnAllMap)( PKLDRRDR pRdr, const void **ppvBits);
263 /** @copydoc kLdrRdrAllUnmap */
264 int (* pfnAllUnmap)(PKLDRRDR pRdr, const void *pvBits);
265 /** @copydoc kLdrRdrSize */
266 off_t (* pfnSize)( PKLDRRDR pRdr);
267 /** @copydoc kLdrRdrTell */
268 off_t (* pfnTell)( PKLDRRDR pRdr);
269 /** @copydoc kLdrRdrName */
270 const char * (* pfnName)(PKLDRRDR pRdr);
271 /** @copydoc kLdrRdrPageSize */
272 size_t (* pfnPageSize)(PKLDRRDR pRdr);
273 /** @copydoc kLdrRdrMap */
274 int (* pfnMap)( PKLDRRDR pRdr, void **ppvBase, uint32_t cSegments, PCKLDRSEG paSegments, unsigned fFixed);
275 /** @copydoc kLdrRdrRefresh */
276 int (* pfnRefresh)( PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments);
277 /** @copydoc kLdrRdrProtect */
278 int (* pfnProtect)( PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments, unsigned fUnprotectOrProtect);
279 /** @copydoc kLdrRdrUnmap */
280 int (* pfnUnmap)( PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments);
281 /** @copydoc kLdrRdrDone */
282 void (* pfnDone)( PKLDRRDR pRdr);
283 /** The usual non-zero dummy that makes sure we've initialized all members. */
284 uint32_t u32Dummy;
285} KLDRRDROPS;
286/** Pointer to file provider operations. */
287typedef KLDRRDROPS *PKLDRRDROPS;
288/** Pointer to const file provider operations. */
289typedef const KLDRRDROPS *PCKLDRRDROPS;
290
291
292/**
293 * File provider instance core.
294 */
295typedef struct KLDRRDR
296{
297 /** Magic number (KLDRRDR_MAGIC). */
298 uint32_t u32Magic;
299 /** Pointer to the file provider operations. */
300 PCKLDRRDROPS pOps;
301} KLDRRDR;
302
303/** The magic for KLDRRDR::u32Magic. (Katsu Aki (Katsuaki Nakamura)) */
304#define KLDRRDR_MAGIC 0x19610919
305
306void kLdrRdrAddProvider(PKLDRRDROPS pAdd);
307
308int kLdrRdrOpen( PPKLDRRDR ppRdr, const char *pszFilename);
309int kLdrRdrClose( PKLDRRDR pRdr);
310int kLdrRdrRead( PKLDRRDR pRdr, void *pvBuf, size_t cb, off_t off);
311int kLdrRdrAllMap( PKLDRRDR pRdr, const void **ppvBits);
312int kLdrRdrAllUnmap(PKLDRRDR pRdr, const void *pvBits);
313off_t kLdrRdrSize( PKLDRRDR pRdr);
314off_t kLdrRdrTell( PKLDRRDR pRdr);
315const char *kLdrRdrName(PKLDRRDR pRdr);
316size_t kLdrRdrPageSize(PKLDRRDR pRdr);
317int kLdrRdrMap( PKLDRRDR pRdr, void **ppvBase, uint32_t cSegments, PCKLDRSEG paSegments, unsigned fFixed);
318int kLdrRdrRefresh( PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments);
319int kLdrRdrProtect( PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments, unsigned fUnprotectOrProtect);
320int kLdrRdrUnmap( PKLDRRDR pRdr, void *pvBase, uint32_t cSegments, PCKLDRSEG paSegments);
321void kLdrRdrDone( PKLDRRDR pRdr);
322
323/** @} */
324
325
326
327/** @defgroup grp_kLdrMod kLdrMod - The executable image intepreter
328 * @{ */
329
330/**
331 * CPU Architecture.
332 * @todo Double check the non intel architectures.
333 */
334typedef enum KLDRARCH
335{
336 /** The usual invalid one. */
337 KLDRARCH_INVALID = 0,
338 /** Clone or Intel 16-bit x86. */
339 KLDRARCH_X86_16,
340 /** Clone or Intel 32-bit x86. */
341 KLDRARCH_X86_32,
342 /** AMD64 (including clones). */
343 KLDRARCH_AMD64,
344 /** Itanic (64-bit). */
345 KLDRARCH_IA64,
346 /** ALPHA (64-bit). */
347 KLDRARCH_ALPHA,
348 /** ALPHA limited to 32-bit. */
349 KLDRARCH_ALPHA_32,
350 /** 32-bit ARM. */
351 KLDRARCH_ARM_32,
352 /** 64-bit ARM. */
353 KLDRARCH_ARM_64,
354 /** 32-bit MIPS. */
355 KLDRARCH_MIPS_32,
356 /** 64-bit MIPS. */
357 KLDRARCH_MIPS_64,
358 /** 32-bit PowerPC. */
359 KLDRARCH_POWERPC_32,
360 /** 64-bit PowerPC. */
361 KLDRARCH_POWERPC_64,
362 /** 32-bit SPARC. */
363 KLDRARCH_SPARC_32,
364 /** 64-bit SPARC. */
365 KLDRARCH_SPARC_64,
366 /** The end of the valid architecture values (exclusive). */
367 KLDRARCH_END,
368 /** Hack to blow the type up to 32-bit. */
369 KLDRARCH_32BIT_HACK = 0x7fffffff
370} KLDRARCH;
371/** Pointer to a CPU architecture type. */
372typedef KLDRARCH *PKLDRARCH;
373
374/**
375 * CPU models.
376 */
377typedef enum KLDRCPU
378{
379 /** The usual invalid cpu. */
380 KLDRCPU_INVALID = 0,
381 /** @name KLDRARCH_X86_16
382 * @{ */
383 KLDRCPU_I8086,
384 KLDRCPU_I8088,
385 KLDRCPU_I80186,
386 KLDRCPU_I80286,
387 KLDRCPU_I386_16,
388 KLDRCPU_I486_16,
389 KLDRCPU_I486SX_16,
390 KLDRCPU_I586_16,
391 KLDRCPU_I686_16,
392 KLDRCPU_P4_16,
393 KLDRCPU_CORE2_16,
394 KLDRCPU_K6_16,
395 KLDRCPU_K7_16,
396 KLDRCPU_K8_16,
397 KLDRCPU_FIRST_X86_16 = KLDRCPU_I8086,
398 KLDRCPU_LAST_X86_16 = KLDRCPU_K8_16,
399 /** @} */
400
401 /** @name KLDRARCH_X86_32
402 * @{ */
403 KLDRCPU_X86_32_BLEND,
404 KLDRCPU_I386,
405 KLDRCPU_I486,
406 KLDRCPU_I486SX,
407 KLDRCPU_I586,
408 KLDRCPU_I686,
409 KLDRCPU_P4,
410 KLDRCPU_CORE2_32,
411 KLDRCPU_K6,
412 KLDRCPU_K7,
413 KLDRCPU_K8_32,
414 KLDRCPU_FIRST_X86_32 = KLDRCPU_I386,
415 KLDRCPU_LAST_X86_32 = KLDRCPU_K8_32,
416 /** @} */
417
418 /** @name KLDRARCH_AMD64
419 * @{ */
420 KLDRCPU_AMD64_BLEND,
421 KLDRCPU_K8,
422 KLDRCPU_P4_64,
423 KLDRCPU_CORE2,
424 KLDRCPU_FIRST_AMD64 = KLDRCPU_K8,
425 KLDRCPU_LAST_AMD64 = KLDRCPU_CORE2,
426 /** @} */
427
428 /** The end of the valid cpu values (exclusive). */
429 KLDRCPU_END,
430 /** Hack to blow the type up to 32-bit. */
431 KLDRCPU_32BIT_HACK = 0x7fffffff
432} KLDRCPU;
433/** Pointer to a CPU type. */
434typedef KLDRCPU *PKLDRCPU;
435
436void kLdrGetArchCpu(PKLDRARCH penmArch, PKLDRCPU penmCpu);
437int kLdrCompareCpus(KLDRARCH enmCodeArch, KLDRCPU enmCodeCpu, KLDRARCH enmArch, KLDRCPU enmCpu);
438
439
440/**
441 * Debug info type (from the loader point of view).
442 */
443typedef enum KLDRDBGINFOTYPE
444{
445 /** The usual invalid enum value. */
446 KLDRDBGINFOTYPE_INVALID = 0,
447 /** Unknown debug info format. */
448 KLDRDBGINFOTYPE_UNKNOWN,
449 /** Stabs. */
450 KLDRDBGINFOTYPE_STABS,
451 /** Debug With Arbitrary Record Format (DWARF). */
452 KLDRDBGINFOTYPE_DWARF,
453 /** Microsoft Codeview debug info. */
454 KLDRDBGINFOTYPE_CODEVIEW,
455 /** Watcom debug info. */
456 KLDRDBGINFOTYPE_WATCOM,
457 /** IBM High Level Language debug info.. */
458 KLDRDBGINFOTYPE_HLL,
459 /** The end of the valid debug info values (exclusive). */
460 KLDRDBGINFOTYPE_END,
461 /** Blow the type up to 32-bit. */
462 KLDRDBGINFOTYPE_32BIT_HACK = 0x7fffffff
463} KLDRDBGINFOTYPE;
464/** Pointer to a kLdr debug info type. */
465typedef KLDRDBGINFOTYPE *PKLDRDBGINFOTYPE;
466
467
468/**
469 * Stack information.
470 */
471typedef struct KLDRSTACKINFO
472{
473 /** The base address of the stack (sub) segment.
474 * Set this to NIL_KLDRADDR if the module doesn't include any stack segment. */
475 KLDRADDR Address;
476 /** The base address of the stack (sub) segment, link address.
477 * Set this to NIL_KLDRADDR if the module doesn't include any stack (sub)segment. */
478 KLDRADDR LinkAddress;
479 /** The stack size of the main thread.
480 * If no stack (sub)segment in the module, this is the stack size of the main thread.
481 * If the module doesn't contain this kind of information this field will be set to 0. */
482 KLDRSIZE cbStack;
483 /** The stack size of non-main threads.
484 * If the module doesn't contain this kind of information this field will be set to 0. */
485 KLDRSIZE cbStackThread;
486} KLDRSTACKINFO;
487/** Pointer to stack information. */
488typedef KLDRSTACKINFO *PKLDRSTACKINFO;
489/** Pointer to const stack information. */
490typedef const KLDRSTACKINFO *PCKLDRSTACKINFO;
491
492
493/**
494 * Loader segment.
495 */
496typedef struct KLDRSEG
497{
498 /** Variable free to use for the kLdr user. */
499 void *pvUser;
500 /** The segment name. (Might not be zero terminated!) */
501 const char *pchName;
502 /** The length of the segment name. */
503 uint32_t cchName;
504 /** The flat selector to use for the segment (i.e. data/code).
505 * Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
506 uint16_t SelFlat;
507 /** The 16-bit selector to use for the segment.
508 * Primarily a way for the user to specify selectors for the LX/LE and NE interpreters. */
509 uint16_t Sel16bit;
510 /** Segment flags. */
511 uint32_t fFlags;
512 /** The segment protection. */
513 KLDRPROT enmProt;
514 /** The size of the segment. */
515 KLDRSIZE cb;
516 /** The required segment alignment.
517 * The to 0 if the segment isn't supposed to be mapped. */
518 KLDRADDR Alignment;
519 /** The link address.
520 * Set to NIL_KLDRADDR if the segment isn't supposed to be
521 * mapped or if the image doesn't have link addresses. */
522 KLDRADDR LinkAddress;
523 /** File offset of the segment.
524 * Set to -1 if no file backing (like BSS). */
525 off_t offFile;
526 /** Size of the file bits of the segment.
527 * Set to -1 if no file backing (like BSS). */
528 off_t cbFile;
529 /** The relative virtual address when mapped.
530 * Set to NIL_KLDRADDR if the segment isn't supposed to be mapped. */
531 KLDRADDR RVA;
532 /** The size of the segment including the alignment gap up to the next segment when mapped. */
533 size_t cbMapped;
534 /** The address the segment was mapped at by kLdrModMap().
535 * Set to 0 if not mapped. */
536 uintptr_t MapAddress;
537} KLDRSEG;
538
539
540/** @name Segment flags
541 * @{ */
542/** The segment is 16-bit. When not set the default of the target architecture is assumed. */
543#define KLDRSEG_FLAG_16BIT 1
544/** The segment requires a 16-bit selector alias. (OS/2) */
545#define KLDRSEG_FLAG_OS2_ALIAS16 2
546/** Conforming segment (x86 weirdness). (OS/2) */
547#define KLDRSEG_FLAG_OS2_CONFORM 4
548/** IOPL (ring-2) segment. (OS/2) */
549#define KLDRSEG_FLAG_OS2_IOPL 8
550/** @} */
551
552
553/**
554 * Loader module format.
555 */
556typedef enum KLDRFMT
557{
558 /** The usual invalid 0 format. */
559 KLDRFMT_INVALID = 0,
560 /** The native OS loader. */
561 KLDRFMT_NATIVE,
562 /** The AOUT loader. */
563 KLDRFMT_AOUT,
564 /** The ELF loader. */
565 KLDRFMT_ELF,
566 /** The LX loader. */
567 KLDRFMT_LX,
568 /** The Mach-O loader. */
569 KLDRFMT_MACHO,
570 /** The PE loader. */
571 KLDRFMT_PE,
572 /** The end of the valid format values (exclusive). */
573 KLDRFMT_END,
574 /** Hack to blow the type up to 32-bit. */
575 KLDRFMT_32BIT_HACK = 0x7fffffff
576} KLDRFMT;
577
578
579/**
580 * Loader module type.
581 */
582typedef enum KLDRTYPE
583{
584 /** The usual invalid 0 type. */
585 KLDRTYPE_INVALID = 0,
586 /** Object file. */
587 KLDRTYPE_OBJECT,
588 /** Executable module, fixed load address. */
589 KLDRTYPE_EXECUTABLE_FIXED,
590 /** Executable module, relocatable, non-fixed load address. */
591 KLDRTYPE_EXECUTABLE_RELOCATABLE,
592 /** Executable module, position independent code, non-fixed load address. */
593 KLDRTYPE_EXECUTABLE_PIC,
594 /** Shared library, fixed load address.
595 * Typically a system library. */
596 KLDRTYPE_SHARED_LIBRARY_FIXED,
597 /** Shared library, relocatable, non-fixed load address. */
598 KLDRTYPE_SHARED_LIBRARY_RELOCATABLE,
599 /** Shared library, position independent code, non-fixed load address. */
600 KLDRTYPE_SHARED_LIBRARY_PIC,
601 /** DLL that contains no code or data only imports and exports. (Chiefly OS/2.) */
602 KLDRTYPE_FORWARDER_DLL,
603 /** Core or dump. */
604 KLDRTYPE_CORE,
605 /** The end of the valid types values (exclusive). */
606 KLDRTYPE_END,
607 /** Hack to blow the type up to 32-bit. */
608 KLDRTYPE_32BIT_HACK = 0x7fffffff
609} KLDRTYPE;
610
611
612/**
613 * Loader endian indicator.
614 */
615typedef enum KLDRENDIAN
616{
617 /** The usual invalid endian. */
618 KLDRENDIAN_INVALID,
619 /** Little endian. */
620 KLDRENDIAN_LITTLE,
621 /** Bit endian. */
622 KLDRENDIAN_BIG,
623 /** Endianness doesn't have a meaning in the context. */
624 KLDRENDIAN_NA,
625 /** The end of the valid endian values (exclusive). */
626 KLDRENDIAN_END,
627 /** Hack to blow the type up to 32-bit. */
628 KLDRENDIAN_32BIT_HACK = 0x7fffffff
629} KLDRENDIAN;
630
631
632/** @def KLDR_LITTLE_ENDIAN
633 * The kLdr build is for a little endian target. */
634/** @def KLDR_BIG_ENDIAN
635 * The kLdr build is for a big endian target. */
636#if !defined(KLDR_LITTLE_ENDIAN) && !defined(KLDR_BIG_ENDIAN)
637# define KLDR_LITTLE_ENDIAN
638#endif
639#ifdef __DOXYGEN__
640# define KLDR_BIG_ENDIAN
641#endif
642
643
644/** Pointer to a module interpreter method table. */
645typedef struct KLDRMODOPS *PKLDRMODOPS;
646/** Pointer to const module interpreter methods table. */
647typedef const struct KLDRMODOPS *PCKLDRMODOPS;
648
649/**
650 * Module interpreter instance.
651 * All members are read only unless you're kLdrMod or the module interpreter.
652 */
653typedef struct KLDRMOD
654{
655 /** Magic number (KLDRMOD_MAGIC). */
656 uint32_t u32Magic;
657 /** The format of this module. */
658 KLDRFMT enmFmt;
659 /** The type of module. */
660 KLDRTYPE enmType;
661 /** The architecture this module was built for. */
662 KLDRARCH enmArch;
663 /** The minium cpu this module was built for.
664 * This might not be accurate, so use kLdrModCanExecuteOn() to check. */
665 KLDRARCH enmCpu;
666 /** The endian used by the module. */
667 KLDRENDIAN enmEndian;
668 /** The filename length (bytes). */
669 uint32_t cchFilename;
670 /** The filename. */
671 const char *pszFilename;
672 /** The module name. */
673 const char *pszName;
674 /** The module name length (bytes). */
675 uint32_t cchName;
676 /** The number of segments in the module. */
677 uint32_t cSegments;
678 /** Pointer to the loader methods.
679 * Not meant for calling directly thru! */
680 PCKLDRMODOPS pOps;
681 /** Pointer to the read instance. (Can be NULL after kLdrModDone().)*/
682 PKLDRRDR pRdr;
683 /** The module data. */
684 void *pvData;
685 /** Segments. (variable size, can be zero) */
686 KLDRSEG aSegments[1];
687} KLDRMOD, *PKLDRMOD, **PPKLDRMOD;
688
689/** The magic for KLDRMOD::u32Magic. (Kosuke Fujishima) */
690#define KLDRMOD_MAGIC 0x19640707
691
692
693/** Special base address value alias for the link address. */
694#define KLDRMOD_BASEADDRESS_LINK (~(KLDRADDR)1)
695/** Special base address value alias for the actual load address (must be mapped). */
696#define KLDRMOD_BASEADDRESS_MAP (~(KLDRADDR)2)
697
698/** Special import module ordinal value used to indicate that there is no
699 * specific module associated with the requested symbol. */
700#define NIL_KLDRMOD_IMPORT (~(uint32_t)0)
701
702/** Special symbol ordinal value used to indicate that the symbol
703 * only has a string name. */
704#define NIL_KLDRMOD_SYM_ORDINAL (~(uint32_t)0)
705
706
707/** @name Load symbol kind flags.
708 * @{ */
709/** The bitness doesn't matter. */
710#define KLDRSYMKIND_NO_BIT 0x00000000
711/** 16-bit symbol. */
712#define KLDRSYMKIND_16BIT 0x00000001
713/** 32-bit symbol. */
714#define KLDRSYMKIND_32BIT 0x00000002
715/** 64-bit symbol. */
716#define KLDRSYMKIND_64BIT 0x00000003
717/** Mask out the bit.*/
718#define KLDRSYMKIND_BIT_MASK 0x00000003
719/** We don't know the type of symbol. */
720#define KLDRSYMKIND_NO_TYPE 0x00000000
721/** The symbol is a code object (method/function/procedure/whateveryouwannacallit). */
722#define KLDRSYMKIND_CODE 0x00000010
723/** The symbol is a data object. */
724#define KLDRSYMKIND_DATA 0x00000020
725/** Mask out the symbol type. */
726#define KLDRSYMKIND_TYPE_MASK 0x00000030
727/** Valid symbol kind mask. */
728#define KLDRSYMKIND_MASK 0x00000033
729/** Weak symbol. */
730#define KLDRSYMKIND_WEAK 0x00000100
731/** Forwarder symbol. */
732#define KLDRSYMKIND_FORWARDER 0x00000200
733/** Request a flat symbol address. */
734#define KLDRSYMKIND_REQ_FLAT 0x00000000
735/** Request a segmented symbol address. */
736#define KLDRSYMKIND_REQ_SEGMENTED 0x40000000
737/** Request type mask. */
738#define KLDRSYMKIND_REQ_TYPE_MASK 0x40000000
739/** @} */
740
741/** @name kLdrModEnumSymbols flags.
742 * @{ */
743/** Returns ALL kinds of symbols. The default is to only return public/exported symbols. */
744#define KLDRMOD_ENUM_SYMS_FLAGS_ALL 0x00000001
745/** @} */
746
747
748/**
749 * Callback for resolving imported symbols when applying fixups.
750 *
751 * @returns 0 on success and *pValue and *pfKind filled.
752 * @returns Non-zero OS specific or kLdr status code on failure.
753 *
754 * @param pMod The module which fixups are begin applied.
755 * @param iImport The import module ordinal number or NIL_KLDRMOD_IMPORT.
756 * @param iSymbol The symbol ordinal number or NIL_KLDRMOD_SYM_ORDINAL.
757 * @param pchSymbol The symbol name. Can be NULL if iSymbol isn't nil. Doesn't have to be null-terminated.
758 * @param cchSymbol The length of the symbol.
759 * @param pszVersion The symbol version. NULL if not versioned.
760 * @param puValue Where to store the symbol value.
761 * @param pfKind Where to store the symbol kind flags.
762 * @param pvUser The user parameter specified to the relocation function.
763 */
764typedef int FNKLDRMODGETIMPORT(PKLDRMOD pMod, uint32_t iImport, uint32_t iSymbol, const char *pchSymbol, size_t cchSymbol,
765 const char *pszVersion, PKLDRADDR puValue, uint32_t *pfKind, void *pvUser);
766/** Pointer to a import callback. */
767typedef FNKLDRMODGETIMPORT *PFNKLDRMODGETIMPORT;
768
769/**
770 * Symbol enumerator callback.
771 *
772 * @returns 0 if enumeration should continue.
773 * @returns non-zero if the enumeration should stop. This status code will then be returned by kLdrModEnumSymbols().
774 *
775 * @param pMod The module which symbols are being enumerated.s
776 * @param iSymbol The symbol ordinal number or NIL_KLDRMOD_SYM_ORDINAL.
777 * @param pchSymbol The symbol name. This can be NULL if there is a symbol ordinal.
778 * This can also be an empty string if the symbol doesn't have a name
779 * or it's name has been stripped.
780 * Important, this doesn't have to be a null-terminated string.
781 * @param cchSymbol The length of the symbol.
782 * @param pszVersion The symbol version. NULL if not versioned.
783 * @param uValue The symbol value.
784 * @param fKind The symbol kind flags.
785 * @param pvUser The user parameter specified to kLdrModEnumSymbols().
786 */
787typedef int FNKLDRMODENUMSYMS(PKLDRMOD pMod, uint32_t iSymbol, const char *pchSymbol, size_t cchSymbol, const char *pszVersion,
788 KLDRADDR uValue, uint32_t fKind, void *pvUser);
789/** Pointer to a symbol enumerator callback. */
790typedef FNKLDRMODENUMSYMS *PFNKLDRMODENUMSYMS;
791
792/**
793 * Debug info enumerator callback.
794 *
795 * @returns 0 to continue the enumeration.
796 * @returns non-zero if the enumeration should stop. This status code will then be returned by kLdrModEnumDbgInfo().
797 *
798 * @param pMod The module.
799 * @param iDbgInfo The debug info ordinal number / id.
800 * @param enmType The debug info type.
801 * @param iMajorVer The major version number of the debug info format. -1 if unknow - implies invalid iMinorVer.
802 * @param iMinorVer The minor version number of the debug info format. -1 when iMajorVer is -1.
803 * @param offFile The file offset *if* this type has one specific location in the executable image file.
804 * This is -1 if there isn't any specific file location.
805 * @param LinkAddress The link address of the debug info if it's loadable. NIL_KLDRADDR if not loadable.
806 * @param cb The size of the debug information. -1 is used if this isn't applicable.
807 * @param pszExtFile This points to the name of an external file containing the debug info.
808 * This is NULL if there isn't any external file.
809 * @param pvUser The user parameter specified to kLdrModEnumDbgInfo.
810 */
811typedef int FNKLDRENUMDBG(PKLDRMOD pMod, uint32_t iDbgInfo, KLDRDBGINFOTYPE enmType, int16_t iMajorVer, int16_t iMinorVer,
812 off_t offFile, KLDRADDR LinkAddress, KLDRSIZE cb, const char *pszExtFile, void *pvUser);
813/** Pointer to a debug info enumerator callback. */
814typedef FNKLDRENUMDBG *PFNKLDRENUMDBG;
815
816/**
817 * Resource enumerator callback.
818 *
819 * @returns 0 to continue the enumeration.
820 * @returns non-zero if the enumeration should stop. This status code will then be returned by kLdrModEnumResources().
821 *
822 * @param pMod The module.
823 * @param idType The resource type id. NIL_KLDRMOD_RSRC_TYPE_ID if no type id.
824 * @param pszType The resource type name. NULL if no type name.
825 * @param idName The resource id. NIL_KLDRMOD_RSRC_NAME_ID if no id.
826 * @param pszName The resource name. NULL if no name.
827 * @param idLang The language id.
828 * @param AddrRsrc The address value for the resource.
829 * @param cbRsrc The size of the resource.
830 * @param pvUser The user parameter specified to kLdrModEnumDbgInfo.
831 */
832typedef int FNKLDRENUMRSRC(PKLDRMOD pMod, uint32_t idType, const char *pszType, uint32_t idName, const char *pszName,
833 uint32_t idLang, KLDRADDR AddrRsrc, KLDRSIZE cbRsrc, void *pvUser);
834/** Pointer to a resource enumerator callback. */
835typedef FNKLDRENUMRSRC *PFNKLDRENUMRSRC;
836
837/** NIL resource name ID. */
838#define NIL_KLDRMOD_RSRC_NAME_ID ( ~(uint32_t)0 )
839/** NIL resource type ID. */
840#define NIL_KLDRMOD_RSRC_TYPE_ID ( ~(uint32_t)0 )
841/** @name Language ID
842 *
843 * Except for the special IDs #defined here, the values are considered
844 * format specific for now since it's only used by the PE resources.
845 *
846 * @{ */
847/** NIL language ID. */
848#define NIL_KLDR_LANG_ID ( ~(uint32_t)0 )
849/** Special language id value for matching any language. */
850#define KLDR_LANG_ID_ANY ( ~(uint32_t)1 )
851/** Special language id value indicating language neutral. */
852#define KLDR_LANG_ID_NEUTRAL ( ~(uint32_t)2 )
853/** Special language id value indicating user default language. */
854#define KLDR_LANG_ID_USER_DEFAULT ( ~(uint32_t)3 )
855/** Special language id value indicating system default language. */
856#define KLDR_LANG_ID_SYS_DEFAULT ( ~(uint32_t)4 )
857/** Special language id value indicating default custom locale. */
858#define KLDR_LANG_ID_CUSTOM_DEFAULT ( ~(uint32_t)5 )
859/** Special language id value indicating unspecified custom locale. */
860#define KLDR_LANG_ID_CUSTOM_UNSPECIFIED ( ~(uint32_t)6 )
861/** Special language id value indicating default custom MUI locale. */
862#define KLDR_LANG_ID_UI_CUSTOM_DEFAULT ( ~(uint32_t)7 )
863/** @} */
864
865
866int kLdrModOpen(const char *pszFilename, PPKLDRMOD ppMod);
867int kLdrModOpenFromRdr(PKLDRRDR pRdr, PPKLDRMOD ppMod);
868int kLdrModOpenNative(const char *pszFilename, PPKLDRMOD ppMod);
869int kLdrModOpenNativeByHandle(uintptr_t uHandle, PPKLDRMOD ppMod);
870int kLdrModClose(PKLDRMOD pMod);
871
872int kLdrModQuerySymbol(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t iSymbol,
873 const char *pchSymbol, size_t cchSymbol, const char *pszVersion,
874 PFNKLDRMODGETIMPORT pfnGetForwarder, void *pvUser, PKLDRADDR puValue, uint32_t *pfKind);
875int kLdrModEnumSymbols(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress,
876 uint32_t fFlags, PFNKLDRMODENUMSYMS pfnCallback, void *pvUser);
877int kLdrModGetImport(PKLDRMOD pMod, const void *pvBits, uint32_t iImport, char *pszName, size_t cchName);
878int32_t kLdrModNumberOfImports(PKLDRMOD pMod, const void *pvBits);
879int kLdrModCanExecuteOn(PKLDRMOD pMod, const void *pvBits, KLDRARCH enmArch, KLDRCPU enmCpu);
880int kLdrModGetStackInfo(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, PKLDRSTACKINFO pStackInfo);
881int kLdrModQueryMainEntrypoint(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, PKLDRADDR pMainEPAddress);
882int kLdrModQueryResource(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t idType, const char *pszType,
883 uint32_t idName, const char *pszName, uint32_t idLang, PKLDRADDR pAddrRsrc, size_t *pcbRsrc);
884int kLdrModEnumResources(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t idType, const char *pszType,
885 uint32_t idName, const char *pszName, uint32_t idLang, PFNKLDRENUMRSRC pfnCallback, void *pvUser);
886int kLdrModEnumDbgInfo(PKLDRMOD pMod, const void *pvBits, PFNKLDRENUMDBG pfnCallback, void *pvUser);
887int kLdrModHasDbgInfo(PKLDRMOD pMod, const void *pvBits);
888int kLdrModMostlyDone(PKLDRMOD pMod);
889
890
891/** @name Operations On The Internally Managed Mapping
892 * @{ */
893int kLdrModMap(PKLDRMOD pMod);
894int kLdrModUnmap(PKLDRMOD pMod);
895int kLdrModAllocTLS(PKLDRMOD pMod);
896void kLdrModFreeTLS(PKLDRMOD pMod);
897int kLdrModReload(PKLDRMOD pMod);
898int kLdrModFixupMapping(PKLDRMOD pMod, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
899int kLdrModCallInit(PKLDRMOD pMod, uintptr_t uHandle);
900int kLdrModCallTerm(PKLDRMOD pMod, uintptr_t uHandle);
901int kLdrModCallThread(PKLDRMOD pMod, uintptr_t uHandle, unsigned fAttachingOrDetaching);
902/** @} */
903
904/** @name Operations On The Externally Managed Mappings
905 * @{ */
906KLDRADDR kLdrModSize(PKLDRMOD pMod);
907int kLdrModGetBits(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
908int kLdrModRelocateBits(PKLDRMOD pMod, void *pvBits, KLDRADDR NewBaseAddress, KLDRADDR OldBaseAddress,
909 PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
910/** @} */
911
912
913/**
914 * The loader module operation.
915 */
916typedef struct KLDRMODOPS
917{
918 /** The name of this module interpreter. */
919 const char *pszName;
920 /** Pointer to the next module interpreter. */
921 PCKLDRMODOPS pNext;
922
923 /**
924 * Create a loader module instance interpreting the executable image found
925 * in the specified file provider instance.
926 *
927 * @returns 0 on success and *ppMod pointing to a module instance.
928 * On failure, a non-zero OS specific error code is returned.
929 * @param pOps Pointer to the registered method table.
930 * @param pRdr The file provider instance to use.
931 * @param offNewHdr The offset of the new header in MZ files. -1 if not found.
932 * @param ppMod Where to store the module instance pointer.
933 */
934 int (* pfnCreate)(PCKLDRMODOPS pOps, PKLDRRDR pRdr, off_t offNewHdr, PPKLDRMOD ppMod);
935 /**
936 * Destroys an loader module instance.
937 *
938 * The caller is responsible for calling kLdrModUnmap() and kLdrFreeTLS() first.
939 *
940 * @returns 0 on success, non-zero on failure. The module instance state
941 * is unknown on failure, it's best not to touch it.
942 * @param pMod The module.
943 */
944 int (* pfnDestroy)(PKLDRMOD pMod);
945
946 /** @copydoc kLdrModQuerySymbol */
947 int (* pfnQuerySymbol)(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t iSymbol,
948 const char *pchSymbol, size_t cchSymbol, const char *pszVersion,
949 PFNKLDRMODGETIMPORT pfnGetForwarder, void *pvUser, PKLDRADDR puValue, uint32_t *pfKind);
950 /** @copydoc kLdrModEnumSymbols */
951 int (* pfnEnumSymbols)(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t fFlags,
952 PFNKLDRMODENUMSYMS pfnCallback, void *pvUser);
953 /** @copydoc kLdrModGetImport */
954 int (* pfnGetImport)(PKLDRMOD pMod, const void *pvBits, uint32_t iImport, char *pszName, size_t cchName);
955 /** @copydoc kLdrModNumberOfImports */
956 int32_t (* pfnNumberOfImports)(PKLDRMOD pMod, const void *pvBits);
957 /** @copydoc kLdrModCanExecuteOn */
958 int (* pfnCanExecuteOn)(PKLDRMOD pMod, const void *pvBits, KLDRARCH enmArch, KLDRCPU enmCpu);
959 /** @copydoc kLdrModGetStackInfo */
960 int (* pfnGetStackInfo)(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, PKLDRSTACKINFO pStackInfo);
961 /** @copydoc kLdrModQueryMainEntrypoint */
962 int (* pfnQueryMainEntrypoint)(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, PKLDRADDR pMainEPAddress);
963 /** @copydoc kLdrModQueryResource */
964 int (* pfnQueryResource)(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t idType, const char *pszType,
965 uint32_t idName, const char *pszName, uint32_t idLang, PKLDRADDR pAddrRsrc, size_t *pcbRsrc);
966 /** @copydoc kLdrModEnumResources */
967 int (* pfnEnumResources)(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t idType, const char *pszType,
968 uint32_t idName, const char *pszName, uint32_t idLang, PFNKLDRENUMRSRC pfnCallback, void *pvUser);
969 /** @copydoc kLdrModEnumDbgInfo */
970 int (* pfnEnumDbgInfo)(PKLDRMOD pMod, const void *pvBits, PFNKLDRENUMDBG pfnCallback, void *pvUser);
971 /** @copydoc kLdrModHasDbgInfo */
972 int (* pfnHasDbgInfo)(PKLDRMOD pMod, const void *pvBits);
973 /** @copydoc kLdrModMap */
974 int (* pfnMap)(PKLDRMOD pMod);
975 /** @copydoc kLdrModUnmap */
976 int (* pfnUnmap)(PKLDRMOD pMod);
977 /** @copydoc kLdrModAllocTLS */
978 int (* pfnAllocTLS)(PKLDRMOD pMod);
979 /** @copydoc kLdrModFreeTLS */
980 void (* pfnFreeTLS)(PKLDRMOD pMod);
981 /** @copydoc kLdrModReload */
982 int (* pfnReload)(PKLDRMOD pMod);
983 /** @copydoc kLdrModFixupMapping */
984 int (* pfnFixupMapping)(PKLDRMOD pMod, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
985 /** @copydoc kLdrModCallInit */
986 int (* pfnCallInit)(PKLDRMOD pMod, uintptr_t uHandle);
987 /** @copydoc kLdrModCallTerm */
988 int (* pfnCallTerm)(PKLDRMOD pMod, uintptr_t uHandle);
989 /** @copydoc kLdrModCallThread */
990 int (* pfnCallThread)(PKLDRMOD pMod, uintptr_t uHandle, unsigned fAttachingOrDetaching);
991 /** @copydoc kLdrModSize */
992 KLDRADDR (* pfnSize)(PKLDRMOD pMod);
993 /** @copydoc kLdrModGetBits */
994 int (* pfnGetBits)(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
995 /** @copydoc kLdrModRelocateBits */
996 int (* pfnRelocateBits)(PKLDRMOD pMod, void *pvBits, KLDRADDR NewBaseAddress, KLDRADDR OldBaseAddress,
997 PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
998 /** @copydoc kLdrModMostlyDone */
999 int (* pfnMostlyDone)(PKLDRMOD pMod);
1000 /** Dummy which should be assigned a non-zero value. */
1001 uint32_t uEndOfStructure;
1002} KLDRMODOPS;
1003
1004
1005/** @} */
1006
1007
1008
1009
1010/** @defgroup grp_kLdrDyld kLdrDyld - The dynamic loader
1011 * @{ */
1012
1013/** The handle to a dynamic loader module. */
1014typedef struct KLDRDYLDMOD *HKLDRMOD;
1015/** Pointer to the handle to a dynamic loader module. */
1016typedef HKLDRMOD *PHKLDRMOD;
1017/** NIL handle value. */
1018#define NIL_HKLDRMOD ((HKLDRMOD)0)
1019
1020
1021/**
1022 * File search method.
1023 *
1024 * In addition to it's own way of finding files, kLdr emulates
1025 * the methods employed by the most popular systems.
1026 */
1027typedef enum KLDRDYLDSEARCH
1028{
1029 /** The usual invalid file search method. */
1030 KLDRDYLD_SEARCH_INVALID = 0,
1031 /** Uses the kLdr file search method.
1032 * @todo invent me. */
1033 KLDRDYLD_SEARCH_KLDR,
1034 /** Use the emulation closest to the host system. */
1035 KLDRDYLD_SEARCH_HOST,
1036 /** Emulate the OS/2 file search method.
1037 * On non-OS/2 systems, BEGINLIBPATH, LIBPATH, ENDLIBPATH and LIBPATHSTRICT are
1038 * taken form the environment. */
1039 KLDRDYLD_SEARCH_OS2,
1040 /** Emulate the standard window file search method. */
1041 KLDRDYLD_SEARCH_WINDOWS,
1042 /** Emulate the alternative window file search method. */
1043 KLDRDYLD_SEARCH_WINDOWS_ALTERED,
1044 /** Emulate the most common UNIX file search method. */
1045 KLDRDYLD_SEARCH_UNIX_COMMON,
1046 /** End of the valid file search method values. */
1047 KLDRDYLD_SEARCH_END,
1048 /** Hack to blow the type up to 32-bit. */
1049 KLDRDYLD_SEARCH_32BIT_HACK = 0x7fffffff
1050} KLDRDYLDSEARCH;
1051
1052/** @name kLdrDyldLoad and kLdrDyldFindByName flags.
1053 * @{ */
1054/** The symbols in the module should be loaded into the global unix namespace.
1055 * If not specified, the symbols are local and can only be referenced directly. */
1056#define KLDRYDLD_LOAD_FLAGS_GLOBAL_SYMBOLS 0x00000001
1057/** The symbols in the module should be loaded into the global unix namespace and
1058 * it's symbols should take precedence over all currently loaded modules.
1059 * This implies KLDRYDLD_LOAD_FLAGS_GLOBAL_SYMBOLS. */
1060#define KLDRYDLD_LOAD_FLAGS_DEEP_SYMBOLS 0x00000002
1061/** The module shouldn't be found by a global module search.
1062 * If not specified, the module can be found by unspecified module searches,
1063 * typical used when loading import/dep modules. */
1064#define KLDRYDLD_LOAD_FLAGS_SPECIFIC_MODULE 0x00000004
1065/** Do a recursive initialization calls instead of defering them to the outermost call. */
1066#define KLDRDYLD_LOAD_FLAGS_RECURSIVE_INIT 0x00000008
1067/** We're loading the executable module.
1068 * @internal */
1069#define KLDRDYLD_LOAD_FLAGS_EXECUTABLE 0x40000000
1070/** @} */
1071
1072
1073int kLdrDyldLoad(const char *pszDll, const char *pszPrefix, const char *pszSuffix, KLDRDYLDSEARCH enmSearch,
1074 unsigned fFlags, PHKLDRMOD phMod, char *pszErr, size_t cchErr);
1075int kLdrDyldUnload(HKLDRMOD hMod);
1076int kLdrDyldFindByName(const char *pszDll, const char *pszPrefix, const char *pszSuffix, KLDRDYLDSEARCH enmSearch,
1077 unsigned fFlags, PHKLDRMOD phMod);
1078int kLdrDyldFindByAddress(uintptr_t Address, PHKLDRMOD phMod, uint32_t *piSegment, uintptr_t *poffSegment);
1079int kLdrDyldGetName(HKLDRMOD hMod, char *pszName, size_t cchName);
1080int kLdrDyldGetFilename(HKLDRMOD hMod, char *pszFilename, size_t cchFilename);
1081int kLdrDyldQuerySymbol(HKLDRMOD hMod, uint32_t uSymbolOrdinal, const char *pszSymbolName,
1082 const char *pszSymbolVersion, uintptr_t *pValue, uint32_t *pfKind);
1083int kLdrDyldQueryResource(HKLDRMOD hMod, uint32_t idType, const char *pszType, uint32_t idName,
1084 const char *pszName, uint32_t idLang, void **pvRsrc, size_t *pcbRsrc);
1085int kLdrDyldEnumResources(HKLDRMOD hMod, uint32_t idType, const char *pszType, uint32_t idName,
1086 const char *pszName, uint32_t idLang, PFNKLDRENUMRSRC pfnCallback, void *pvUser);
1087
1088/** @name OS/2 like API
1089 * @{ */
1090#if defined(__OS2__)
1091# define KLDROS2API _System
1092#else
1093# define KLDROS2API
1094#endif
1095int kLdrDosLoadModule(char *pszObject, size_t cbObject, const char *pszModule, PHKLDRMOD phMod);
1096int kLdrDosFreeModule(HKLDRMOD hMod);
1097int kLdrDosQueryModuleHandle(const char *pszModname, PHKLDRMOD phMod);
1098int kLdrDosQueryModuleName(HKLDRMOD hMod, size_t cchName, char *pszName);
1099int kLdrDosQueryProcAddr(HKLDRMOD hMod, uint32_t iOrdinal, const char *pszProcName, void **ppvProcAddr);
1100int kLdrDosQueryProcType(HKLDRMOD hMod, uint32_t iOrdinal, const char *pszProcName, uint32_t *pfProcType);
1101int kLdrDosQueryModFromEIP(PHKLDRMOD phMod, uint32_t *piObject, size_t cbName, char *pszName, uintptr_t *poffObject, uintptr_t ulEIP);
1102int kLdrDosReplaceModule(const char *pszOldModule, const char *pszNewModule, const char *pszBackupModule);
1103int kLdrDosGetResource(HKLDRMOD hMod, uint32_t idType, uint32_t idName, void **pvResAddr);
1104int kLdrDosQueryResourceSize(HKLDRMOD hMod, uint32_t idType, uint32_t idName, uint32_t *pcb);
1105int kLdrDosFreeResource(void *pvResAddr);
1106/** @} */
1107
1108/** @name POSIX like API
1109 * @{ */
1110HKLDRMOD kLdrDlOpen(const char *pszLibrary, int fFlags);
1111const char *kLdrDlError(void);
1112void * kLdrDlSym(HKLDRMOD hMod, const char *pszSymbol);
1113int kLdrDlClose(HKLDRMOD hMod);
1114/** @todo GNU extensions */
1115/** @} */
1116
1117/** @name Win32 like API
1118 * @{ */
1119#if defined(_MSC_VER)
1120# define KLDRWINAPI __stdcall
1121#else
1122# define KLDRWINAPI
1123#endif
1124HKLDRMOD KLDRWINAPI kLdrWLoadLibrary(const char *pszFilename);
1125HKLDRMOD KLDRWINAPI kLdrWLoadLibraryEx(const char *pszFilename, void *hFileReserved, uint32_t fFlags);
1126uint32_t KLDRWINAPI kLdrWGetModuleFileName(HKLDRMOD hMod, char *pszModName, size_t cchModName);
1127HKLDRMOD KLDRWINAPI kLdrWGetModuleHandle(const char *pszFilename);
1128int KLDRWINAPI kLdrWGetModuleHandleEx(uint32_t fFlags, const char *pszFilename, HKLDRMOD hMod);
1129void * KLDRWINAPI kLdrWGetProcAddress(HKLDRMOD hMod, const char *pszProcName);
1130uint32_t KLDRWINAPI kLdrWGetDllDirectory(size_t cchDir, char *pszDir);
1131int KLDRWINAPI kLdrWSetDllDirectory(const char *pszDir);
1132int KLDRWINAPI kLdrWFreeLibrary(HKLDRMOD hMod);
1133int KLDRWINAPI kLdrWDisableThreadLibraryCalls(HKLDRMOD hMod);
1134
1135/** The handle to a resource that's been found. */
1136typedef struct KLDRWRSRCFOUND *HKLDRWRSRCFOUND;
1137/** The handle to a loaded resource. */
1138typedef struct KLDRWRSRCLOADED *HKLDRWRSRCLOADED;
1139HKLDRWRSRCFOUND KLDRWINAPI kLdrWFindResource(HKLDRMOD hMod, const char *pszType, const char *pszName);
1140HKLDRWRSRCFOUND KLDRWINAPI kLdrWFindResourceEx(HKLDRMOD hMod, const char *pszType, const char *pszName, uint16_t idLang);
1141uint32_t KLDRWINAPI kLdrWSizeofResource(HKLDRMOD hMod, HKLDRWRSRCFOUND hFoundRsrc);
1142HKLDRWRSRCLOADED KLDRWINAPI kLdrWLoadResource(HKLDRMOD hMod, HKLDRWRSRCFOUND hFoundRsrc);
1143void *KLDRWINAPI kLdrWLockResource(HKLDRMOD hMod, HKLDRWRSRCLOADED hLoadedRsrc);
1144int KLDRWINAPI kLdrWFreeResource(HKLDRMOD hMod, HKLDRWRSRCLOADED hLoadedRsrc);
1145
1146typedef int (KLDRWINAPI *PFNKLDRWENUMRESTYPE)(HKLDRMOD hMod, const char *pszType, uintptr_t uUser);
1147int KLDRWINAPI kLdrWEnumResourceTypes(HKLDRMOD hMod, PFNKLDRWENUMRESTYPE pfnEnum, uintptr_t uUser);
1148int KLDRWINAPI kLdrWEnumResourceTypesEx(HKLDRMOD hMod, PFNKLDRWENUMRESTYPE pfnEnum, uintptr_t uUser, uint32_t fFlags, uint16_t idLang);
1149
1150typedef int (KLDRWINAPI *PFNKLDRWENUMRESNAME)(HKLDRMOD hMod, const char *pszType, char *pszName, uintptr_t uUser);
1151int KLDRWINAPI kLdrWEnumResourceNames(HKLDRMOD hMod, const char *pszType, PFNKLDRWENUMRESNAME pfnEnum, uintptr_t uUser);
1152int KLDRWINAPI kLdrWEnumResourceNamesEx(HKLDRMOD hMod, const char *pszType, PFNKLDRWENUMRESNAME pfnEnum, uintptr_t uUser, uint32_t fFlags, uint16_t idLang);
1153
1154typedef int (KLDRWINAPI *PFNKLDRWENUMRESLANG)(HKLDRMOD hMod, const char *pszType, const char *pszName, uint16_t idLang, uintptr_t uUser);
1155int KLDRWINAPI kLdrWEnumResourceLanguages(HKLDRMOD hMod, const char *pszType, const char *pszName, PFNKLDRWENUMRESLANG pfnEnum, uintptr_t uUser);
1156int KLDRWINAPI kLdrWEnumResourceLanguagesEx(HKLDRMOD hMod, const char *pszType, const char *pszName,
1157 PFNKLDRWENUMRESLANG pfnEnum, uintptr_t uUser, uint32_t fFlags, uint16_t idLang);
1158/** @} */
1159
1160
1161/** @name Process Bootstrapping
1162 * @{ */
1163
1164/**
1165 * Argument package from the stub.
1166 */
1167typedef struct KLDREXEARGS
1168{
1169 /** Load & search flags, some which will become defaults. */
1170 uint32_t fFlags;
1171 /** The default search method. */
1172 KLDRDYLDSEARCH enmSearch;
1173 /** The executable file that the stub is supposed to load. */
1174 char szExecutable[260];
1175 /** The default prefix used when searching for DLLs. */
1176 char szDefPrefix[16];
1177 /** The default suffix used when searching for DLLs. */
1178 char szDefSuffix[16];
1179 /** The LD_LIBRARY_PATH prefix for the process.. */
1180 char szLibPath[4096 - sizeof(uint32_t) - sizeof(KLDRDYLDSEARCH) - 16 - 16 - 260];
1181} KLDREXEARGS, *PKLDREXEARGS;
1182/** Pointer to a const argument package from the stub. */
1183typedef const KLDREXEARGS *PCKLDREXEARGS;
1184
1185void kLdrLoadExe(PCKLDREXEARGS pArgs, void *pvOS);
1186
1187/** @} */
1188
1189/** @} */
1190
1191
1192/** @defgroup grp_kLdrErr kLdr Status Codes
1193 * kLdr uses a mix of native status codes and it's own status codes.
1194 * A status code of 0 means success, all other status codes means failure.
1195 * @{
1196 */
1197
1198#define KLDR_ERR_BASE 420000
1199
1200/** The image format is unknown. */
1201#define KLDR_ERR_UNKNOWN_FORMAT (KLDR_ERR_BASE + 0)
1202/** The MZ image format isn't supported by this kLdr build. */
1203#define KLDR_ERR_MZ_NOT_SUPPORTED (KLDR_ERR_BASE + 1)
1204/** The NE image format isn't supported by this kLdr build. */
1205#define KLDR_ERR_NE_NOT_SUPPORTED (KLDR_ERR_BASE + 2)
1206/** The LX image format isn't supported by this kLdr build. */
1207#define KLDR_ERR_LX_NOT_SUPPORTED (KLDR_ERR_BASE + 3)
1208/** The LE image format isn't supported by this kLdr build. */
1209#define KLDR_ERR_LE_NOT_SUPPORTED (KLDR_ERR_BASE + 4)
1210/** The PE image format isn't supported by this kLdr build. */
1211#define KLDR_ERR_PE_NOT_SUPPORTED (KLDR_ERR_BASE + 5)
1212/** The ELF image format isn't supported by this kLdr build. */
1213#define KLDR_ERR_ELF_NOT_SUPPORTED (KLDR_ERR_BASE + 6)
1214/** The mach-o image format isn't supported by this kLdr build. */
1215#define KLDR_ERR_MACHO_NOT_SUPPORTED (KLDR_ERR_BASE + 7)
1216/** The FAT image format isn't supported by this kLdr build or
1217 * a direct open was attempt without going thru the FAT file provider.
1218 * FAT images are also known as Universal Binaries. */
1219#define KLDR_ERR_FAT_NOT_SUPPORTED (KLDR_ERR_BASE + 8)
1220/** The a.out image format isn't supported by this kLdr build. */
1221#define KLDR_ERR_AOUT_NOT_SUPPORTED (KLDR_ERR_BASE + 9)
1222
1223/** Invalid parameter to a kLdr API. */
1224#define KLDR_ERR_INVALID_PARAMETER (KLDR_ERR_BASE + 32)
1225/** Invalid handle parameter to a kLdr API. */
1226#define KLDR_ERR_INVALID_HANDLE (KLDR_ERR_BASE + 33)
1227/** The module wasn't loaded dynamically. */
1228#define KLDR_ERR_NOT_LOADED_DYNAMICALLY (KLDR_ERR_BASE + 34)
1229/** The module wasn't found. */
1230#define KLDR_ERR_MODULE_NOT_FOUND (KLDR_ERR_BASE + 35)
1231/** A prerequisit module wasn't found. */
1232#define KLDR_ERR_PREREQUISITE_MODULE_NOT_FOUND (KLDR_ERR_BASE + 36)
1233/** The module is being terminated and can therefore not be loaded. */
1234#define KLDR_ERR_MODULE_TERMINATING (KLDR_ERR_BASE + 37)
1235/** A prerequisit module is being terminated and can therefore not be loaded. */
1236#define KLDR_ERR_PREREQUISITE_MODULE_TERMINATING (KLDR_ERR_BASE + 38)
1237/** The module initialization failed. */
1238#define KLDR_ERR_MODULE_INIT_FAILED (KLDR_ERR_BASE + 39)
1239/** The initialization of a prerequisite module failed. */
1240#define KLDR_ERR_PREREQUISITE_MODULE_INIT_FAILED (KLDR_ERR_BASE + 40)
1241/** The module has already failed initialization and can't be attempted reloaded until
1242 * after we've finished garbage collection. */
1243#define KLDR_ERR_MODULE_INIT_FAILED_ALREADY (KLDR_ERR_BASE + 41)
1244/** A prerequisite module has already failed initialization and can't be attempted
1245 * reloaded until after we've finished garbage collection. */
1246#define KLDR_ERR_PREREQUISITE_MODULE_INIT_FAILED_ALREADY (KLDR_ERR_BASE + 42)
1247/** Prerequisite recursed too deeply. */
1248#define KLDR_ERR_PREREQUISITE_RECURSED_TOO_DEEPLY (KLDR_ERR_BASE + 43)
1249/** Failed to allocate the main stack. */
1250#define KLDR_ERR_MAIN_STACK_ALLOC_FAILED (KLDR_ERR_BASE + 44)
1251/** Buffer overflow. */
1252#define KLDR_ERR_BUFFER_OVERFLOW (KLDR_ERR_BASE + 45)
1253/** The specified ARCH+CPU isn't compatible with image. */
1254#define KLDR_ERR_ARCH_CPU_NOT_COMPATIBLE (KLDR_ERR_BASE + 46)
1255/** Symbol not found. */
1256#define KLDR_ERR_SYMBOL_NOT_FOUND (KLDR_ERR_BASE + 47)
1257/** A forward symbol was encountered but the caller didn't provide any means to resolve it. */
1258#define KLDR_ERR_FORWARDER_SYMBOL (KLDR_ERR_BASE + 48)
1259/** Encountered a bad fixup. */
1260#define KLDR_ERR_BAD_FIXUP (KLDR_ERR_BASE + 49)
1261/** A memory allocation failed. */
1262#define KLDR_ERR_NO_MEMORY (KLDR_ERR_BASE + 50)
1263/** The import ordinal was out of bounds. */
1264#define KLDR_ERR_IMPORT_ORDINAL_OUT_OF_BOUNDS (KLDR_ERR_BASE + 51)
1265/** A forwarder chain was too long. */
1266#define KLDR_ERR_TOO_LONG_FORWARDER_CHAIN (KLDR_ERR_BASE + 52)
1267/** The module has no debug info. */
1268#define KLDR_ERR_NO_DEBUG_INFO (KLDR_ERR_BASE + 53)
1269/** The module is already mapped.
1270 * kLdrModMap() can only be called once (without kLdrModUnmap() in between). */
1271#define KLDR_ERR_ALREADY_MAPPED (KLDR_ERR_BASE + 54)
1272/** The module was not mapped.
1273 * kLdrModUnmap() should not called without being preceeded by a kLdrModMap(). */
1274#define KLDR_ERR_NOT_MAPPED (KLDR_ERR_BASE + 55)
1275/** Couldn't fit the address value into the field. Typically a relocation kind of error. */
1276#define KLDR_ERR_ADDRESS_OVERFLOW (KLDR_ERR_BASE + 56)
1277/** Couldn't fit a calculated size value into the native size type of the host. */
1278#define KLDR_ERR_SIZE_OVERFLOW (KLDR_ERR_BASE + 57)
1279/** Thread attach failed. */
1280#define KLDR_ERR_THREAD_ATTACH_FAILED (KLDR_ERR_BASE + 58)
1281/** The file reader can't take more concurrent mappings. */
1282#define KLDR_ERR_TOO_MANY_MAPPINGS (KLDR_ERR_BASE + 59)
1283/** The module wasn't a DLL or object file. */
1284#define KLDR_ERR_NOT_DLL (KLDR_ERR_BASE + 60)
1285/** The module wasn't an EXE. */
1286#define KLDR_ERR_NOT_EXE (KLDR_ERR_BASE + 61)
1287/** Not implemented yet. */
1288#define KLDR_ERR_TODO (KLDR_ERR_BASE + 62)
1289
1290
1291/** @name kLdrModPE status codes
1292 * @{ */
1293#define KLDR_ERR_PE_BASE (KLDR_ERR_BASE + 63)
1294/** The machine isn't supported by the interpreter. */
1295#define KLDR_ERR_PE_UNSUPPORTED_MACHINE (KLDR_ERR_PE_BASE + 0)
1296/** The file handler isn't valid. */
1297#define KLDR_ERR_PE_BAD_FILE_HEADER (KLDR_ERR_PE_BASE + 1)
1298/** The the optional headers isn't valid. */
1299#define KLDR_ERR_PE_BAD_OPTIONAL_HEADER (KLDR_ERR_PE_BASE + 2)
1300/** One of the section headers aren't valid. */
1301#define KLDR_ERR_PE_BAD_SECTION_HEADER (KLDR_ERR_PE_BASE + 3)
1302/** Bad forwarder entry. */
1303#define KLDR_ERR_PE_BAD_FORWARDER (KLDR_ERR_PE_BASE + 4)
1304/** Forwarder module not found in the import descriptor table. */
1305#define KLDR_ERR_PE_FORWARDER_IMPORT_NOT_FOUND (KLDR_ERR_PE_BASE + 5)
1306/** Bad PE fixups. */
1307#define KLDR_ERR_PE_BAD_FIXUP (KLDR_ERR_PE_BASE + 6)
1308/** Bad PE import (thunk). */
1309#define KLDR_ERR_PE_BAD_IMPORT (KLDR_ERR_PE_BASE + 7)
1310/** @} */
1311
1312/** @name kLdrModLX status codes
1313 * @{ */
1314#define KLDR_ERR_LX_BASE (KLDR_ERR_PE_BASE + 8)
1315/** validation of LX header failed. */
1316#define KLDR_ERR_LX_BAD_HEADER (KLDR_ERR_LX_BASE + 0)
1317/** validation of the loader section (in the LX header) failed. */
1318#define KLDR_ERR_LX_BAD_LOADER_SECTION (KLDR_ERR_LX_BASE + 1)
1319/** validation of the fixup section (in the LX header) failed. */
1320#define KLDR_ERR_LX_BAD_FIXUP_SECTION (KLDR_ERR_LX_BASE + 2)
1321/** validation of the LX object table failed. */
1322#define KLDR_ERR_LX_BAD_OBJECT_TABLE (KLDR_ERR_LX_BASE + 3)
1323/** A bad page map entry was encountered. */
1324#define KLDR_ERR_LX_BAD_PAGE_MAP (KLDR_ERR_LX_BASE + 4)
1325/** Bad iterdata (EXEPACK) data. */
1326#define KLDR_ERR_LX_BAD_ITERDATA (KLDR_ERR_LX_BASE + 5)
1327/** Bad iterdata2 (EXEPACK2) data. */
1328#define KLDR_ERR_LX_BAD_ITERDATA2 (KLDR_ERR_LX_BASE + 6)
1329/** Bad bundle data. */
1330#define KLDR_ERR_LX_BAD_BUNDLE (KLDR_ERR_LX_BASE + 7)
1331/** No soname. */
1332#define KLDR_ERR_LX_NO_SONAME (KLDR_ERR_LX_BASE + 8)
1333/** Bad soname. */
1334#define KLDR_ERR_LX_BAD_SONAME (KLDR_ERR_LX_BASE + 9)
1335/** Bad forwarder entry. */
1336#define KLDR_ERR_LX_BAD_FORWARDER (KLDR_ERR_LX_BASE + 10)
1337/** internal fixup chain isn't implemented yet. */
1338#define KLDR_ERR_LX_NRICHAIN_NOT_SUPPORTED (KLDR_ERR_LX_BASE + 11)
1339/** @} */
1340
1341/** @name
1342 * @{ */
1343#define KLDR_ERR_MACHO_BASE (KLDR_ERR_LX_BASE + 12)
1344/** Only native endian Mach-O files are supported. */
1345#define KLDR_ERR_MACHO_OTHER_ENDIAN_NOT_SUPPORTED (KLDR_ERR_MACHO_BASE + 0)
1346/** 64-bit Mach-O files aren't supported yet. */
1347#define KLDR_ERR_MACHO_64BIT_NOT_SUPPORTED (KLDR_ERR_MACHO_BASE + 1)
1348/** The Mach-O header is bad or contains new and unsupported features. */
1349#define KLDR_ERR_MACHO_BAD_HEADER (KLDR_ERR_MACHO_BASE + 2)
1350/** The file type isn't supported. */
1351#define KLDR_ERR_MACHO_UNSUPPORTED_FILE_TYPE (KLDR_ERR_MACHO_BASE + 3)
1352/** The machine (cputype / cpusubtype combination) isn't supported. */
1353#define KLDR_ERR_MACHO_UNSUPPORTED_MACHINE (KLDR_ERR_MACHO_BASE + 4)
1354/** Bad load command(s). */
1355#define KLDR_ERR_MACHO_BAD_LOAD_COMMAND (KLDR_ERR_MACHO_BASE + 5)
1356/** Encountered an unknown load command.*/
1357#define KLDR_ERR_MACHO_UNKNOWN_LOAD_COMMAND (KLDR_ERR_MACHO_BASE + 6)
1358/** Encountered a load command that's not implemented.*/
1359#define KLDR_ERR_MACHO_UNSUPPORTED_LOAD_COMMAND (KLDR_ERR_MACHO_BASE + 7)
1360/** Bad section. */
1361#define KLDR_ERR_MACHO_BAD_SECTION (KLDR_ERR_MACHO_BASE + 8)
1362/** Encountered a section type that's not implemented.*/
1363#define KLDR_ERR_MACHO_UNSUPPORTED_SECTION (KLDR_ERR_MACHO_BASE + 9)
1364/** Encountered a section type that's not known to the loader. (probably invalid) */
1365#define KLDR_ERR_MACHO_UNKNOWN_SECTION (KLDR_ERR_MACHO_BASE + 10)
1366/** The sections aren't ordered by segment as expected by the loader. */
1367#define KLDR_ERR_MACHO_BAD_SECTION_ORDER (KLDR_ERR_MACHO_BASE + 11)
1368/** The image is 32-bit and contains 64-bit load commands or vise versa. */
1369#define KLDR_ERR_MACHO_BIT_MIX (KLDR_ERR_MACHO_BASE + 12)
1370/** Bad MH_OBJECT file. */
1371#define KLDR_ERR_MACHO_BAD_OBJECT_FILE (KLDR_ERR_MACHO_BASE + 13)
1372/** Bad symbol table entry. */
1373#define KLDR_ERR_MACHO_BAD_SYMBOL (KLDR_ERR_MACHO_BASE + 14)
1374/** Unsupported fixup type. */
1375#define KLDR_ERR_MACHO_UNSUPPORTED_FIXUP_TYPE (KLDR_ERR_MACHO_BASE + 15)
1376/** @} */
1377
1378/** End of the valid kLdr status codes. */
1379#define KLDR_ERR_END (KLDR_ERR_MACHO_BASE + 16)
1380
1381const char *kLdrErrStr(int rc);
1382
1383/** @} */
1384
1385
1386#ifdef __cplusplus
1387}
1388#endif
1389
1390#endif
1391
Note: See TracBrowser for help on using the repository browser.