Changeset 89696 in vbox for trunk/src/VBox/Main

Timestamp:

Jun 15, 2021 9:53:06 AM (4 years ago)

Author:

vboxsync

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

145144

Message:

Main/MachineDebugger: Implement API for taking a guest sample, bugref:10025

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (2 diffs)
• include/MachineDebuggerImpl.h (modified) (4 diffs)
• src-client/MachineDebuggerImpl.cpp (modified) (4 diffs)

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

@@ -20584 +20584 @@
     uuid="00ae6af4-00a7-4104-0009-49bc00b2da80"
     wsmap="managed"
-    reservedMethods="16" reservedAttributes="16"
+    reservedMethods="15" reservedAttributes="16"
     >
     <method name="dumpGuestCore">
@@ -20972 +20972 @@
       <param name="msInterval" type="long long" dir="return">
         <desc>The interval the percentage was calculated over in milliseconds</desc>
+      </param>
+    </method>
+
+    <method name="takeGuestSample">
+      <desc>
+        Creates a sample report of the guest and emulated device activity.
+      </desc>
+      <param name="filename" type="wstring" dir="in">
+        <desc>The file to dump the report to.</desc>
+      </param>
+      <param name="usInterval" type="unsigned long" dir="in">
+        <desc>The sample interval.</desc>
+      </param>
+      <param name="usSampleTime" type="long long" dir="in">
+        <desc>The number of microseconds to sample.</desc>
+      </param>
+      <param name="progress" type="IProgress" dir="return">
+        <desc>The progress object on return.</desc>
       </param>
     </method>

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

@@ -27 +27 @@
 
 class Console;
+class Progress;
 
 class ATL_NO_VTABLE MachineDebugger :
@@ -134 +135 @@
                      com::Utf8Str &aStats);
     HRESULT getCPULoad(ULONG aCpuId, ULONG *aPctExecuting, ULONG *aPctHalted, ULONG *aPctOther, LONG64 *aMsInterval) RT_OVERRIDE;
+    HRESULT takeGuestSample(const com::Utf8Str &aFilename, ULONG aUsInterval, LONG64 aUsSampleTime, ComPtr<IProgress> &pProgress);
 
     // private methods
@@ -145 +147 @@
     typedef FNLOGGETSTR *PFNLOGGETSTR;
     HRESULT i_logStringProps(PRTLOGGER pLogger, PFNLOGGETSTR pfnLogGetStr, const char *pszLogGetStr, Utf8Str *pstrSettings);
+
+    static DECLCALLBACK(int) i_dbgfProgressCallback(void *pvUser, unsigned uPercentage);
 
     Console * const mParent;
@@ -160 +164 @@
     bool mFlushMode;
     /** @}  */
+
+    /** @name Sample report related things.
+     * @{ */
+    /** Sample report handle. */
+    DBGFSAMPLEREPORT        m_hSampleReport;
+    /** Progress object for the currently taken guest sample. */
+    ComObjPtr<Progress>     m_Progress;
+    /** Filename to dump the report to. */
+    com::Utf8Str            m_strFilename;
+    /** @} */
 };
 

trunk/src/VBox/Main/src-client/MachineDebuggerImpl.cpp

@@ -27 +27 @@
 #include "Global.h"
 #include "ConsoleImpl.h"
+#include "ProgressImpl.h"
 
 #include "AutoCaller.h"
@@ -94 +95 @@
     mFlushMode = false;
 
+    m_hSampleReport = NULL;
+
     /* Confirm a successful initialization */
     autoInitSpan.setSucceeded();
@@ -115 +118 @@
     unconst(mParent) = NULL;
     mFlushMode = false;
+}
+
+/**
+ * @callback_method_impl{FNDBGFPROGRESS}
+ */
+/*static*/ DECLCALLBACK(int) MachineDebugger::i_dbgfProgressCallback(void *pvUser, unsigned uPercentage)
+{
+    MachineDebugger *pThis = (MachineDebugger *)pvUser;
+
+    int vrc = pThis->m_Progress->i_iprtProgressCallback(uPercentage, static_cast<Progress *>(pThis->m_Progress));
+    if (   RT_SUCCESS(vrc)
+        && uPercentage == 100)
+    {
+        vrc = DBGFR3SampleReportDumpToFile(pThis->m_hSampleReport, pThis->m_strFilename.c_str());
+        DBGFR3SampleReportRelease(pThis->m_hSampleReport);
+        pThis->m_hSampleReport = NULL;
+        if (RT_SUCCESS(vrc))
+            pThis->m_Progress->i_notifyComplete(S_OK);
+        else
+        {
+            HRESULT hrc = pThis->setError(VBOX_E_IPRT_ERROR,
+                                          tr("Writing the sample report to '%s' failed with %Rrc"),
+                                          pThis->m_strFilename.c_str(), vrc);
+            pThis->m_Progress->i_notifyComplete(hrc);
+        }
+        pThis->m_Progress.setNull();
+    }
+    else if (vrc == VERR_CANCELLED)
+        vrc = VERR_DBGF_CANCELLED;
+
+    return vrc;
 }
 
@@ -1592 +1626 @@
 
 
+HRESULT MachineDebugger::takeGuestSample(const com::Utf8Str &aFilename, ULONG aUsInterval, LONG64 aUsSampleTime, ComPtr<IProgress> &pProgress)
+{
+    /*
+     * The prologue.
+     */
+    LogFlowThisFunc(("\n"));
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+    Console::SafeVMPtr ptrVM(mParent);
+    HRESULT hrc = ptrVM.rc();
+    if (SUCCEEDED(hrc))
+    {
+        if (!m_hSampleReport)
+        {
+            m_strFilename = aFilename;
+
+            int vrc = DBGFR3SampleReportCreate(ptrVM.rawUVM(), aUsInterval, DBGF_SAMPLE_REPORT_F_STACK_REVERSE, &m_hSampleReport);
+            if (RT_SUCCESS(vrc))
+            {
+                hrc = m_Progress.createObject();
+                if (SUCCEEDED(hrc))
+                {
+                    hrc = m_Progress->init(static_cast<IMachineDebugger*>(this),
+                                           tr("Creating guest sample report..."),
+                                           TRUE /* aCancelable */);
+                    if (SUCCEEDED(hrc))
+                    {
+                        vrc = DBGFR3SampleReportStart(m_hSampleReport, aUsSampleTime, i_dbgfProgressCallback, static_cast<MachineDebugger*>(this));
+                        if (RT_SUCCESS(vrc))
+                            hrc = m_Progress.queryInterfaceTo(pProgress.asOutParam());
+                        else
+                            hrc = setErrorVrc(vrc);
+                    }
+                }
+
+                if (FAILED(hrc))
+                {
+                    DBGFR3SampleReportRelease(m_hSampleReport);
+                    m_hSampleReport = NULL;
+                }
+            }
+            else
+                hrc = setErrorVrc(vrc);
+        }
+        else
+            hrc = setError(VBOX_E_INVALID_VM_STATE, "A sample report is already in progress");
+    }
+
+    return hrc;
+}
+
+
 // public methods only for internal purposes
 /////////////////////////////////////////////////////////////////////////////