Changeset 45994 in vbox for trunk/include

Timestamp:

May 12, 2013 7:16:16 PM (12 years ago)

Author:

vboxsync

Message:

RTDbgModCreateFromPeImage: Mostly implemented.

Location:

trunk/include/iprt

Files:

• dbg.h (modified) (2 diffs)
• err.h (modified) (1 diff)
• formats (added)
• formats/codeview.h (added)
• ldr.h (modified) (3 diffs)
• mangling.h (modified) (2 diffs)

trunk/include/iprt/dbg.h

@@ -400 +400 @@
 RTDECL(int) RTDbgCfgQueryUInt(RTDBGCFG hDbgCfg, RTDBGCFGPROP enmProp, uint64_t *puValue);
 
+
+/**
+ * Callback used by the RTDbgCfgOpen function to try out a file that was found.
+ *
+ * @returns On statuses other than VINF_CALLBACK_RETURN and
+ *          VERR_CALLBACK_RETURN the search will continue till the end of the
+ *          list.  The first error status code will be returned to the API
+ *          caller.
+ * @retval  VINF_CALLBACK_RETURN if successuflly opened the file and it's time
+ *          to return
+ * @retval  VERR_CALLBACK_RETURN if we shouldn't stop searching.
+ *
+ * @param   hDbgCfg             The debugging configuration handle.
+ * @param   pszFilename         The path to the file that should be tried out.
+ * @param   pvUser1             First user parameter.
+ * @param   pvUser2             Second user parameter.
+ */
+typedef DECLCALLBACK(int) FNDBGCFGOPEN(RTDBGCFG hDbgCfg, const char *pszFilename, void *pvUser1, void *pvUser2);
+/** Pointer to a open-file callback used to the RTDbgCfgOpen functions. */
+typedef FNDBGCFGOPEN *PFNDBGCFGOPEN;
+
+
+RTDECL(int) RTDbgCfgOpenPeImage(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
+                                PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
+RTDECL(int) RTDbgCfgOpenPdb70(RTDBGCFG hDbgCfg, const char *pszFilename, PCRTUUID pUuid, uint32_t uAge,
+                              PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
+RTDECL(int) RTDbgCfgOpenPdb20(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp, uint32_t uAge,
+                              PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
+RTDECL(int) RTDbgCfgOpenDbg(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t cbImage, uint32_t uTimestamp,
+                            PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
+RTDECL(int) RTDbgCfgOpenDwo(RTDBGCFG hDbgCfg, const char *pszFilename, uint32_t uCrc32,
+                            PFNDBGCFGOPEN pfnCallback, void *pvUser1, void *pvUser2);
 /** @} */
 
@@ -868 +900 @@
                                           RTDBGCFG hDbgCfg);
 RTDECL(int)         RTDbgModCreateFromPeImage(PRTDBGMOD phDbgMod, const char *pszFilename, const char *pszName, uint32_t cbImage,
-                                              uint32_t uTimeDateStamp, RTDBGCFG pDbgCfg);
+                                              uint32_t uTimeDateStamp, RTDBGCFG hDbgCfg);
 RTDECL(int)         RTDbgModCreateFromDbg(PRTDBGMOD phDbgMod, const char *pszFilename, const char *pszName, uint32_t cbImage,
-                                          uint32_t uTimeDateStamp, RTDBGCFG pDbgCfg);
+                                          uint32_t uTimeDateStamp, RTDBGCFG hDbgCfg);
 RTDECL(int)         RTDbgModCreateFromPdb(PRTDBGMOD phDbgMod, const char *pszFilename, const char *pszName, uint32_t cbImage,
-                                          PCRTUUID pUuid, uint32_t Age, RTDBGCFG pDbgCfg);
+                                          PCRTUUID pUuid, uint32_t Age, RTDBGCFG hDbgCfg);
 RTDECL(int)         RTDbgModCreateFromDwo(PRTDBGMOD phDbgMod, const char *pszFilename, const char *pszName, uint32_t cbImage,
-                                          uint32_t uCrc32, RTDBGCFG pDbgCfg);
+                                          uint32_t uCrc32, RTDBGCFG hDbgCfg);
 
 

trunk/include/iprt/err.h

@@ -1494 +1494 @@
 /** Not an integer property. */
 #define VERR_DBG_CFG_NOT_UINT_PROP              (-685)
+/** Deferred loading of information failed. */
+#define VERR_DBG_DEFERRED_LOAD_FAILED           (-686)
+/** Unfinished debug info reader code. */
+#define VERR_DBG_TODO                           (-687)
+/** Found file, but it didn't match the search criteria. */
+#define VERR_DBG_FILE_MISMATCH                  (-688)
+/** Internal processing error in the debug module reader code. */
+#define VERR_DBG_MOD_IPE                        (-689)
 /** @} */
 

trunk/include/iprt/ldr.h

