Changeset 2832 for trunk/kLdr/kLdr.h


Ignore:
Timestamp:
Oct 25, 2006, 12:26:01 AM (19 years ago)
Author:
bird
Message:

specified more of the api.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/kLdr/kLdr.h

    r2830 r2832  
    260260typedef struct KLDRSEG
    261261{
    262     /** The segment load address. */
    263     void           *pv;
     262    /** Variable free to use for the kLdr user. */
     263    void           *pvUser;
     264    /** The segment name. */
     265    const char     *pszName;
    264266    /** The size of the segment. */
    265267    size_t          cb;
    266     /** The segment is readable. */
    267     uint32_t        fRead : 1;
    268     /** The segment is writable. */
    269     uint32_t        fWrite : 1;
    270     /** The segment is executable. */
    271     uint32_t        fExecute : 1;
    272     /** Reserved for future use. */
    273     uint32_t        fReserved : 29;
    274     /** Reserved for future use. */
    275     uint32_t        u32Reserved;
     268    /** The link time load address. */
     269    void           *pvLink;
     270    /** The actual load address (if loaded). */
     271    void           *pv;
     272    /** The segment protection. */
     273    KLDRPROT        enmProt;
    276274} KLDRSEG, *PKLDRSEG;
     275
     276
     277/**
     278 * Loader module format.
     279 */
     280typedef enum KLDRFMT
     281{
     282    /** The usual invalid 0 format. */
     283    KLDRFMT_INVALID = 0,
     284    /** The native OS loader. */
     285    KLDRFMT_NATIVE,
     286    /** The AOUT loader. */
     287    KLDRFMT_AOUT,
     288    /** The ELF loader. */
     289    KLDRFMT_ELF,
     290    /** The LX loader. */
     291    KLDRFMT_LX,
     292    /** The mach-o loader. */
     293    KLDRFMT_MACHO,
     294    /** The LX loader. */
     295    KLDRFMT_PE,
     296    /** The end of the valid format values (exclusive). */
     297    KLDRFMT_END,
     298    /** Hack to blow the type up to 32-bit. */
     299    KLDRFMT_32BIT_HACK = 0x7fffffff
     300} KLDRFMT;
    277301
    278302
    … …  
    284308    /** The usual invalid 0 type. */
    285309    KLDRTYPE_INVALID = 0,
    286     /** The native OS loader. */
    287     KLDRTYPE_NATIVE,
    288     /** The LX loader. */
    289     KLDRTYPE_LX,
    290     /** The end type (not included). */
     310    /** Object file. */
     311    KLDRTYPE_OBJECT,
     312    /** Executable module, fixed load address. */
     313    KLDRTYPE_EXECUTABLE_FIXED,
     314    /** Executable module, relocatable, non-fixed load address. */
     315    KLDRTYPE_EXECUTABLE_RELOCATABLE,
     316    /** Executable module, position independent code, non-fixed load address. */
     317    KLDRTYPE_EXECUTABLE_PIC,
     318    /** Shared library, fixed load address.
     319     * Typically a system library. */
     320    KLDRTYPE_SHARED_LIBRARY_FIXED,
     321    /** Shared library, relocatable, non-fixed load address. */
     322    KLDRTYPE_SHARED_LIBRARY_RELOCATABLE,
     323    /** Shared library, position independent code, non-fixed load address. */
     324    KLDRTYPE_SHARED_LIBRARY_PIC,
     325    /** DLL that contains no code or data only imports and exports. (Chiefly OS/2.) */
     326    KLDRTYPE_FORWARDER_DLL,
     327    /** Core or dump. */
     328    KLDRTYPE_CORE,
     329    /** The end of the valid types values (exclusive). */
    291330    KLDRTYPE_END,
    292331    /** Hack to blow the type up to 32-bit. */
    … …  
    296335
    297336/**
     337 * CPU Architecture.
     338 * @todo Double check the non intel architectures.
     339 */
     340typedef enum KLDRARCH
     341{
     342    /** The usual invalid one. */
     343    KLDRARCH_INVALID = 0,
     344    /** Clone or Intel 16-bit x86. */
     345    KLDRARCH_X86_16,
     346    /** Clone or Intel 32-bit x86. */
     347    KLDRARCH_X86_32,
     348    /** AMD64 (including clones). */
     349    KLDRARCH_AMD64,
     350    /** Itanic (64-bit). */
     351    KLDRARCH_IA64,
     352    /** ALPHA (64-bit). */
     353    KLDRARCH_ALPHA,
     354    /** ALPHA limited to 32-bit. */
     355    KLDRARCH_ALPHA_32,
     356    /** 32-bit ARM. */
     357    KLDRARCH_ARM_32,
     358    /** 64-bit ARM. */
     359    KLDRARCH_ARM_64,
     360    /** 32-bit MIPS. */
     361    KLDRARCH_MIPS_32,
     362    /** 64-bit MIPS. */
     363    KLDRARCH_MIPS_64,
     364    /** 32-bit PowerPC. */
     365    KLDRARCH_POWERPC_32,
     366    /** 64-bit PowerPC. */
     367    KLDRARCH_POWERPC_64,
     368    /** 32-bit SPARC. */
     369    KLDRARCH_SPARC_32,
     370    /** 64-bit SPARC. */
     371    KLDRARCH_SPARC_64,
     372    /** The end of the valid architecture values (exclusive). */
     373    KLDRARCH_END,
     374    /** Hack to blow the type up to 32-bit. */
     375    KLDRARCH_32BIT_HACK = 0x7fffffff
     376} KLDRARCH;
     377
     378/**
     379 * CPU models.
     380 */
     381typedef enum KLDRCPU
     382{
     383    /** The usual invalid cpu. */
     384    KLDRCPU_INVALID = 0,
     385    /** @name KLDRARCH_X86_16
     386     * @{ */
     387    KLDRCPU_I8086,
     388    KLDRCPU_I8088,
     389    KLDRCPU_I80186,
     390    KLDRCPU_I80286,
     391    KLDRCPU_I386_16,
     392    KLDRCPU_I486_16,
     393    KLDRCPU_I486SX_16,
     394    KLDRCPU_I586_16,
     395    KLDRCPU_I686_16,
     396    KLDRCPU_K6_16,
     397    KLDRCPU_K7_16,
     398    KLDRCPU_K8_16,
     399    /** @} */
     400
     401    /** @name KLDRARCH_X86_32
     402     * @{ */
     403    KLDRCPU_I386,
     404    KLDRCPU_I486,
     405    KLDRCPU_I486SX,
     406    KLDRCPU_I586,
     407    KLDRCPU_I686,
     408    KLDRCPU_P4,
     409    KLDRCPU_CORE2_32,
     410    KLDRCPU_K6,
     411    KLDRCPU_K7,
     412    KLDRCPU_K8_32,
     413    /** @} */
     414
     415    /** @name KLDRARCH_AMD64
     416     * @{ */
     417    KLDRCPU_K8,
     418    KLDRCPU_P4_64,
     419    KLDRCPU_CORE2,
     420    /** @} */
     421
     422    /** The end of the valid cpu values (exclusive). */
     423    KLDRCPU_END,
     424    /** Hack to blow the type up to 32-bit. */
     425    KLDRCPU_32BIT_HACK = 0x7fffffff
     426} KLDRCPU;
     427
     428
     429/**
     430 * Loader endian indicator.
     431 */
     432typedef enum KLDRENDIAN
     433{
     434    /** The usual invalid endian. */
     435    KLDRENDIAN_INVALID,
     436    /** Little endian. */
     437    KLDRENDIAN_LITTLE,
     438    /** Bit endian. */
     439    KLDRENDIAN_BIG,
     440    /** Endianness doesn't have a meaning in the context. */
     441    KLDRENDIAN_NA,
     442    /** The end of the valid endian values (exclusive). */
     443    KLDRENDIAN_END,
     444    /** Hack to blow the type up to 32-bit. */
     445    KLDRENDIAN_32BIT_HACK = 0x7fffffff
     446} KLDRENDIAN;
     447
     448
     449/**
    298450 * Loader module.
    299451 */
    … …  
    302454    /** Magic number. */
    303455    uint32_t            u32Magic;
    304     /** The type of module this is. */
     456    /** The format of this module. */
     457    KLDRFMT             enmFmt;
     458    /** The type of module. */
    305459    KLDRTYPE            enmType;
    306     /** The module data. */
    307     void               *pvData;
     460    /** The architecture this module was built for. */
     461    KLDRARCH            enmArch;
     462    /** The minium cpu this module was built for.
     463     * This might not be accurate, so use kLdrModCanExecuteOn() to check. */
     464    KLDRARCH            enmCpu;
     465    /** The endian used by the module. */
     466    KLDRENDIAN          enmEndian;
    308467    /** The filename length (bytes). */
    309468    uint32_t            cchFilename;
    … …  
    316475    /** The number of segments in the module. */
    317476    uint32_t            cSegments;
     477    /** The module data. */
     478    void               *pvData;
    318479    /** Segments. (variable size, can be zero) */
    319480    KLDRSEG             aSegments[1];
    … …  
    321482
    322483
    323 int kLdrModOpen(const char *pszFilename, PPKLDRMOD ppMod);
    324 int kLdrModClose(PKLDRMOD pMod);
    325 int kLdrModGetSymbol(PKLDRMOD pMod, const void *pvBits, uintmax_t BaseAddress, const char *pszSymbol, uintmax_t *pValue, unsigned *pfType);
    326 int kLdrModGetSymbol(PKLDRMOD pMod, const void *pvBits, uintmax_t BaseAddress, const char *pszSymbol, uintmax_t *pValue, unsigned *pfType);
    327 
    328 size_t kLdrModSize(PKLDRMOD pMod);
    329 
    330 typedef int FNKLDRMODGETIMPORT(PKLDRMOD pMod, const char *pszModule, const char *pszSymbol, unsigned uSymbol, uintmax_t *pValue, void *pvUser);
    331 typedef FNKLDRMODGETIMPORT *PFNKLDRMODGETIMPORT;
    332 int kLdrModGetBits(PKLDRMOD pMod, void *pvBits, uintmax_t BaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
    333 int kLdrModRelocate(PKLDRMOD pMod, void *pvBits, uintmax_t NewBaseAddress, uintmax_t OldBaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
    334 
    335 typedef int FNKLDRMODENUMSYMS(PKLDRMOD pMod, const char *pszSymbol, unsigned uSymbol, uintmax_t Value, void *pvUser);
    336 typedef FNKLDRMODENUMSYMS *PFNKLDRMODENUMSYMS;
    337 int kLdrModEnumSymbols(PKLDRMOD pMod, unsigned fFlags, const void *pvBits, uintmax_t BaseAddress, PFNKLDRMODENUMSYMS pfnCallback, void *pvUser);
     484/** Special base address value alias for the link address. */
     485#define KLDRMOD_BASEADDRESS_LINK            (~(uintmax_t)1)
     486/** Special base address value alias for the actual load address (must be mapped). */
     487#define KLDRMOD_BASEADDRESS_MAP             (~(uintmax_t)2)
     488
     489/** @name Load symbol kind flags.
     490 * @{ */
     491/** The bitness doesn't matter. */
     492#define KLDRSYMKIND_NO_BIT          0x00000000
     493/** 16-bit symbol. */
     494#define KLDRSYMKIND_16BIT           0x00000001
     495/** 32-bit symbol. */
     496#define KLDRSYMKIND_32BIT           0x00000002
     497/** 64-bit symbol. */
     498#define KLDRSYMKIND_64BIT           0x00000003
     499/** Mask out the bit.*/
     500#define KLDRSYMKIND_BIT_MASK        0x00000003
     501/** We don't know the type of symbol. */
     502#define KLDRSYMKIND_NO_TYPE         0x00000000
     503/** The symbol is a code object (method/function/procedure/whateveryouwannacallit). */
     504#define KLDRSYMKIND_CODE            0x00000010
     505/** The symbol is a data object. */
     506#define KLDRSYMKIND_DATA            0x00000020
     507/** Mask out the symbol type. */
     508#define KLDRSYMKIND_TYPE_MASK       0x00000030
     509/** Valid symbol kind mask. */
     510#define KLDRSYMKIND_MASK            0x00000033
     511/** @} */
     512
    338513/** @name kLdrModEnumSymbols flags.
    339514 * @{ */
    … …  
    342517/** @} */
    343518
    344 /** @} */
    345 
    346 
    347 
    348 
    349 /** @defgroup grp_kLdrDy   kLdrDy - The dynamic loader
    350  * @{ */
    351 
    352 /** The h*/
    353 typedef struct KLDRDY *PKLDRDY;
    354 
    355 /*
    356 int kLdrLoadDll(const char *pszFilename, unsigned fFlags, unsigned long *pvmod);
    357 */
     519
     520typedef int FNKLDRMODGETIMPORT(PKLDRMOD pMod, const char *pszModule, const char *pszSymbol, uint32_t uSymbol,
     521                               uintmax_t *pValue, uint32_t *pfKind, void *pvModuleUser, void *pvUser);
     522typedef FNKLDRMODGETIMPORT *PFNKLDRMODGETIMPORT;
     523typedef int FNKLDRMODENUMIMPMODS(PKLDRMOD pMod, const char *pszImpMod, unsigned fFlags, void *pvUser);
     524typedef FNKLDRMODENUMIMPMODS *PFNKLDRMODENUMIMPMODS;
     525typedef int FNKLDRMODENUMSYMS(PKLDRMOD pMod, const char *pszSymbol, unsigned uSymbol, uintmax_t Value, uint32_t fKind, void *pvUser);
     526typedef FNKLDRMODENUMSYMS *PFNKLDRMODENUMSYMS;
     527
     528int     kLdrModOpen(const char *pszFilename, PPKLDRMOD ppMod);
     529int     kLdrModClose(PKLDRMOD pMod);
     530int     kLdrModGetSymbol(PKLDRMOD pMod, const void *pvBits, uintmax_t BaseAddress, const char *pszSymbol, uintmax_t *pValue, uint32_t *pfKind);
     531int     kLdrModEnumSymbols(PKLDRMOD pMod, unsigned fFlags, const void *pvBits, uintmax_t BaseAddress, PFNKLDRMODENUMSYMS pfnCallback, void *pvUser);
     532int     kLdrModEnumImportModules(PKLDRMOD pMod, unsigned fFlags, const void *pvBits, FNKLDRMODENUMIMPMODS pfnCallback, void *pvUser);
     533int     kLdrModMap(PKLDRMOD pMod);
     534int     kLdrModUnmap(PKLDRMOD pMod);
     535int     kLdrModFixupMapping(PKLDRMOD pMod, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
     536size_t  kLdrModSize(PKLDRMOD pMod);
     537int     kLdrModGetBits(PKLDRMOD pMod, void *pvBits, uintmax_t BaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
     538int     kLdrModRelocateBits(PKLDRMOD pMod, void *pvBits, uintmax_t NewBaseAddress, uintmax_t OldBaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
     539int     kLdrModCanExecuteOn(PKLDRMOD pMod, KLDRARCH enmArch, KLDRCPU enmCpu);
     540
     541/** @} */
     542
     543
     544
     545
     546/** @defgroup grp_kLdrDyld   kLdrDyld - The dynamic loader
     547 * @{ */
     548
     549/** The handle to a dynamic loader module. */
     550typedef struct KLDRDYLD *HKLDRMOD;
     551/** Pointer to the handle to a dynamic loader module. */
     552typedef HKLDRMOD *PHKLDRMOD;
     553
     554
     555/**
     556 * File search method.
     557 *
     558 * In addition to it's own way of finding files, kLdr emulates
     559 * the methods employed by the most popular systems.
     560 */
     561typedef enum KLDRDYLDSEARCH
     562{
     563    /** The usual invalid file search method. */
     564    KLDRDYLD_SEARCH_INVALID = 0,
     565    /** Uses the kLdr file search method.
     566     * @todo invent me. */
     567    KLDRDYLD_SEARCH_KLDR,
     568    /** Use the emulation closest to the host system. */
     569    KLDRDYLD_SEARCH_HOST,
     570    /** Emulate the OS/2 file search method.
     571     * On non-OS/2 systems, BEGINLIBPATH, LIBPATH, ENDLIBPATH and LIBPATHSTRICT are
     572     * taken form the environment. */
     573    KLDRDYLD_SEARCH_OS2,
     574    /** Emulate the standard window file search method. */
     575    KLDRDYLD_SEARCH_WINDOWS,
     576    /** Emulate the alternative window file search method. */
     577    KLDRDYLD_SEARCH_WINDOWS_ALTERED,
     578    /** Emulate the most common UNIX file search method. */
     579    KLDRDYLD_SEARCH_UNIX_COMMON,
     580} KLDRDYLDSEARCH;
     581
     582/** @name kLdrLoadDll flags.
     583 * @{ */
     584/** The symbols in the module should be loaded into the global unix namespace.
     585 * If not specified, the symbols are local and can only be referenced directly. */
     586#define KLDRYDLD_LOAD_FLAGS_GLOBAL_SYMBOLS      0x00000001
     587/** The module shouldn't be found by a global module search.
     588 * If not specified, the module can be found by unspecified module searches,
     589 * typical used when loading import/dep modules. */
     590#define KLDRYDLD_LOAD_FLAGS_SPECIFIC_MODULE     0x00000002
     591/** @todo more to come. */
     592/** @} */
     593
     594
     595int     kLdrDyldLoad(const char *pszDll, const char *pszDefPrefix, const char *pszDefSuffix, unsigned fFlags,
     596                     PHKLDRMOD phMod, char *pszErr, size_t cchErr);
     597int     kLdrDyldUnload(HKLDRMOD hMod);
     598int     kLdrDyldFindByName(const char *pszDll, PHKLDRMOD *phMod);
     599int     kLdrDyldFindByPC(uintptr_t PC, PHKLDRMOD *phMod, uint32_t *piSegment, uintptr_t *poffSegment);
     600int     kLdrDyldGetName(HKLDRMOD hMod, char *pszName, size_t cchName);
     601int     kLdrDyldGetFilename(HKLDRMOD hMod, char *pszName, size_t cchName);
     602int     kLdrDyldQuerySymbol(HKLDRMOD hMod, uint32_t uSymbolOrdinal, const char *pszSymbolName, uintptr_t *pValue, uint32_t *pfKind);
     603
     604/** @name OS/2 like API
     605 * @{ */
     606int     kLdrDosLoadModule(char *pszObject, size_t cbObject, const char *pszModule, PHKLDRMOD phMod);
     607int     kLdrDosFreeModule(HKLDRMOD hMod);
     608int     kLdrDosQueryModuleHandle(const char *pszModname, PHKLDRMOD phMod);
     609int     kLdrDosQueryModuleName(HKLDRMOD hMod, size_t cchName, char *pszName);
     610int     kLdrDosQueryProcAddr(HKLDRMOD hMod, uint32_t iOrdinal, const char *pszProcName, void **ppvProcAddr);
     611int     kLdrDosQueryProcType(HKLDRMOD hMod, uint32_t iOrdinal, const char *pszProcName, uint32_t *pfProcType);
     612int     kLdrDosQueryModFromEIP(PHKLDRMOD phMod, uint32_t *piObject, size_t cbName, char *pszName, uintptr_t *poffObject, uintptr_t ulEIP);
     613int     kLdrDosReplaceModule(const char *pszOldModule, const char *pszNewModule, const char *pszBackupModule);
     614int     kLdrDosGetResource(HKLDRMOD hMod, uint32_t idType, uint32_t idName, void **pvResAddr);
     615int     kLdrDosQueryResourceSize(HKLDRMOD hMod, uint32_t idTypeID, uint32_t idName, uint32_t *pcb);
     616int     kLdrDosFreeResource(void *pvResAddr);
     617/** @} */
     618
     619/** @name POSIX like API
     620 * @{ */
     621HKLDRMOD    kLdrDlOpen(const char *pszLibrary, int fFlags);
     622const char *kLdrDlError(void);
     623void *      kLdrDlSym(HKLDRMOD hMod, const char *pszSymbol);
     624int         kLdrDlClose(HKLDRMOD hMod);
     625/** @} */
     626
     627/** @name Win32 like API
     628 * @{ */
     629HKLDRMOD    kLdrWLoadLibrary(const char *pszFilename);
     630HKLDRMOD    kLdrWLoadLibraryEx(const char *pszFilename, void *hFileReserved, uint32_t fFlags);
     631uint32_t    kLdrWGetModuleFileName(HKLDRMOD hMod, char *pszModName, size_t cchModName);
     632HKLDRMOD    kLdrWGetModuleHandle(const char *pszFilename);
     633int         kLdrWGetModuleHandleEx(uint32_t fFlags, const char *pszFilename, HKLDRMOD hMod);
     634void *      kLdrWGetProcAddress(HKLDRMOD hMod, const char *pszProcName);
     635uint32_t    kLdrWGetDllDirectory(size_t cchDir, char *pszDir);
     636int         kLdrWSetDllDirectory(const char *pszDir);
     637int         kLdrWFreeLibrary(HKLDRMOD hMod);
     638int         kLdrWDisableThreadLibraryCalls(HKLDRMOD hMod);
     639
     640/** @} */
     641
    358642
    359643/** @name Process Bootstrapping
    … …  
    373657} KLDREXEARGS, *PKLDREXEARGS;
    374658
    375 void kLdrLoadExe(PKLDREXEARGS pArgs);
     659void kLdrLoadExe(PKLDREXEARGS pArgs, void *pvOS);
     660
    376661/** @} */
    377662
Note: See TracChangeset for help on using the changeset viewer.