Changeset 34902 in vbox for trunk/src/VBox

Timestamp:

Dec 9, 2010 4:16:51 PM (14 years ago)

Author:

vboxsync

Message:

IMachineDebugger::dumpGuestCore: Added DBGFR3CoreWrite interface.

Location:

trunk/src/VBox

Files:

• Debugger/DBGCCommands.cpp (modified) (1 diff)
• Debugger/testcase/tstDBGCStubs.cpp (modified) (1 diff)
• Devices/VMMDev/VMMDev.cpp (modified) (1 diff)
• Main/MachineDebuggerImpl.cpp (modified) (2 diffs)
• Main/idl/VirtualBox.xidl (modified) (2 diffs)
• Main/include/MachineDebuggerImpl.h (modified) (1 diff)
• VMM/DBGFCoreWrite.cpp (modified) (8 diffs)

trunk/src/VBox/Debugger/DBGCCommands.cpp

@@ -2112 +2112 @@
         return DBGCCmdHlpFail(pCmdHlp, pCmd, "Missing file path.\n");
 
-    int rc = DBGFR3CoreWrite(pVM, pszDumpPath);
+    int rc = DBGFR3CoreWrite(pVM, pszDumpPath, true /*fReplaceFile*/);
     if (RT_FAILURE(rc))
         return DBGCCmdHlpFail(pCmdHlp, pCmd, "DBGFR3WriteCore failed. rc=%Rrc\n", rc);

trunk/src/VBox/Debugger/testcase/tstDBGCStubs.cpp

@@ -237 +237 @@
 }
 
-VMMR3DECL(int) DBGFR3CoreWrite(PVM pVM, const char *pszDumpPath)
+VMMR3DECL(int) DBGFR3CoreWrite(PVM pVM, const char *pszFilename, bool fReplaceFile)
 {
     return VERR_INTERNAL_ERROR;

trunk/src/VBox/Devices/VMMDev/VMMDev.cpp

@@ -581 +581 @@
                      */
                     PVM pVM = PDMDevHlpGetVM(pDevIns);
-                    pRequestHeader->rc = DBGFR3CoreWrite(pVM, szCorePath);
+                    pRequestHeader->rc = DBGFR3CoreWrite(pVM, szCorePath, true /*fReplaceFile*/);
                 }
                 else

trunk/src/VBox/Main/MachineDebuggerImpl.cpp

@@ -718 +718 @@
 
 /**
- * Set the new patch manager enabled flag.
- *
- * @returns COM status code
- * @param   new patch manager enabled flag
+ * Injects an NMI.
+ *
+ * @returns COM status code
  */
 STDMETHODIMP MachineDebugger::InjectNMI()
@@ -738 +737 @@
 
     return S_OK;
+}
+
+/**
+ * Triggers a guest core dump.
+ *
+ * @returns COM status code
+ * @param
+ */
+STDMETHODIMP MachineDebugger::DumpGuestCore(IN_BSTR a_bstrFilename)
+{
+    CheckComArgStrNotEmptyOrNull(a_bstrFilename);
+    Utf8Str strFilename(a_bstrFilename);
+
+    AutoCaller autoCaller(this);
+    HRESULT hrc = autoCaller.rc();
+    if (SUCCEEDED(hrc))
+    {
+        AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+        Console::SafeVMPtr ptrVM(mParent);
+        hrc = ptrVM.rc();
+        if (SUCCEEDED(hrc))
+        {
+            int vrc = DBGFR3CoreWrite(ptrVM, strFilename.c_str(), false /*fReplaceFile*/);
+            if (RT_SUCCESS(vrc))
+                hrc = S_OK;
+            else
+                hrc = setError(E_FAIL, tr("DBGFR3CoreWrite failed with %Rrc"), vrc);
+        }
+    }
+
+    return hrc;
 }
 

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -11875 +11875 @@
   <interface
     name="IMachineDebugger" extends="$unknown"
-    uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
+    uuid="373a5f51-67c1-4a31-be43-1e29ebe8ef85"
     wsmap="suppress"
     >
@@ -11915 +11915 @@
         Inject an NMI into a running VT-x/AMD-V VM.
       </desc>
+    </method>
+
+    <method name="dumpGuestCore">
+      <desc>
+        Takes a core dump of the guest.
+
+        See include/VBox/dbgfcorefmt.h for details on the file format.
+      </desc>
+      <param name="filename" type="wstring" dir="in">
+        <desc>
+          The name of the output file.  The file must not exist.
+        </desc>
+      </param>
     </method>
 

trunk/src/VBox/Main/include/MachineDebuggerImpl.h

@@ -73 +73 @@
     STDMETHOD(COMGETTER(VM)) (LONG64 *aVm);
     STDMETHOD(InjectNMI)();
+    STDMETHOD(DumpGuestCore)(IN_BSTR a_bstrFilename);
 
     // IMachineDebugger methods

trunk/src/VBox/VMM/DBGFCoreWrite.cpp

@@ -67 +67 @@
 #include "../Runtime/include/internal/ldrELF64.h"
 