@@ -359 +359 @@
     /** Debug With Arbitrary Record Format (DWARF). */
     RTLDRDBGINFOTYPE_DWARF,
+    /** Debug With Arbitrary Record Format (DWARF), in external file (DWO). */
+    RTLDRDBGINFOTYPE_DWARF_DWO,
     /** Microsoft Codeview debug info. */
     RTLDRDBGINFOTYPE_CODEVIEW,
+    /** Microsoft Codeview debug info, in external v2.0+ program database (PDB). */
+    RTLDRDBGINFOTYPE_CODEVIEW_PDB20,
+    /** Microsoft Codeview debug info, in external v7.0+ program database (PDB). */
+    RTLDRDBGINFOTYPE_CODEVIEW_PDB70,
+    /** Microsoft Codeview debug info, in external file (DBG). */
+    RTLDRDBGINFOTYPE_CODEVIEW_DBG,
     /** Watcom debug info. */
     RTLDRDBGINFOTYPE_WATCOM,
@@ -371 +379 @@
 } RTLDRDBGINFOTYPE;
 
+
+/**
+ * Debug info details for the enumeration callback.
+ */
+typedef struct RTLDRDBGINFO
+{
+    /** The kind of debug info. */
+    RTLDRDBGINFOTYPE    enmType;
+    /** The debug info ordinal number / id. */
+    uint32_t            iDbgInfo;
+    /** 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. */
+    RTFOFF              offFile;
+    /** The link address of the debug info if it's loadable. NIL_RTLDRADDR if not
+     * loadable*/
+    RTLDRADDR           LinkAddress;
+    /** The size of the debug information. -1 is used if this isn't applicable.*/
+    RTLDRADDR           cb;
+    /** This is set if the debug information is found in an external file.  NULL
+     * if no external file involved.
+     * @note Putting it outside the union to allow lazy callback implementation. */
+    const char         *pszExtFile;
+    /** Type (enmType) specific information. */
+    union
+    {
+        /** RTLDRDBGINFOTYPE_DWARF */
+        struct
+        {
+            /** The section name. */
+            const char *pszSection;
+        } Dwarf;
+
+        /** RTLDRDBGINFOTYPE_DWARF_DWO */
+        struct
+        {
+            /** The CRC32 of the external file. */
+            uint32_t    uCrc32;
+        } Dwo;
+
+        /** RTLDRDBGINFOTYPE_CODEVIEW_PDB20, RTLDRDBGINFOTYPE_CODEVIEW_DBG */
+        struct
+        {
+            /** The PE image size. */
+            uint32_t    cbImage;
+            /** The timestamp. */
+            uint32_t    uTimestamp;
+            /** The major version from the entry. */
+            uint32_t    uMajorVer;
+            /** The minor version from the entry. */
+            uint32_t    uMinorVer;
+        } Cv;
+
+        /** RTLDRDBGINFOTYPE_CODEVIEW_DBG */
+        struct
+        {
+            /** The PE image size. */
+            uint32_t    cbImage;
+            /** The timestamp. */
+            uint32_t    uTimestamp;
+        } Dbg;
+
+        /** RTLDRDBGINFOTYPE_CODEVIEW_PDB20*/
+        struct
+        {
+            /** The PE image size. */
+            uint32_t    cbImage;
+            /** The timestamp. */
+            uint32_t    uTimestamp;
+            /** The PDB age. */
+            uint32_t    uAge;
+        } Pdb20;
+
+        /** RTLDRDBGINFOTYPE_CODEVIEW_PDB70 */
+        struct
+        {
+            /** The PE image size. */
+            uint32_t    cbImage;
+            /** The PDB age. */
+            uint32_t    uAge;
+            /** The UUID. */
+            RTUUID      Uuid;
+        } Pdb70;
+    } u;
+} RTLDRDBGINFO;
+/** Pointer to debug info details. */
+typedef RTLDRDBGINFO *PRTLDRDBGINFO;
+/** Pointer to read only debug info details. */
+typedef RTLDRDBGINFO const *PCRTLDRDBGINFO;
+
+
 /**
  * Debug info enumerator callback.
@@ -378 +476 @@
  *
  * @param   hLdrMod         The module handle.
- * @param   iDbgInfo        The debug info ordinal number / id.
- * @param   enmType         The debug info type.
- * @param   iMajorVer       The major version number of the debug info format.
- *                          -1 if unknow - implies invalid iMinorVer.
- * @param   iMinorVer       The minor version number of the debug info format.
- *                          -1 when iMajorVer is -1.
- * @param   pszPartNm       The name of the debug info part, NULL if not
- *                          applicable.
- * @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   LinkAddress     The link address of the debug info if it's
- *                          loadable. NIL_RTLDRADDR if not loadable.
- * @param   cb              The size of the debug information. -1 is used if
- *                          this isn't applicable.
- * @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   pDbgInfo        Pointer to a read only structure with the details.
  * @param   pvUser          The user parameter specified to RTLdrEnumDbgInfo.
  */
