Changeset 2848 for trunk/kLdr/kLdrMod.c

Timestamp:

Nov 2, 2006, 1:08:16 AM (19 years ago)

Author:

bird

Message:

stubbed all the interpreter entry points.

File:

• trunk/kLdr/kLdrMod.c (modified) (3 diffs)

trunk/kLdr/kLdrMod.c

@@ -39 +39 @@
 # include "kLdrModELF64.h"
 #endif
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
@@ -108 +134 @@
 
 /**
- * Open a executable image by file name.
+ * Open a executable image .
  *
  * @returns 0 on success and *ppMod pointing to a module instance.
@@ -115 +141 @@
  * @param   ppMod           Where to store the module handle.
  */
-int kLdrModOpen(const char *pszFilename, PPKLDRMOD ppMod)
-{
-    /*
-     * Open the file using a bit provider.
-     */
-    PKLDRRDR pRdr;
-    int rc = kLdrRdrOpen(&pRdr, pszFilename);
-    if (!rc)
-    {
-        rc = kLdrModOpenFromRdr(pRdr, ppMod);
-        if (!rc)
-            return 0;
-       kLdrRdrClose(pRdr);
-    }
-    return rc;
-}
-
+int kLdrModOpenNative(const char *pszFilename, PPKLDRMOD ppMod)
+{
+#ifdef __OS2__
+
+    //DosLoadModule()
+#elif defined(__WIN__)
+
+#else
+# error "Port me"
+#endif
+    return -1;
+}
+
+
+
+/**
+ * Closes an open module.
+ *
+ * The caller is responsible for calling kLdrModUnmap() and kLdrFreeTLS()
+ * before closing the module.
+ *
+ * @returns 0 on success,
+ * @param   pMod    The module.
+ */
+int     kLdrModClose(PKLDRMOD pMod)
+{
+    //pMod->
+    return -1;
+}
+
+
+
+/**
+ * Queries a symbol by name or ordinal number.
+ *
+ * @returns 0 and *puValue and *pfKind on success.
+ *          KLDR_ERR_SYMBOL_NOT_FOUND is returned if the symbol wasn't found.
+ *          Other failures could stem from bad executable format failures,
+ *          read failure in case pvBits isn't specified and no mapping should be used.
+ * @param   pMod            The module.
+ * @param   pvBits          Optional pointer to bits returned by kLdrModGetBits() currently located at BaseAddress.
+ *                          This can be used by some module interpreters to reduce memory consumption.
+ * @param   BaseAddress     The module base address to use when calculating the symbol value.
+ *                          There are two special values that can be used:
+ *                              KLDRMOD_BASEADDRESS_LINK and KLDRMOD_BASEADDRESS_MAP.
+ * @param   uSymbol         The symbol ordinal. (optional)
+ * @param   pszSymbol       The symbol name. (optional)
+ * @param   puValue         Where to store the symbol value. (optional)
+ * @param   pfKind          Where to store the symbol kind. (optional)
+ */
+int     kLdrModQuerySymbol(PKLDRMOD pMod, const void *pvBits, KLDRADDR BaseAddress, uint32_t uSymbol,
+                           const char *pszSymbol, PKLDRADDR puValue, uint32_t *pfKind)
+{
+    return -1;
+}
+
+
+/**
+ * Enumerate the symbols in the module.
+ *
+ * @returns 0 on success and non-zero a status code on failure.
+ * @param   pMod            The module which symbols should be enumerated.
+ * @param   fFlags          The enumeration flags. A combination of the KLDRMOD_ENUM_SYMS_FLAGS_* \#defines.
+ * @param   pvBits          Optional pointer to bits returned by kLdrModGetBits() currently located at BaseAddress.
+ *                          This can be used by some module interpreters to reduce memory consumption.
+ * @param   BaseAddress     The module base address to use when calculating the symbol values.
+ *                          There are two special values that could be can:
+ *                              KLDRMOD_BASEADDRESS_LINK and KLDRMOD_BASEADDRESS_MAP.
+ * @param   pfnCallback     The enumeration callback function.
+ * @param   pvUser          The user argument to the callback function.
+ */
+int     kLdrModEnumSymbols(PKLDRMOD pMod, uint32_t fFlags, const void *pvBits, KLDRADDR BaseAddress,
+                           PFNKLDRMODENUMSYMS pfnCallback, void *pvUser)
+{
+    return -1;
+}
+
+
+/**
+ * Get the name of an import module by ordinal number.
+ *
+ * @returns 0 and name in pszName on success.
+ *          On buffer overruns KLDR_ERR_BUFFER_OVERFLOW will be returned.
+ *          On other failures and appropriate error code is returned.
+ * @param   pMod            The module.
+ * @param   pvBits          Optional pointer to bits returned by kLdrModGetBits().
+ *                          This can be used by some module interpreters to reduce memory consumption.
+ * @param   iImport         The import module ordinal number.
+ * @param   pszName         Where to store the name.
+ * @param   cchName         The size of the name buffer.
+ */
+int     kLdrModGetImport(PKLDRMOD pMod, void *pvBits, uint32_t iImport, const char *pszName, size_t cchName)
+{
+    return -1;
+}
+
+
+/**
+ * Get the number of import modules.
+ *
+ * @returns The number of import modules. -1 if something really bad happens.
+ * @param   pMod            The module.
+ * @param   pvBits          Optional pointer to bits returned by kLdrModGetBits().
+ *                          This can be used by some module interpreters to reduce memory consumption.
+ */
+int32_t kLdrModNumberOfImports(PKLDRMOD pMod, void *pvBits)
+{
+    return -1;
+}
+
+
+/**
+ * Checks if this module can be executed by the specified arch+cpu.
+ *
+ * @returns 0 if it can, KLDR_ERR_ARCH_CPU_NOT_COMPATIBLE if it can't.
+ *          Other failures may occur and cause other return values.
+ * @param   pMod            The module.
+ * @param   pvBits          Optional pointer to bits returned by kLdrModGetBits().
+ *                          This can be used by some module interpreters to reduce memory consumption.
+ */
+int     kLdrModCanExecuteOn(PKLDRMOD pMod, void *pvBits, KLDRARCH enmArch, KLDRCPU enmCpu)
+{
+    //return KLDR_ERR_ARCH_CPU_NOT_COMPATIBLE;
+    return 0;
+}
+
+
+/**
+ * Gets the image stack info.
+ *
+ * @returns 0 on success, non-zero on failure.
+ * @param   pMod
+ * @param   pvBits          Optional pointer to bits returned by kLdrModGetBits() currently located at BaseAddress.
+ *                          This can be used by some module interpreters to reduce memory consumption.
+ * @param   BaseAddress     The module base address to use when calculating the stack address.
+ *                          There are two special values that can be used:
+ *                              KLDRMOD_BASEADDRESS_LINK and KLDRMOD_BASEADDRESS_MAP.
+ * @param   pStackInfo      The stack information.
+ */
+int     kLdrModGetStackInfo(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PKLDRSTACKINFO pStackInfo)
+{
+    return -1;
+}
+
+
+/**
+ * Queries the main entrypoint of the module.
+ *
+ * Only executable are supposed to have an main entrypoint, though some object and DLL
+ * formats will also allow this.
+ *
+ * @returns 0 and *pMainEPAddress on success. Non-zero status code on failure.
+ * @param   pMod            The module.
+ * @param   pvBits          Optional pointer to bits returned by kLdrModGetBits() currently located at BaseAddress.
+ *                          This can be used by some module interpreters to reduce memory consumption.
+ * @param   BaseAddress     The module base address to use when calculating the entrypoint address.
+ *                          There are two special values that can be used:
+ *                              KLDRMOD_BASEADDRESS_LINK and KLDRMOD_BASEADDRESS_MAP.
+ * @param   pMainEPAddress  Where to store the entry point address.
+ */
+int     kLdrModQueryMainEntrypoint(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PKLDRADDR pMainEPAddress)
+{
+    return 1;
+}
+
+
+/**
+ * Get the size of the mapped module.
+ *
+ * @returns The size of the mapped module (in bytes).
+ * @param   pMod            The module.
+ */
+size_t  kLdrModSize(PKLDRMOD pMod)
+{
+    return 0;
+}
+
+
+/**
+ * Maps the module into the memory of the caller.
+ *
+ * On success the actual addresses for the segments can be found in MapAddress
+ * member of each segment in the segment array.
+ *
+ * @returns 0 on success, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module to be mapped.
+ * @remark  kLdr only supports one mapping at a time of a module.
+ */
+int     kLdrModMap(PKLDRMOD pMod)
+{
+    return -1;
+}
+
+
+/**
+ * Unmaps a module previously mapped by kLdrModMap().
+ *
+ * @returns 0 on success, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module to unmap.
+ */
+int     kLdrModUnmap(PKLDRMOD pMod)
+{
+    return -1;
+}
+
+
+/**
+ * Allocates Thread Local Storage for module mapped by kLdrModMap().
+ *
+ * Calling kLdrModAllocTLS() more than once without calling kLdrModFreeTLS()
+ * between each invocation is not supported.
+ *
+ * @returns 0 on success, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module.
+ */
+int     kLdrModAllocTLS(PKLDRMOD pMod)
+{
+    return 0;
+}
+
+
+/**
+ * Frees Thread Local Storage previously allocated by kLdrModAllocTLS().
+ *
+ * The caller is responsible for only calling kLdrModFreeTLS() once
+ * after calling kLdrModAllocTLS().
+ *
+ * @returns 0 on success, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module.
+ */
+void    kLdrModFreeTLS(PKLDRMOD pMod)
+{
+}
+
+
+/**
+ * Reloads all dirty pages in a module previously mapped by kLdrModMap().
+ *
+ * The module interpreter may omit code pages if it can safely apply code
+ * fixups again in a subsequent kLdrModFixupMapping() call.
+ *
+ * The caller is responsible for freeing TLS before calling this function.
+ *
+ * @returns 0 on success, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module.
+ */
+int     kLdrModReload(PKLDRMOD pMod)
+{
+    return -1;
+}
+
+
+/**
+ * Fixup the mapping made by kLdrModMap().
+ *
+ * The caller is only responsible for not calling this function more than
+ * once without doing kLDrModReload() inbetween.
+ *
+ * @returns 0 on success, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module.
+ * @param   pfnGetImport    The callback for resolving external (imported) symbols.
+ * @param   pvUser          The callback user argument.
+ */
+int     kLdrModFixupMapping(PKLDRMOD pMod, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser)
+{
+    return -1;
+}
+
+
+/**
+ * Call the module initializiation function of a mapped module (if any).
+ *
+ * @returns 0 on success or no init function, non-zero on init function failure or invalid pMod.
+ * @param   pMod            The module.
+ */
+int     kLdrModCallInit(PKLDRMOD pMod)
+{
+    return -1;
+}
+
+
+/**
+ * Call the module termination function of a mapped module (if any).
+ *
+ * @returns 0 on success or no term function, non-zero on invalid pMod.
+ * @param   pMod            The module.
+ *
+ * @remark  Termination function failure will be ignored by the module interpreter.
+ */
+int     kLdrModCallTerm(PKLDRMOD pMod)
+{
+    return 0;
+}
+
+
+/**
+ * Call the thread attach or detach function of a mapped module (if any).
+ *
+ * @returns 0 on success or no attach/detach function, non-zero on attach failure or invalid pMod.
+ * @param   pMod            The module.
+ *
+ * @remark  Detach function failure will be ignored by the module interpreter.
+ */
+int     kLdrModCallThread(PKLDRMOD pMod, unsigned fAttachingOrDetaching)
+{
+    return 0;
+}
+
+
+/**
+ * Gets the module bits.
+ *
+ * The module interpreter will fill a mapping allocated by the caller with the
+ * module bits reallocated to the specified address.
+ *
+ * @returns 0 on succes, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module.
+ * @param   pvBits          Where to put the bits.
+ * @param   BaseAddress     The base address that should correspond to the first byte in pvBits
+ *                          upon return.
+ * @param   pfnGetImport    The callback ufor resolving external (imported) symbols.
+ * @param   pvUser          The callback user argument.
+ */
+int     kLdrModGetBits(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser)
+{
+    return -1;
+}
+
+
+/**
+ * Relocates the module bits previously obtained by kLdrModGetBits().
+ *
+ * @returns 0 on succes, non-zero OS or kLdr status code on failure.
+ * @param   pMod            The module.
+ * @param   pvBits          Where to put the bits.
+ * @param   NewBaseAddress  The new base address.
+ * @param   OldBaseAddress  The old base address (i.e. the one specified to kLdrModGetBits() or as
+ *                          NewBaseAddressto the previous kLdrModRelocateBits() call).
+ * @param   pfnGetImport    The callback ufor resolving external (imported) symbols.
+ * @param   pvUser          The callback user argument.
+ */
+int     kLdrModRelocateBits(PKLDRMOD pMod, void *pvBits, KLDRADDR NewBaseAddress, KLDRADDR OldBaseAddress,
+                            PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser)
+{
+    return -1;
+}
+
+
+