Changeset 3528 for trunk/kDbg/kDbgModule.cpp

Timestamp:

Aug 20, 2007, 4:43:13 AM (18 years ago)

Author:

bird

Message:

Some refactoring and OS abstraction by instroducing kDbgHlp.

File:

• trunk/kDbg/kDbgModule.cpp (copied) (copied from trunk/kProfile/dbgmodule.cpp ) (11 diffs, 2 props)

trunk/kDbg/kDbgModule.cpp

@@ -1 @@
-/* $Id: $ */
+/* $Id$ */
 /** @file
- *
- * kProfile Mark 2 - Debug Info Reader
- *
- * Copyright (c) 2006 knut st. osmundsen <bird-src-spam@anduin.net.de>
- *
+ * kDbg - The Debug Info Reader, Module API.
+ */
+
+/*
+ * Copyright (c) 2006-2007 knut st. osmundsen <bird-src-spam@anduin.net>
  *
  * This file is part of kLIBC.
@@ -29 +29 @@
 *   Header Files                                                               *
 *******************************************************************************/
-#ifdef KDBG_USE_IPRT
-# include <iprt/file.h>
-# include <iprt/string.h>
-# include <iprt/err.h>
-# include <iprt/assert.h>
-# include <iprt/alloc.h>
-#else
-#endif
-
-#include "kDbgBase.h"
-#include "DBGInternal.h"
+#include "kDbg.h"
+#include "kDbgInternal.h"
+
 #include <kLdrModMZ.h>
 #include <kLdrModPE.h>
@@ -52 +44 @@
  * @param   ppDbgMod            Where to store the debug module handle.
  */
-RTDECL(int) RTDbgModuleOpen(const char *pszModulePath, PRTDBGMOD *ppDbgMod)
+KDBG_DECL(int) kDbgModuleOpen(const char *pszModulePath, PKDBGMOD *ppDbgMod)
 {
     /*
      * Validate input.
      */
-    AssertMsgReturn(VALID_PTR(pszModulePath), ("%p\n", pszModulePath), VERR_INVALID_POINTER);
-    AssertMsgReturn(*pszModulePath, ("%p\n", pszModulePath), VERR_INVALID_PARAMETER);
-    AssertMsgReturn(VALID_PTR(ppDbgMod), ("%p\n", ppDbgMod), VERR_INVALID_POINTER);
+    kDbgAssertPtrReturn(pszModulePath, KDBG_ERR_INVALID_POINTER);
+    kDbgAssertMsgReturn(*pszModulePath, ("%p\n", pszModulePath), KDBG_ERR_INVALID_PARAMETER);
+    kDbgAssertPtrReturn(ppDbgMod, KDBG_ERR_INVALID_POINTER);
     *ppDbgMod = NULL;
 
@@ -65 +57 @@
      * The file and try figure out the format.
      */
-    RTFILE File;
-    int rc = RTFileOpen(&File, pszModulePath, RTFILE_O_READ | RTFILE_O_DENY_WRITE | RTFILE_O_OPEN);
-    if (RT_FAILURE(rc))
+    PKDBGHLPFILE pFile;
+    int rc = kDbgHlpOpenRO(pszModulePath, &pFile);
+    if (rc)
         return rc;
 
-    RTFOFF offHdr = 0;
+    int64_t offHdr = 0;
     union
     {
@@ -77 +69 @@
         uint8_t     ab[16];
     } Buf;
-    rc = RTFileRead(File, &Buf, sizeof(Buf), NULL);
-    if (    RT_SUCCESS(rc)
+    rc = kDbgHlpRead(pFile, &Buf, sizeof(Buf));
+    if (    !rc
         &&  Buf.au16[0] == IMAGE_DOS_SIGNATURE)
     {
         /* new header? */
         uint32_t offNewHeader;
-        rc = RTFileReadAt(File, KDBG_OFFSETOF(IMAGE_DOS_HEADER, e_lfanew), &offNewHeader, sizeof(offNewHeader), NULL);
-        if (RT_SUCCESS(rc) && offNewHeader)
+        rc = kDbgHlpReadAt(pFile, KDBG_OFFSETOF(IMAGE_DOS_HEADER, e_lfanew), &offNewHeader, sizeof(offNewHeader));
+        if (!rc && offNewHeader)
         {
             offHdr = offNewHeader;
-            rc = RTFileReadAt(File, offNewHeader, &Buf, sizeof(Buf), NULL);
+            rc = kDbgHlpReadAt(pFile, offNewHeader, &Buf, sizeof(Buf));
         }
     }
-    if (RT_SUCCESS(rc))
+    if (!rc)
     {
         if (Buf.au16[0] == IMAGE_DOS_SIGNATURE)
-            rc = VERR_NOT_SUPPORTED;
+            rc = KDBG_ERR_FORMAT_NOT_SUPPORTED;
 #ifdef IMAGE_NE_SIGNATURE
         else if (Buf.au16[0] == IMAGE_NE_SIGNATURE)
-            rc = VERR_NOT_SUPPORTED;
+            rc = KDBG_ERR_FORMAT_NOT_SUPPORTED;
 #endif
 #ifdef IMAGE_LX_SIGNATURE
         else if (Buf.au16[0] == IMAGE_LX_SIGNATURE)
-            rc = VERR_NOT_SUPPORTED;
+            rc = KDBG_ERR_FORMAT_NOT_SUPPORTED;
 #endif
 #ifdef IMAGE_LE_SIGNATURE
         else if (Buf.au16[0] == IMAGE_LE_SIGNATURE)
-            rc = VERR_NOT_SUPPORTED;
+            rc = KDBG_ERR_FORMAT_NOT_SUPPORTED;
 #endif
 #ifdef IMAGE_ELF_SIGNATURE
         else if (Buf.au32[0] == IMAGE_ELF_SIGNATURE)
-            rc = VERR_NOT_SUPPORTED;
+            rc = KDBG_ERR_FORMAT_NOT_SUPPORTED;
 #endif
 #ifdef IMAGE_NT_SIGNATURE
         else if (Buf.au32[0] == IMAGE_NT_SIGNATURE)
-            rc = rtDbgModPEOpen(File, offHdr, pszModulePath, ppDbgMod);
+            rc = kdbgModPEOpen(pFile, offHdr, pszModulePath, ppDbgMod);
 #endif
         /** @todo there are a number of text file formats too which I want to support. */
         else
-            rc = VERR_NOT_SUPPORTED;
-
-    }
-
-    if (RT_FAILURE(rc))
-        RTFileClose(File);
+            rc = KDBG_ERR_UNKOWN_FORMAT;
+    }
+
+    if (rc)
+        kDbgHlpClose(pFile);
     return rc;
 }
