Changeset 89697 in vbox

Timestamp:

Jun 15, 2021 9:54:12 AM (4 years ago)

Author:

vboxsync

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

145145

Message:

FE/VBoxManage: Add guestsample sub-command for debugvm, bugref:10025

Location:

trunk

Files:

• doc/manual/en_US/man_VBoxManage-debugvm.xml (modified) (2 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageDebugVM.cpp (modified) (2 diffs)

trunk/doc/manual/en_US/man_VBoxManage-debugvm.xml

@@ -122 +122 @@
       <arg>--descriptions</arg>
       <arg>--pattern=<replaceable>pattern</replaceable></arg>
+    </cmdsynopsis>
+    <cmdsynopsis id="synopsis-vboxmanage-debugvm-guestsample">
+      <command>VBoxManage debugvm</command>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
+      <arg choice="plain">guestsample</arg>
+      <arg>--filename=<replaceable>filename</replaceable></arg>
+      <arg>--sample-interval-us=<replaceable>interval</replaceable></arg>
+      <arg>--sample-time-us=<replaceable>time</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -610 +618 @@
     </refsect2>
 
+    <refsect2 id="vboxmanage-debugvm-guestsample">
+      <title>debugvm guestsample</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        Creates a sample report of the guest activity.
+      </para>
+      <para>
+        Retrieves the filename to dump the report to.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--filename=<replaceable>filename</replaceable></option></term>
+          <listitem><para>The filename to dump the sample report to.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--sample-interval-us=<replaceable>interval</replaceable></option></term>
+          <listitem><para>The interval in microseconds between guest samples.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--sample-time-us=<replaceable>time</replaceable></option></term>
+          <listitem><para>The amount of microseconds to take guest samples.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+
+    </refsect2>
+
   </refsect1>
 

trunk/src/VBox/Frontends/VBoxManage/VBoxManageDebugVM.cpp

@@ -784 +784 @@
 }
 
+/**
+ * Handles the guestsample sub-command.
+ *
+ * @returns Suitable exit code.
+ * @param   pArgs               The handler arguments.
+ * @param   pDebugger           Pointer to the debugger interface.
+ */
+static RTEXITCODE handleDebugVM_GuestSample(HandlerArg *pArgs, IMachineDebugger *pDebugger)
+{
+    /*
+     * Parse arguments.
+     */
+    const char                 *pszFilename         = NULL;
+    uint32_t                   cSampleIntervalUs    = 1000;
+    uint64_t                   cSampleTimeUs        = 1000*1000;
+
+    RTGETOPTSTATE               GetState;
+    RTGETOPTUNION               ValueUnion;
+    static const RTGETOPTDEF    s_aOptions[] =
+    {
+        { "--filename",           'f', RTGETOPT_REQ_STRING },
+        { "--sample-interval-us", 'i', RTGETOPT_REQ_UINT32 },
+        { "--sample-time-us",     't', RTGETOPT_REQ_UINT64 },
+    };
+    int rc = RTGetOptInit(&GetState, pArgs->argc, pArgs->argv, s_aOptions, RT_ELEMENTS(s_aOptions), 2, 0 /*fFlags*/);
+    AssertRCReturn(rc, RTEXITCODE_FAILURE);
+
+    while ((rc = RTGetOpt(&GetState, &ValueUnion)) != 0)
+    {
+        switch (rc)
+        {
+            case 'f':
+                pszFilename = ValueUnion.psz;
+                break;
+            case 'i':
+                cSampleIntervalUs = ValueUnion.u32;
+                break;
+            case 't':
+                cSampleTimeUs = ValueUnion.u64;
+                break;
+
+            default:
+                return errorGetOpt(rc, &ValueUnion);
+        }
+    }
+
+    if (!pszFilename)
+        return errorSyntax("The --filename is missing");
+
+    /*
+     * Execute the order.
+     */
+    ComPtr<IProgress> ptrProgress;
+    com::Bstr bstrFilename(pszFilename);
+    CHECK_ERROR2I_RET(pDebugger, TakeGuestSample(bstrFilename.raw(), cSampleIntervalUs, cSampleTimeUs, ptrProgress.asOutParam()), RTEXITCODE_FAILURE);
+    showProgress(ptrProgress);
+
+    return RTEXITCODE_SUCCESS;
+}
+
 RTEXITCODE handleDebugVM(HandlerArg *pArgs)
 {
@@ -885 +945 @@
                     rcExit = handleDebugVM_Statistics(pArgs, ptrDebugger);
                 }
+                else if (!strcmp(pszSubCmd, "guestsample"))
+                {
+                    setCurrentSubcommand(HELP_SCOPE_DEBUGVM_GUESTSAMPLE);
+                    rcExit = handleDebugVM_GuestSample(pArgs, ptrDebugger);
+                }
                 else
                     errorUnknownSubcommand(pszSubCmd);