source: trunk/kLdr/kLdrInternal.h@ 2833

/* $Id: kLdrInternal.h 2833 2006-10-26 00:08:09Z bird $ */
/** @file
 *
 * kLdr - The Dynamic Loader, internal header.
 *
 * Copyright (c) 2006 knut st. osmundsen <bird-kbuild-src@anduin.net>
 *
 *
 * This file is part of kLdr.
 *
 * kLdr is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * kLdr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with kLdr; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


#ifndef __kLdrInternal_h__
#define __kLdrInternal_h__

#ifdef __cplusplus
extern "C" {
#endif

/* ignore definitions in winnt.h */
#undef IMAGE_DOS_SIGNATURE
#undef IMAGE_NT_SIGNATURE

/** @name Signatures we know
 * @{ */
/** ELF signature ("\x7fELF"). */
#define IMAGE_ELF_SIGNATURE KLDRHLP_LE2H_U32(0x7f | ('E' << 8) | ((uint32_t)'L' << 16) | ((uint32_t)'F' << 24))
/** PE signature ("PE\0\0"). */
#define IMAGE_NT_SIGNATURE  KLDRHLP_LE2H_U32('P' | ('E' << 8))
/** LX signature ("LX") */
#define IMAGE_LX_SIGNATURE  KLDRHLP_LE2H_U16('L' | ('X' << 8))
/** LE signature ("LE") */
#define IMAGE_LE_SIGNATURE  KLDRHLP_LE2H_U16('L' | ('E' << 8))
/** NE signature ("NE") */
#define IMAGE_NE_SIGNATURE  KLDRHLP_LE2H_U16('N' | ('E' << 8))
/** MZ signature ("MZ"). */
#define IMAGE_DOS_SIGNATURE KLDRHLP_LE2H_U16('M' | ('Z' << 8))
/** @} */

/** @defgroup grp_kLdrInternal  Internals
 * @internal
 * @{
 */


/** Native file provider operations. */
extern const KLDRRDROPS g_kLdrRdrFileOps;


/**
 * The state of a dynamic loader module.
 */
typedef enum KLDRSTATE
{
    /** The usual invalid 0 enum. */
    KLDRSTATE_INVALID = 0,
    /** kldrOpen succeeded.
     * Modules in this state will be freed at  */
    KLDRSTATE_OPEN,
    /** Dependencies has been loaded. */
    KLDRSTATE_DEPS,
    /** Fixups has been applied. */
    KLDRSTATE_FIXED,
    /** The module has been initialized. */
    KLDRSTATE_INITED,
    /** The module is loaded successfully. */
    KLDRSTATE_LOADED,
    /** The end of valid states (exclusive) */
    KLDRSTATE_END,
    /** The usual 32-bit blowup. */
    KLDRSTATE_32BIT_HACK = 0x7fffffff
} KLDRSTATE;


/**
 * Dynamic loader module.
 */
typedef struct KLDRDYLDMOD
{
    /** Magic number. */
    uint32_t            u32MagicHead;
    /** The module state. */
    KLDRSTATE           enmState;
    /** The module. */
    PKLDRMOD            pMod;
    /** The number of references. */
    uint32_t            cRefs;
    /** The number of dynamic references. */
    uint32_t            cDynRefs;
    /** Set if this is the executable module. */
    uint32_t            fExecutable : 1;
    /** Global DLL (set) or specific DLL (clear). */
    uint32_t            fGlobal : 1;
    /** Load stage one. */
    uint32_t            fLoadStageOne : 1;
    /** Reserved for future use. */
    uint32_t            fReserved : 29;
    /** The next module in the list. */
    struct KLDRDYMOD   *pNext;
    /** The prev module in the list. */
    struct KLDRDYMOD   *pPrev;
    /** Magic number. */
    uint32_t            u32MagicTail;
} KLDRDYLDMOD, *PKLDRDYLDMOD, **PPKLDRDYLDMOD;

/** KLDRDYMOD magic value. (Fuyumi Soryo) */
#define KLDRDYMOD_MAGIC     0x19590106

/** Return / crash validation of a module handle argument. */
#define KLDRDYLD_VALIDATE_HKLDRMOD(hMod) \
    do  { \
        if (    (hMod) == NIL_HKLDRMOD \
            ||  (hMod)->u32MagicHead != KLDRDYMOD_MAGIC \
            ||  (hMod)->u32MagicTail != KLDRDYMOD_MAGIC) \
        { \
            return KLDR_ERR_INVALID_HANDLE; \
        } \
    } while (0)


/** Pointer to the head module (the executable). */
extern PKLDRDYLDMOD     kLdrDyldModuleHead;
/** Pointer to the tail module. */
extern PKLDRDYLDMOD     kLdrDyldModuleTail;
/** The Library search path. */
extern char             kLdrDyldLibraryPath[4096];


#if 0
void kldrFailure(const char *pszFilename, ...);
#endif

/** @} */
#ifdef __cplusplus
}
#endif

#endif