-typedef DECLCALLBACK(int) FNRTLDRENUMDBG(RTLDRMOD hLdrMod, uint32_t iDbgInfo, RTLDRDBGINFOTYPE enmType,
-                                         uint16_t iMajorVer, uint16_t iMinorVer, const char *pszPartNm,
-                                         RTFOFF offFile, RTLDRADDR LinkAddress, RTLDRADDR cb,
-                                         const char *pszExtFile, void *pvUser);
+typedef DECLCALLBACK(int) FNRTLDRENUMDBG(RTLDRMOD hLdrMod, PCRTLDRDBGINFO pDbgInfo, void *pvUser);
 /** Pointer to a debug info enumerator callback. */
 typedef FNRTLDRENUMDBG *PFNRTLDRENUMDBG;

trunk/include/iprt/mangling.h

@@ -369 +369 @@
 # define RTDbgAsSymbolByName                            RT_MANGLER(RTDbgAsSymbolByName)
 # define RTDbgAsSymbolByNameA                           RT_MANGLER(RTDbgAsSymbolByNameA)
+# define RTDbgCfgCreate                                 RT_MANGLER(RTDbgCfgCreate)
+# define RTDbgCfgRetain                                 RT_MANGLER(RTDbgCfgRetain)
+# define RTDbgCfgRelease                                RT_MANGLER(RTDbgCfgRelease)
+# define RTDbgCfgChangeString                           RT_MANGLER(RTDbgCfgChangeString)
+# define RTDbgCfgChangeUInt                             RT_MANGLER(RTDbgCfgChangeUInt)
+# define RTDbgCfgQueryString                            RT_MANGLER(RTDbgCfgQueryString)
+# define RTDbgCfgQueryUInt                              RT_MANGLER(RTDbgCfgQueryUInt)
+# define RTDbgCfgOpenDbg                                RT_MANGLER(RTDbgCfgOpenDbg)
+# define RTDbgCfgOpenDwo                                RT_MANGLER(RTDbgCfgOpenDwo)
+# define RTDbgCfgOpenPdb70                              RT_MANGLER(RTDbgCfgOpenPdb70)
+# define RTDbgCfgOpenPdb20                              RT_MANGLER(RTDbgCfgOpenPdb20)
+# define RTDbgCfgOpenPeImage                            RT_MANGLER(RTDbgCfgOpenPeImage)
 # define RTDbgLineAlloc                                 RT_MANGLER(RTDbgLineAlloc)
 # define RTDbgLineDup                                   RT_MANGLER(RTDbgLineDup)
 # define RTDbgLineFree                                  RT_MANGLER(RTDbgLineFree)
 # define RTDbgModCreate                                 RT_MANGLER(RTDbgModCreate)
+# define RTDbgModCreateFromDbg                          RT_MANGLER(RTDbgModCreateFromDbg)
+# define RTDbgModCreateFromDwo                          RT_MANGLER(RTDbgModCreateFromDwo)
 # define RTDbgModCreateFromImage                        RT_MANGLER(RTDbgModCreateFromImage)
 # define RTDbgModCreateFromMap                          RT_MANGLER(RTDbgModCreateFromMap)
+# define RTDbgModCreateFromPdb                          RT_MANGLER(RTDbgModCreateFromPdb)
+# define RTDbgModCreateFromPeImage                      RT_MANGLER(RTDbgModCreateFromPeImage)
 # define RTDbgModGetTag                                 RT_MANGLER(RTDbgModGetTag)
 # define RTDbgModImageSize                              RT_MANGLER(RTDbgModImageSize)
@@ -404 +420 @@
 # define RTDbgSymbolDup                                 RT_MANGLER(RTDbgSymbolDup)
 # define RTDbgSymbolFree                                RT_MANGLER(RTDbgSymbolFree)
-# define RTDbgCfgCreate                                 RT_MANGLER(RTDbgCfgCreate)
-# define RTDbgCfgRetain                                 RT_MANGLER(RTDbgCfgRetain)
-# define RTDbgCfgRelease                                RT_MANGLER(RTDbgCfgRelease)
-# define RTDbgCfgChangeString                           RT_MANGLER(RTDbgCfgChangeString)
-# define RTDbgCfgChangeUInt                             RT_MANGLER(RTDbgCfgChangeUInt)
-# define RTDbgCfgQueryString                            RT_MANGLER(RTDbgCfgQueryString)
-# define RTDbgCfgQueryUInt                              RT_MANGLER(RTDbgCfgQueryUInt)
 # define RTDirClose                                     RT_MANGLER(RTDirClose)
 # define RTDirCreate                                    RT_MANGLER(RTDirCreate)