Changeset 34134 in vbox for trunk

Timestamp:

Nov 17, 2010 9:39:35 AM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

67852

Message:

DBGFCoreWrite.cpp: Eliminated unnecessary gotos.

File:

• trunk/src/VBox/VMM/DBGFCoreWrite.cpp (modified) (17 diffs)

trunk/src/VBox/VMM/DBGFCoreWrite.cpp

@@ -16 +16 @@
  */
 
-/*
- * VBox VMCore Format:
+/** @page pg_dbgf_vmcore    VMCore Format
+ *
+ * The VirtualBox VMCore Format:
  * [ ELF 64 Header]  -- Only 1
  *
  * [ PT_NOTE ]       -- Only 1
  *    - Offset into CoreDescriptor followed by list of Notes (Note Hdr + data) of VBox CPUs.
- *    - (Any Additional custom Note sections)
+ *    - (Any Additional custom Note sections).
  *
  * [ PT_LOAD ]       -- One for each contiguous memory chunk
- *    - Memory offset
- *    - File offset
+ *    - Memory offset (physical).
+ *    - File offset.
  *
  * CoreDescriptor
- *    - Magic, VBox version
- *    - Number of CPus
+ *    - Magic, VBox version.
+ *    - Number of CPus.
  *
  * Per-CPU register dump
- *    - CPU 1 Note Hdr + Data
- *    - CPU 2 Note Hdr + Data
+ *    - CPU 1 Note Hdr + Data.
+ *    - CPU 2 Note Hdr + Data.
  *    ...
  * (Additional custom notes Hdr+data)
- *    - VBox 1 Note Hdr + Data
- *    - VBox 2 Note Hdr + Data
+ *    - VBox 1 Note Hdr + Data.
+ *    - VBox 2 Note Hdr + Data.
  *    ...
  * Memory dump
@@ -114 +115 @@
     ElfHdr.e_version         = EV_CURRENT;
     ElfHdr.e_ident[EI_CLASS] = ELFCLASS64;
-    /* 32-bit VMs will produce cores with e_machine EM_386. */
+    /* 32-bit builds will produce cores with e_machine EM_386. */
 #ifdef RT_ARCH_AMD64
     ElfHdr.e_machine         = EM_X86_64;
@@ -149 +150 @@
  * @return IPRT status code.
  */
