Changeset 20744 in vbox for trunk/include/iprt/dbg.h

Timestamp:

Jun 21, 2009 3:43:57 PM (15 years ago)

Author:

vboxsync

Message:

IPRT: RTDbg coding.

File:

• trunk/include/iprt/dbg.h (modified) (8 diffs)

trunk/include/iprt/dbg.h

@@ -63 +63 @@
 #define RTDBGSEGIDX_SPECIAL_FIRST   (RTDBGSEGIDX_LAST + 1U)
 
+
+/** Max length (including '\\0') of a segment name. */
+#define RTDBG_SEGMENT_NAME_LENGTH   (128 - 8 - 8 - 8 - 4 - 4)
+
+/**
+ * Debug module segment.
+ */
+typedef struct RTDBGSEGMENT
+{
+    /** The load address.
+     * RTUINTPTR_MAX if not applicable. */
+    RTUINTPTR           Address;
+    /** The image relative virtual address of the segment.
+     * RTUINTPTR_MAX if not applicable. */
+    RTUINTPTR           uRva;
+    /** The segment size. */
+    RTUINTPTR           cb;
+    /** The segment flags. (reserved) */
+    uint32_t            fFlags;
+    /** The segment index. */
+    RTDBGSEGIDX         iSeg;
+    /** Symbol name. */
+    char                szName[RTDBG_SEGMENT_NAME_LENGTH];
+} RTDBGSEGMENT;
+/** Pointer to a debug module segment. */
+typedef RTDBGSEGMENT *PRTDBGSEGMENT;
+/** Pointer to a const debug module segment. */
+typedef RTDBGSEGMENT const *PCRTDBGSEGMENT;
+
+
+
 /** Max length (including '\\0') of a symbol name. */
-#define RTDBG_SYMBOL_NAME_LENGTH   (512 - 8 - 4 - 4 - 4)
+#define RTDBG_SYMBOL_NAME_LENGTH    (384 - 8 - 8 - 8 - 4 - 4 - 8)
 
 /**
@@ -75 +106 @@
      * as RTDbgMod, but the mapping address if you ask RTDbgAs. */
     RTUINTPTR           Value;
+    /** Symbol size. */
+    RTUINTPTR           cb;
     /** Offset into the segment specified by iSeg. */
     RTUINTPTR           offSeg;
     /** Segment number. */
     RTDBGSEGIDX         iSeg;
-    /** Symbol size. */
-    uint32_t            cb;
     /** Symbol Flags. (reserved). */
     uint32_t            fFlags;
+    /** Symbol ordinal.
+     * This is set to UINT32_MAX if the ordinals aren't supported. */
+    uint32_t            iOrdinal;
     /** Symbol name. */
     char                szName[RTDBG_SYMBOL_NAME_LENGTH];
@@ -116 +150 @@
 
 /** Max length (including '\\0') of a debug info file name. */
-#define RTDBG_FILE_NAME_LENGTH   (260)
+#define RTDBG_FILE_NAME_LENGTH      (260)
 
 
@@ -134 +168 @@
     /** Line number. */
     uint32_t            uLineNo;
+    /** Symbol ordinal.
+     * This is set to UINT32_MAX if the ordinals aren't supported. */
+    uint32_t            iOrdinal;
     /** Filename. */
     char                szFilename[RTDBG_FILE_NAME_LENGTH];
@@ -418 +455 @@
  * @param   cb              The size of the symbol.
  * @param   fFlags          Symbol flags.
- */
-RTDECL(int) RTDbgAsSymbolAdd(RTDBGAS hDbgAs, const char *pszSymbol, RTUINTPTR Addr, RTUINTPTR cb, uint32_t fFlags);
+ * @param   piOrdinal       Where to return the symbol ordinal on success. If
+ *                          the interpreter doesn't do ordinals, this will be set to
+ *                          UINT32_MAX. Optional
+ */
+RTDECL(int) RTDbgAsSymbolAdd(RTDBGAS hDbgAs, const char *pszSymbol, RTUINTPTR Addr, RTUINTPTR cb, uint32_t fFlags, uint32_t *piOrdinal);
 
 /**
@@ -491 +531 @@
  */
 RTDECL(int) RTDbgAs(RTDBGAS hDbgAs, RTUINTPTR Addr, PRTINTPTR poffDisp, PRTDBGLINE pLine);