@@ -133 +124 @@
  * @param   pMod        The debug module handle.
  */
-DECLINLINE(bool) rtDbgModIsValid(PRTDBGMOD pMod)
-{
-    AssertMsgReturn(VALID_PTR(pMod), ("%p", pMod), false);
-    AssertMsgReturn(pMod->u32Magic == RTDBGMOD_MAGIC, ("%RX32", pMod->u32Magic), false);
-    AssertMsgReturn(VALID_PTR(pMod->pOps), ("%p", pMod->pOps), false);
+KDBG_INLINE(bool) kdbgModIsValid(PKDBGMOD pMod)
+{
+    kDbgAssertPtrReturn(pMod, false);
+    kDbgAssertMsgReturn(pMod->u32Magic == KDBGMOD_MAGIC, ("%#x", pMod->u32Magic), false);
+    kDbgAssertPtrReturn(pMod->pOps, false);
     return true;
 }
@@ -148 +139 @@
  * @param   pMod        The module handle.
  */
-RTDECL(int) RTDbgModuleClose(PRTDBGMOD pMod)
-{
-    if (!rtDbgModIsValid(pMod))
-        return VERR_INVALID_PARAMETER;
+KDBG_DECL(int) kDbgModuleClose(PKDBGMOD pMod)
+{
+    if (!kdbgModIsValid(pMod))
+        return KDBG_ERR_INVALID_PARAMETER;
 
     int rc = pMod->pOps->pfnClose(pMod);
-    if (RT_SUCCESS(rc))
-        RTMemFree(pMod);
+    if (!rc)
+        kDbgHlpFree(pMod);
     return rc;
 }
@@ -173 +164 @@
  * @param   pSym        Where to store the symbol details.
  */
-RTDECL(int) RTDbgModuleQuerySymbol(PRTDBGMOD pMod, int32_t iSegment, RTUINTPTR off, PRTDBGSYMBOL pSym)
-{
-    if (!rtDbgModIsValid(pMod))
-        return VERR_INVALID_PARAMETER;
-    AssertMsgReturn(VALID_PTR(pSym), ("%p", pSym), VERR_INVALID_POINTER);
+KDBG_DECL(int) kDbgModuleQuerySymbol(PKDBGMOD pMod, int32_t iSegment, KDBGADDR off, PKDBGSYMBOL pSym)
+{
+    if (!kdbgModIsValid(pMod))
+        return KDBG_ERR_INVALID_PARAMETER;
+    kDbgAssertPtrReturn(pSym, KDBG_ERR_INVALID_POINTER);
 
     return pMod->pOps->pfnQuerySymbol(pMod, iSegment, off, pSym);
@@ -195 +186 @@
  * @param   off         The offset into the segment.
  * @param   ppSym       Where to store the pointer to the symbol info.
- *                      Free the returned symbol using RTDbgSymbolFree().
- */
-RTDECL(int) RTDbgModuleQuerySymbolA(PRTDBGMOD pMod, int32_t iSegment, RTUINTPTR off, PPRTDBGSYMBOL ppSym)
-{
-    AssertMsgReturn(VALID_PTR(ppSym), ("%p\n", ppSym), VERR_INVALID_POINTER);
-
-    RTDBGSYMBOL Sym;
-    int rc = RTDbgModuleQuerySymbol(pMod, iSegment, off, &Sym);
-    if (RT_SUCCESS(rc))
-    {
-        *ppSym = RTDbgSymbolDup(&Sym);
+ *                      Free the returned symbol using kDbgSymbolFree().
+ */
+KDBG_DECL(int) kDbgModuleQuerySymbolA(PKDBGMOD pMod, int32_t iSegment, KDBGADDR off, PPKDBGSYMBOL ppSym)
+{
+    kDbgAssertPtrReturn(ppSym, KDBG_ERR_INVALID_POINTER);
+
+    KDBGSYMBOL Sym;
+    int rc = kDbgModuleQuerySymbol(pMod, iSegment, off, &Sym);
+    if (!rc)
+    {
+        *ppSym = kDbgSymbolDup(&Sym);
         if (!*ppSym)
-            rc = VERR_NO_MEMORY;
+            rc = KDBG_ERR_NO_MEMORY;
     }
     else
@@ -228 +219 @@
  * @param   pLine       Where to store the line number details.
  */
-RTDECL(int) RTDbgModuleQueryLine(PRTDBGMOD pMod, int32_t iSegment, RTUINTPTR off, PRTDBGLINE pLine)
-{
-    if (!rtDbgModIsValid(pMod))
-        return VERR_INVALID_PARAMETER;
-    AssertMsgReturn(VALID_PTR(pLine), ("%p", pLine), VERR_INVALID_POINTER);
+KDBG_DECL(int) kDbgModuleQueryLine(PKDBGMOD pMod, int32_t iSegment, KDBGADDR off, PKDBGLINE pLine)
+{
+    if (!kdbgModIsValid(pMod))
+        return KDBG_ERR_INVALID_PARAMETER;
+    kDbgAssertPtrReturn(pLine, KDBG_ERR_INVALID_POINTER);
 
     return pMod->pOps->pfnQueryLine(pMod, iSegment, off, pLine);
@@ -250 +241 @@
  * @param   off         The offset into the segment.
  * @param   ppLine      Where to store the pointer to the line number info.
- *                      Free the returned line number using RTDbgLineFree().
- */
-RTDECL(int) RTDbgModuleQueryLineA(PRTDBGMOD pMod, int32_t iSegment, RTUINTPTR off, PPRTDBGLINE ppLine)
-{
-    AssertMsgReturn(VALID_PTR(ppLine), ("%p\n", ppLine), VERR_INVALID_POINTER);
-
-    RTDBGLINE Line;
-    int rc = RTDbgModuleQueryLine(pMod, iSegment, off, &Line);
-    if (RT_SUCCESS(rc))
-    {
-        *ppLine = RTDbgLineDup(&Line);
+ *                      Free the returned line number using kDbgLineFree().
+ */
+KDBG_DECL(int) kDbgModuleQueryLineA(PKDBGMOD pMod, int32_t iSegment, KDBGADDR off, PPKDBGLINE ppLine)
+{
+    kDbgAssertPtrReturn(ppLine, KDBG_ERR_INVALID_POINTER);
+
+    KDBGLINE Line;
+    int rc = kDbgModuleQueryLine(pMod, iSegment, off, &Line);
+    if (!rc)
+    {
+        *ppLine = kDbgLineDup(&Line);
         if (!*ppLine)
-            rc = VERR_NO_MEMORY;
+            rc = KDBG_ERR_NO_MEMORY;
     }
     else