-static int Elf64WriteProgHdr(RTFILE hFile, uint32_t Type, uint32_t fFlags, uint64_t offFileData, uint64_t cbFileData, uint64_t cbMemData,
-                             RTGCPHYS Phys, uint64_t *pcbProgHdr)
+static int Elf64WriteProgHdr(RTFILE hFile, uint32_t Type, uint32_t fFlags, uint64_t offFileData, uint64_t cbFileData,
+                             uint64_t cbMemData, RTGCPHYS Phys, uint64_t *pcbProgHdr)
 {
     Elf64_Phdr ProgHdr;
@@ -306 +307 @@
 
 /**
- * EMT Rendezvous worker function for DBGFR3CoreWrite.
- *
- * @param   pVM              The VM handle.
- * @param   pVCpu            The handle of the calling VCPU.
- * @param   pvData           Opaque data.
- *
- * @return VBox status code.
- */
-static DECLCALLBACK(VBOXSTRICTRC) dbgfR3CoreWrite(PVM pVM, PVMCPU pVCpu, void *pvData)
-{
-    /*
-     * Validate input.
-     */
-    AssertReturn(pVM, VERR_INVALID_VM_HANDLE);
-    AssertReturn(pVCpu, VERR_INVALID_VMCPU_HANDLE);
-    AssertReturn(pvData, VERR_INVALID_POINTER);
-
-    PDBGFCOREDATA pDbgfData = (PDBGFCOREDATA)pvData;
-
+ * Worker function for dbgfR3CoreWrite which does the writing.
+ *
+ * @returns VBox status code
+ * @param   pVM                 The VM handle.
+ * @param   pDbgfData           The core dump parameters.
+ * @param   hFile               The file to write to.  Caller closes this.
+ */
+static int dbgfR3CoreWriteWorker(PVM pVM, PDBGFCOREDATA pDbgfData, RTFILE hFile)
+{
     /*
      * Collect core information.
@@ -351 +342 @@
 
     /*
-     * Create the core file.
-     */
-    RTFILE hFile = NIL_RTFILE;
-    int rc = RTFileOpen(&hFile, pDbgfData->pszDumpPath, RTFILE_O_CREATE_REPLACE | RTFILE_O_READWRITE);
-    if (RT_FAILURE(rc))
-    {
-        LogRel((DBGFLOG_NAME ": RTFileOpen failed for '%s' rc=%Rrc\n", pDbgfData->pszDumpPath, rc));
-        return rc;
-    }
-
-    /*
      * Write ELF header.
      */
@@ -367 +347 @@
     uint64_t cbProgHdr = 0;
     uint64_t offMemRange = 0;
-    rc = Elf64WriteElfHdr(hFile, cProgHdrs, 0 /* cSecHdrs */, &cbElfHdr);
+    int rc = Elf64WriteElfHdr(hFile, cProgHdrs, 0 /* cSecHdrs */, &cbElfHdr);
     off += cbElfHdr;
     if (RT_FAILURE(rc))
     {
         LogRel((DBGFLOG_NAME ": Elf64WriteElfHdr failed. rc=%Rrc\n", rc));
-        goto CoreWriteDone;
+        return rc;
     }
 
@@ -390 +370 @@
     {
         LogRel((DBGFLOG_NAME ": Elf64WritreProgHdr failed for PT_NOTE. rc=%Rrc\n", rc));
-        goto CoreWriteDone;
+        return rc;
     }
 
@@ -396 +376 @@
      * Write PT_LOAD program header for each memory range.
      */
-    offMemRange = off + cbNoteSection;
+    offMemRange = off + cbNoteSection;  /** @todo this isn't taking the cmemRanges of prog hdrs into account. */
     for (uint16_t iRange = 0; iRange < cMemRanges; iRange++)
     {
@@ -407 +387 @@
         {
             LogRel((DBGFLOG_NAME ": PGMR3PhysGetRange failed for iRange(%u) rc=%Rrc\n", iRange, rc));
-            goto CoreWriteDone;
+            return rc;
         }
 
@@ -414 +394 @@
 
         Log((DBGFLOG_NAME ": PGMR3PhysGetRange iRange=%u GCPhysStart=%#x GCPhysEnd=%#x cbMemRange=%u\n",
-                iRange, GCPhysStart, GCPhysEnd, cbMemRange));
+             iRange, GCPhysStart, GCPhysEnd, cbMemRange));
 
         rc = Elf64WriteProgHdr(hFile, PT_LOAD, PF_R,
@@ -427 +407 @@
             LogRel((DBGFLOG_NAME ": Elf64WriteProgHdr failed for memory range(%u) cbFileRange=%u cbMemRange=%u rc=%Rrc\n", iRange,
                     cbFileRange, cbMemRange, rc));
-            goto CoreWriteDone;
+            return rc;
         }
 
@@ -441 +421 @@
     {
         LogRel((DBGFLOG_NAME ": Elf64WriteNoteHdr failed for Note '%s' rc=%Rrc\n", s_pcszCoreVBoxCore, rc));
-        goto CoreWriteDone;
+        return rc;
     }
 
@@ -454 +434 @@
         {
             LogRel((DBGFLOG_NAME ": Elf64WriteNoteHdr failed for vCPU[%u] rc=%Rrc\n", iCpu, rc));
-            goto CoreWriteDone;
+            return rc;
         }
     }
@@ -470 +450 @@
         {
             LogRel((DBGFLOG_NAME ": PGMR3PhysGetRange(2) failed for iRange(%u) rc=%Rrc\n", iRange, rc));
-            goto CoreWriteDone;
+            return rc;
         }
 
@@ -488 +468 @@
             {
                 LogRel((DBGFLOG_NAME ": MMR3HeapAlloc failed. iRange=%u iPage=%u\n", iRange, iPage));
-                goto CoreWriteDone;
+                return rc;
             }
 
@@ -507 +487 @@
                 LogRel((DBGFLOG_NAME ": RTFileWrite failed. iRange=%u iPage=%u rc=%Rrc\n", iRange, iPage, rc));
                 MMR3HeapFree(pvBuf);
-                goto CoreWriteDone;
+                return rc;
             }
 
@@ -514 +494 @@
     }
 
-CoreWriteDone:
-    RTFileClose(hFile);
-
+    return rc;
+}
+
+
+/**
+ * EMT Rendezvous worker function for DBGFR3CoreWrite.
+ *
+ * @param   pVM              The VM handle.
+ * @param   pVCpu            The handle of the calling VCPU.
+ * @param   pvData           Opaque data.
+ *
+ * @return VBox status code.
+ */
+static DECLCALLBACK(VBOXSTRICTRC) dbgfR3CoreWrite(PVM pVM, PVMCPU pVCpu, void *pvData)
+{
+    /*
+     * Validate input.
+     */
+    AssertReturn(pVM, VERR_INVALID_VM_HANDLE);
+    AssertReturn(pVCpu, VERR_INVALID_VMCPU_HANDLE);
+    AssertReturn(pvData, VERR_INVALID_POINTER);
+
+    PDBGFCOREDATA pDbgfData = (PDBGFCOREDATA)pvData;
+
+    /*
+     * Create the core file.
+     */
+    RTFILE hFile;
+    int rc = RTFileOpen(&hFile, pDbgfData->pszDumpPath, RTFILE_O_CREATE_REPLACE | RTFILE_O_READWRITE);
+    if (RT_SUCCESS(rc))
+    {
+        rc = dbgfR3CoreWriteWorker(pVM, pDbgfData, hFile);
+        RTFileClose(hFile);
+    }
+    else
+        LogRel((DBGFLOG_NAME ": RTFileOpen failed for '%s' rc=%Rrc\n", pDbgfData->pszDumpPath, rc));
     return rc;
 }