+
+/**
+ * Adds a line number to a module in the address space.
+ *
+ * @returns IPRT status code. See RTDbgModSymbolAdd for more specific ones.
+ * @retval  VERR_INVALID_HANDLE if hDbgAs is invalid.
+ * @retval  VERR_NOT_FOUND if no module was found at the specified address.
+ * @retval  VERR_NOT_SUPPORTED if the module interpret doesn't support adding
+ *          custom symbols.
+ *
+ * @param   hDbgAs          The address space handle.
+ * @param   pszFile         The file name.
+ * @param   uLineNo         The line number.
+ * @param   Addr            The address of the symbol.
+ * @param   piOrdinal       Where to return the line number ordinal on success.
+ *                          If the interpreter doesn't do ordinals, this will be
+ *                          set to UINT32_MAX. Optional.
+ */
+RTDECL(int) RTDbgAsLineAdd(RTDBGAS hDbgAs, const char *pszFile, uint32_t uLineNo, RTUINTPTR Addr, uint32_t *piOrdinal);
 
 /**
@@ -524 +583 @@
 RTDECL(const char *) RTDbgModName(RTDBGMOD hDbgMod);
 RTDECL(RTUINTPTR)   RTDbgModImageSize(RTDBGMOD hDbgMod);
+
+RTDECL(int)         RTDbgModSegmentAdd(RTDBGMOD hDbgMod, RTUINTPTR uRva, RTUINTPTR cb, const char *pszName, size_t cchName, uint32_t fFlags, PRTDBGSEGIDX piSeg);
+RTDECL(RTDBGSEGIDX) RTDbgModSegmentCount(RTDBGMOD hDbgMod);
+RTDECL(int)         RTDbgModSegmentByIndex(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, PRTDBGSEGMENT pSegInfo);
 RTDECL(RTUINTPTR)   RTDbgModSegmentSize(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg);
 RTDECL(RTUINTPTR)   RTDbgModSegmentRva(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg);
-RTDECL(RTDBGSEGIDX) RTDbgModSegmentCount(RTDBGMOD hDbgMod);
-
-RTDECL(int)         RTDbgModSymbolAdd(RTDBGMOD hDbgMod, const char *pszSymbol, RTDBGSEGIDX iSeg, RTUINTPTR off, RTUINTPTR cb, uint32_t fFlags);
+
+RTDECL(int)         RTDbgModSymbolAdd(RTDBGMOD hDbgMod, const char *pszSymbol, RTDBGSEGIDX iSeg, RTUINTPTR off, RTUINTPTR cb, uint32_t fFlags, uint32_t *piOrdinal);
 RTDECL(uint32_t)    RTDbgModSymbolCount(RTDBGMOD hDbgMod);
 RTDECL(int)         RTDbgModSymbolByIndex(RTDBGMOD hDbgMod, uint32_t iSymbol, PRTDBGSYMBOL pSymbol);
@@ -536 +598 @@
 RTDECL(int)         RTDbgModSymbolByNameA(RTDBGMOD hDbgMod, const char *pszSymbol, PRTDBGSYMBOL *ppSymbol);
 
-RTDECL(int)         RTDbgModLineAdd(RTDBGMOD hDbgMod, const char *pszFile, uint32_t uLineNo, RTDBGSEGIDX iSeg, RTUINTPTR off);
+RTDECL(int)         RTDbgModLineAdd(RTDBGMOD hDbgMod, const char *pszFile, uint32_t uLineNo, RTDBGSEGIDX iSeg, RTUINTPTR off, uint32_t *piOrdinal);
 RTDECL(int)         RTDbgModLineByAddr(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE pLine);
 RTDECL(int)         RTDbgModLineByAddrA(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE *ppLine);