Changeset 73494 in vbox for trunk/include/iprt

Timestamp:

Aug 4, 2018 7:41:30 PM (6 years ago)

Author:

vboxsync

Message:

IPRT: Added single stack frame unwind function to RTDbgMod and RTLdr, copying over the PoC from DBGFRStack.cpp. bugref:3897

Location:

trunk/include/iprt

Files:

• dbg.h (modified) (7 diffs)
• err.h (modified) (1 diff)
• ldr.h (modified) (1 diff)
• mangling.h (modified) (2 diffs)

trunk/include/iprt/dbg.h

@@ -34 +34 @@
 RT_C_DECLS_BEGIN
 
-# ifdef IN_RING3
 
 /** @defgroup grp_rt_dbg    RTDbg - Debugging Routines
@@ -275 +274 @@
 } RTDBGUNWINDSTATE;
 
+/**
+ * Try read a 16-bit value off the stack.
+ *
+ * @returns pfnReadStack result.
+ * @param   pThis           The unwind state.
+ * @param   uSrcAddr        The stack address.
+ * @param   puDst           The read destination.
+ */
+DECLINLINE(int) RTDbgUnwindLoadStackU16(PRTDBGUNWINDSTATE pThis, RTUINTPTR uSrcAddr, uint16_t *puDst)
+{
+    return pThis->pfnReadStack(pThis, uSrcAddr, sizeof(*puDst), puDst);
+}
+
+/**
+ * Try read a 32-bit value off the stack.
+ *
+ * @returns pfnReadStack result.
+ * @param   pThis           The unwind state.
+ * @param   uSrcAddr        The stack address.
+ * @param   puDst           The read destination.
+ */
+DECLINLINE(int) RTDbgUnwindLoadStackU32(PRTDBGUNWINDSTATE pThis, RTUINTPTR uSrcAddr, uint32_t *puDst)
+{
+    return pThis->pfnReadStack(pThis, uSrcAddr, sizeof(*puDst), puDst);
+}
+
+/**
+ * Try read a 64-bit value off the stack.
+ *
+ * @returns pfnReadStack result.
+ * @param   pThis           The unwind state.
+ * @param   uSrcAddr        The stack address.
+ * @param   puDst           The read destination.
+ */
+DECLINLINE(int) RTDbgUnwindLoadStackU64(PRTDBGUNWINDSTATE pThis, RTUINTPTR uSrcAddr, uint64_t *puDst)
+{
+    return pThis->pfnReadStack(pThis, uSrcAddr, sizeof(*puDst), puDst);
+}
+
 
 
@@ -308 +346 @@
 typedef const RTDBGSYMBOL *PCRTDBGSYMBOL;
 
+
 /**
  * Allocate a new symbol structure.
@@ -385 +424 @@
 RTDECL(void)            RTDbgLineFree(PRTDBGLINE pLine);
 
+
+# ifdef IN_RING3
 
 /** @defgroup grp_rt_dbgcfg     RTDbgCfg - Debugging Configuration
@@ -659 +700 @@
 /** @} */
 
+# endif /* IN_RING3 */
 
 /** @} */
@@ -1105 +1147 @@
 
 
+# ifdef IN_RING3
 /** @defgroup grp_rt_dbgmod     RTDbgMod - Debug Module Interpreter
  * @{
@@ -1750 +1793 @@
  */
 RTDECL(int)         RTDbgModLineByAddrA(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTINTPTR poffDisp, PRTDBGLINE *ppLineInfo);
