Changeset 2849 for trunk/kLdr/kLdr.h

Timestamp:

Nov 2, 2006, 3:05:16 AM (19 years ago)

Author:

bird

Message:

Debug info query.

File:

• trunk/kLdr/kLdr.h (modified) (6 diffs)

trunk/kLdr/kLdr.h

@@ -281 +281 @@
 /** @defgroup grp_kLdrMod   kLdrMod - The executable image intepreter
  * @{ */
+
+
+/**
+ * Debug info type (from the loader point of view).
+ */
+typedef enum KLDRDBGINFOTYPE
+{
+    /** The usual invalid enum value. */
+    KLDRDBGINFOTYPE_INVALID = 0,
+    /** Stabs. */
+    KLDRDBGINFOTYPE_STABS,
+    /** Debug With Arbitrary Record Format (DWARF). */
+    KLDRDBGINFOTYPE_DWARF,
+    /** Microsoft Codeview debug info. */
+    KLDRDBGINFOTYPE_CODEVIEW,
+    /** Watcom debug info. */
+    KLDRDBGINFOTYPE_WATCOM,
+    /** IBM High Level Language debug info.. */
+    KLDRDBGINFOTYPE_HLL,
+    /** The end of the valid debug info values (exclusive). */
+    KLDRDBGINFOTYPE_END,
+    /** Blow the type up to 32-bit. */
+    KLDRDBGINFOTYPE_32BIT_HACK = 0x7fffffff
+} KLDRDBGINFOTYPE;
+/** Pointer to a kLdr debug info type. */
+typedef KLDRDBGINFOTYPE *PKLDRDBGINFOTYPE;
+
 
 /**
@@ -433 +460 @@
 } KLDRARCH;
 
+
 /**
  * CPU models.
@@ -607 +635 @@
  *
  * @returns 0 if enumeration should continue.
- * @returns non-zero if the enumeration should stop. This status code is the returned by kLdrModEnumSymbols().
+ * @returns non-zero if the enumeration should stop. This status code will then be returned by kLdrModEnumSymbols().
  *
  * @param   pMod        The module which symbols are being enumerated.s
@@ -622 +650 @@
 /** Pointer to a symbol enumerator callback. */
 typedef FNKLDRMODENUMSYMS *PFNKLDRMODENUMSYMS;
+
+/**
+ * Debug info enumerator callback.
+ *
+ * @returns 0 to continue the enumeration.
+ * @returns non-zero if the enumeration should stop. This status code will then be returned by kLdrModEnumDbgInfo().
+ *
+ * @param   pMod        The module.
+ * @param   enmType     The debug info type.
+ * @param   iDbgInfo    The debug info ordinal number / id.
+ * @param   offFile     The file offset *if* this type has one specific location in the executable image file.
+ *                      This is -1 if there isn't any specific file location.
+ * @param   cbFile      The file size.
+ *                      This is 0 if there isn't any specific file location.
+ * @param   pszExtFile  This points to the name of an external file containing the debug info.
+ *                      This is NULL if there isn't any external file.
+ * @param   pvUser      The user parameter specified to kLdrModEnumDbgInfo.
+ */
+typedef int FNKLDRENUMDBG(PKLDRMOD pMod, KLDRDBGINFOTYPE enmType, uint32_t iDbgInfo, off_t offFile, off_t cbFile,
+                          const char *pszExtFile, void *pvUser);
 
 int     kLdrModOpen(const char *pszFilename, PPKLDRMOD ppMod);
@@ -637 +685 @@
 int     kLdrModGetStackInfo(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PKLDRSTACKINFO pStackInfo);
 int     kLdrModQueryMainEntrypoint(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PKLDRADDR pMainEPAddress);
-size_t  kLdrModSize(PKLDRMOD pMod);
+/** Pointer to a debug info enumberator callback. */
+typedef FNKLDRENUMDBG *PFNKLDRENUMDBG;
+int     kLdrModEnumDbgInfo(PKLDRMOD pMod, void *pvBits, PFNKLDRENUMDBG pfnCallback, void *pvUser);
+int     kLdrModHasDbgInfo(PKLDRMOD pMod, void *pvBits);
 
 /** @name Operations On The Internally Managed Mapping
@@ -654 +705 @@
 /** @name Operations On The Externally Managed Mappings
  * @{ */
+size_t  kLdrModSize(PKLDRMOD pMod);
 int     kLdrModGetBits(PKLDRMOD pMod, void *pvBits, KLDRADDR BaseAddress, PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
 int     kLdrModRelocateBits(PKLDRMOD pMod, void *pvBits, KLDRADDR NewBaseAddress, KLDRADDR OldBaseAddress,
                             PFNKLDRMODGETIMPORT pfnGetImport, void *pvUser);
 /** @} */
+
 
 /** @} */