+
 /*******************************************************************************
 *   Defined Constants And Macros                                               *
@@ -76 +77 @@
 #define DBGFLOG_NAME           "DBGFCoreWrite"
 
+
+/*******************************************************************************
+*   Global Variables                                                           *
+*******************************************************************************/
 static const int s_NoteAlign  = 8;
 static const int s_cbNoteName = 16;
@@ -84 +89 @@
 
 
-/**
- * DBGFCOREDATA: Core data.
- */
-typedef struct
-{
-    const char *pszDumpPath;    /* File path to dump the core into. */
-} DBGFCOREDATA, *PDBGFCOREDATA;
+/*******************************************************************************
+*   Structures and Typedefs                                                    *
+*******************************************************************************/
+/**
+ * Guest core writer data.
+ *
+ * Used to pass parameters from DBGFR3CoreWrite to dbgfR3CoreWriteRendezvous.
+ */
+typedef struct DBGFCOREDATA
+{
+    /** The name of the file to write the file to. */
+    const char *pszFilename;
+    /** Whether to replace (/overwrite) any existing file. */
+    bool        fReplaceFile;
+} DBGFCOREDATA;
+/** Pointer to the guest core writer data.  */
+typedef DBGFCOREDATA *PDBGFCOREDATA;
+
+
 
 /**
@@ -299 +316 @@
  * @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)
+static int dbgfR3CoreWriteWorker(PVM pVM, RTFILE hFile)
 {
     /*
@@ -487 +503 @@
  * @return VBox status code.
  */
-static DECLCALLBACK(VBOXSTRICTRC) dbgfR3CoreWrite(PVM pVM, PVMCPU pVCpu, void *pvData)
+static DECLCALLBACK(VBOXSTRICTRC) dbgfR3CoreWriteRendezvous(PVM pVM, PVMCPU pVCpu, void *pvData)
 {
     /*
@@ -501 +517 @@
      * Create the core file.
      */
-    RTFILE hFile;
-    int rc = RTFileOpen(&hFile, pDbgfData->pszDumpPath, RTFILE_O_WRITE | RTFILE_O_CREATE_REPLACE | RTFILE_O_DENY_WRITE);
+    uint32_t fFlags = (pDbgfData->fReplaceFile ? RTFILE_O_CREATE_REPLACE : RTFILE_O_CREATE)
+                    | RTFILE_O_WRITE
+                    | RTFILE_O_DENY_ALL
+                    | (0600 << RTFILE_O_CREATE_MODE_SHIFT);
+    RTFILE   hFile;
+    int rc = RTFileOpen(&hFile, pDbgfData->pszFilename, fFlags);
     if (RT_SUCCESS(rc))
     {
-        rc = dbgfR3CoreWriteWorker(pVM, pDbgfData, hFile);
+        rc = dbgfR3CoreWriteWorker(pVM, hFile);
         RTFileClose(hFile);
     }
     else
-        LogRel((DBGFLOG_NAME ": RTFileOpen failed for '%s' rc=%Rrc\n", pDbgfData->pszDumpPath, rc));
+        LogRel((DBGFLOG_NAME ": RTFileOpen failed for '%s' rc=%Rrc\n", pDbgfData->pszFilename, rc));
     return rc;
 }
@@ -517 +537 @@
  * Write core dump of the guest.
  *
- * @return VBox status code.
+ * @returns VBox status code.
  * @param   pVM                 The VM handle.
- * @param   pszDumpPath         The path of the file to dump into, cannot be
- *                              NULL.
- *
- * @remarks The VM must be suspended before calling this function.
- */
-VMMR3DECL(int) DBGFR3CoreWrite(PVM pVM, const char *pszDumpPath)
+ * @param   pszFilename         The name of the file to which the guest core
+ *                              dump should be written.
+ * @param   fReplaceFile        Whether to replace the file or not.
+ *
+ * @remarks The VM should be suspended before calling this function or DMA may
+ *          interfer with the state.
+ */
+VMMR3DECL(int) DBGFR3CoreWrite(PVM pVM, const char *pszFilename, bool fReplaceFile)
 {
     VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
-    AssertReturn(pszDumpPath, VERR_INVALID_HANDLE);
+    AssertReturn(pszFilename, VERR_INVALID_HANDLE);
 
     /*
@@ -536 +558 @@
     DBGFCOREDATA CoreData;
     RT_ZERO(CoreData);
-    CoreData.pszDumpPath = pszDumpPath;
-
-    int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, dbgfR3CoreWrite, &CoreData);
+    CoreData.pszFilename  = pszFilename;
+    CoreData.fReplaceFile = fReplaceFile;
+
+    int rc = VMMR3EmtRendezvous(pVM, VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE, dbgfR3CoreWriteRendezvous, &CoreData);
     if (RT_SUCCESS(rc))
-        LogRel((DBGFLOG_NAME ": Successfully wrote guest core dump %s\n", pszDumpPath));
+        LogRel((DBGFLOG_NAME ": Successfully wrote guest core dump '%s'\n", pszFilename));
     else
-        LogRel((DBGFLOG_NAME ": Failed to write guest core dump %s. rc=%Rrc\n", pszDumpPath, rc));
+        LogRel((DBGFLOG_NAME ": Failed to write guest core dump '%s'. rc=%Rrc\n", pszFilename, rc));
     return rc;
 }