+
+/**
+ * Try use unwind information to unwind one frame.
+ *
+ * @returns IPRT status code.  Last informational status from stack reader callback.
+ * @retval  VERR_DBG_NO_UNWIND_INFO if the module contains no unwind information.
+ * @retval  VERR_DBG_UNWIND_INFO_NOT_FOUND if no unwind information was found
+ *          for the location given by iSeg:off.
+ *
+ * @param   hDbgMod             The module handle.
+ * @param   iSeg                The segment number of the program counter.
+ * @param   off                 The offset into @a iSeg.  Together with @a iSeg
+ *                              this corresponds to the RTDBGUNWINDSTATE::uPc
+ *                              value pointed to by @a pState.
+ * @param   pState              The unwind state to work.
+ *
+ * @sa      RTLdrUnwindFrame
+ */
+RTDECL(int)         RTDbgModUnwindFrame(RTDBGMOD hDbgMod, RTDBGSEGIDX iSeg, RTUINTPTR off, PRTDBGUNWINDSTATE pState);
+
 /** @} */
-
 # endif /* IN_RING3 */
+
 
 

trunk/include/iprt/err.h

@@ -1729 +1729 @@
 /** Internal processing error the CodeView debug information reader. */
 #define VERR_CV_IPE                             (-693)
+/** No unwind information was found. */
+#define VERR_DBG_NO_UNWIND_INFO                 (-694)
+/** No unwind information for the specified location. */
+#define VERR_DBG_UNWIND_INFO_NOT_FOUND          (-695)
+/** Malformed unwind information. */
+#define VERR_DBG_MALFORMED_UNWIND_INFO          (-696)
 /** @} */
 

trunk/include/iprt/ldr.h

@@ -1228 +1228 @@
 RTDECL(int) RTLdrHashImage(RTLDRMOD hLdrMod, RTDIGESTTYPE enmDigest, char *pszDigest, size_t cbDigest);
 
+/**
+ * Try use unwind information to unwind one frame.
+ *
+ * @returns IPRT status code.  Last informational status from stack reader callback.
+ * @retval  VERR_DBG_NO_UNWIND_INFO if the module contains no unwind information.
+ * @retval  VERR_DBG_UNWIND_INFO_NOT_FOUND if no unwind information was found
+ *          for the location given by iSeg:off.
+ *
+ * @param   hDbgMod             The module handle.
+ * @param   pvBits              Optional pointer to bits returned by
+ *                              RTLdrGetBits().  This can be utilized by some module
+ *                              interpreters to reduce memory consumption and file
+ *                              access.
+ * @param   iSeg                The segment number of the program counter.  UINT32_MAX if RVA.
+ * @param   off                 The offset into @a iSeg.  Together with @a iSeg
+ *                              this corresponds to the RTDBGUNWINDSTATE::uPc
+ *                              value pointed to by @a pState.
+ * @param   pState              The unwind state to work.
+ *
+ * @sa      RTDbgModUnwindFrame
+ */
+RTDECL(int) RTLdrUnwindFrame(RTLDRMOD hLdrMod, void const *pvBits, uint32_t iSeg, RTLDRADDR off, PRTDBGUNWINDSTATE pState);
+
 RT_C_DECLS_END
 

trunk/include/iprt/mangling.h

@@ -755 +755 @@
 # define RTDbgModSymbolByOrdinalA                       RT_MANGLER(RTDbgModSymbolByOrdinalA)
 # define RTDbgModSymbolCount                            RT_MANGLER(RTDbgModSymbolCount)
+# define RTDbgModUnwindFrame                            RT_MANGLER(RTDbgModUnwindFrame)
 # define RTDbgSymbolAlloc                               RT_MANGLER(RTDbgSymbolAlloc)
 # define RTDbgSymbolDup                                 RT_MANGLER(RTDbgSymbolDup)
@@ -1172 +1173 @@
 # define RTLdrSegOffsetToRva                            RT_MANGLER(RTLdrSegOffsetToRva)
 # define RTLdrSize                                      RT_MANGLER(RTLdrSize)
+# define RTLdrUnwindFrame                               RT_MANGLER(RTLdrUnwindFrame)
 # define RTLinuxCheckDevicePath                         RT_MANGLER(RTLinuxCheckDevicePath)
 # define RTLinuxCheckDevicePathV                        RT_MANGLER(RTLinuxCheckDevicePathV)