Changeset 99264 in vbox

Timestamp:

Apr 3, 2023 3:37:08 PM (2 years ago)

Author:

vboxsync

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

156647

Message:

Guest Control/VBoxManage: Added a new command "fsinfo|df" to show guest filesystem information. bugref:10414

Location:

trunk

Files:

• doc/manual/en_US/man_VBoxManage-guestcontrol.xml (modified) (3 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (modified) (2 diffs)

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

@@ -256 +256 @@
     </cmdsynopsis>
 
+    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-fsinfo">
+      <command>VBoxManage guestcontrol</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg choice="plain">fsinfo</arg>
+      <arg>--domain=<replaceable>domainname</replaceable></arg>
+      <group>
+        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
+        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
+      </group>
+      <arg>--human-readable</arg>
+      <arg>--quiet</arg>
+      <arg>--username=<replaceable>username</replaceable></arg>
+      <arg>--verbose</arg>
+      <arg choice="req"><replaceable>path</replaceable></arg>
+    </cmdsynopsis>
+
     <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-stat">
       <command>VBoxManage guestcontrol</command>
@@ -392 +411 @@
         authentication. The subcommands are:
         <command>copyfrom</command>, <command>copyto</command>,
+        <command>fsinfo</command>,
         <command>mkdir</command>, <command>mktemp</command>,
         <command>mv</command>, <command>rmdir</command>,
@@ -773 +793 @@
               use wildcards to specify multiple files. For example,
               <filename>C:\Windows\System*\*.dll</filename>.
+            </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+    <refsect2 id="vboxmanage-guestcontrol-fsinfo">
+      <title>Show guest filesystem information.</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage guestcontrol
+        <replaceable>vmname</replaceable> fsinfo</command> command
+        enables you to show filesystem information of the guest VM.
+      </para>
+      <para>
+        An alternate form of this subcommand is <command>df</command>.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--human-readable</option></term>
+          <listitem><para>
+              Shows the disk sizes in a human readable form.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><literal><replaceable>guest-path</replaceable> [<replaceable>guest-path</replaceable>...]</literal></term>
+          <listitem><para>
+              Specifies an absolute path to show guest filesystem
+              information for.
             </para></listitem>
         </varlistentry>

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

@@ -2385 +2385 @@
 }
 
+static DECLCALLBACK(RTEXITCODE) gctlHandleFsInfo(PGCTLCMDCTX pCtx, int argc, char **argv)
+{
+    AssertPtrReturn(pCtx, RTEXITCODE_FAILURE);
+
+    static const RTGETOPTDEF s_aOptions[] =
+    {
+        GCTLCMD_COMMON_OPTION_DEFS()
+        { "--human-readable",           'h',                RTGETOPT_REQ_NOTHING }
+    };
+
+    int ch;
+    RTGETOPTUNION ValueUnion;
+    RTGETOPTSTATE GetState;
+    RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
+
+    bool fHumanReadable = false;
+
+    while (  (ch = RTGetOpt(&GetState, &ValueUnion)) != 0
+           && ch != VINF_GETOPT_NOT_OPTION)
+    {
+        /* For options that require an argument, ValueUnion has received the value. */
+        switch (ch)
+        {
+            GCTLCMD_COMMON_OPTION_CASES(pCtx, ch, &ValueUnion);
+
+            case 'h':
+                fHumanReadable = true;
+                break;
+
+            default:
+                return errorGetOpt(ch, &ValueUnion);
+        }
+    }
+
+    if (ch != VINF_GETOPT_NOT_OPTION)
+        return errorSyntax(GuestCtrl::tr("No path specified to query information for!"));
+
+    RTEXITCODE rcExit = gctlCtxPostOptionParsingInit(pCtx);
+    if (rcExit != RTEXITCODE_SUCCESS)
+        return rcExit;
+
+    /* Stay within 80 characters width by default. */
+    unsigned const cwFileSys     = 12;
+    unsigned const cwSize        = 16;
+    unsigned const cwSizeTotal   = cwSize;
+    unsigned const cwSizeUsed    = cwSize;
+    unsigned const cwSizeAvail   = cwSize;
+    unsigned const cwPathSpacing = 6; /* Spacing between last value and actual path. */
+
+    RTPrintf("%-*s%*s%*s%*s%*s%s\n",
+             cwFileSys, GuestCtrl::tr("Filesystem"),
+             cwSizeTotal, GuestCtrl::tr("Total"), cwSizeUsed, GuestCtrl::tr("Used"), cwSizeAvail, GuestCtrl::tr("Available"),
+             cwPathSpacing, "",
+             GuestCtrl::tr("Path"));
+
+    while (ch == VINF_GETOPT_NOT_OPTION)
+    {
+        ComPtr<IGuestFsInfo> pFsInfo;
+        HRESULT hrc;
+        CHECK_ERROR(pCtx->pGuestSession, FsQueryInfo(Bstr(ValueUnion.psz).raw(), pFsInfo.asOutParam()));
+        if (FAILED(hrc))
+        {
+            rcExit = RTEXITCODE_FAILURE;
+        }
+        else
+        {
+            Bstr bstr;
+            CHECK_ERROR2I(pFsInfo, COMGETTER(Type)(bstr.asOutParam()));
+            /** @todo Add label and mount point once we return this. */
+            LONG64 u64, u64_2;
+            CHECK_ERROR2I(pFsInfo, COMGETTER(TotalSize)(&u64));
+            CHECK_ERROR2I(pFsInfo, COMGETTER(FreeSize)(&u64_2));
+            if (fHumanReadable)
+            {
+                RTPrintf("%-*ls%*Rhcb%*Rhcb%*Rhcb%*s%s",
+                         cwFileSys, bstr.raw(),               /* Filesystem */
+                         cwSizeTotal, u64,                    /* Total */
+                         cwSizeUsed,  u64 - u64_2,            /* Used */
+                         cwSizeAvail, u64_2,                  /* Available */
+                         cwPathSpacing, "",
+                         ValueUnion.psz);                     /* Path */
+            }
+            else
+            {
+                RTPrintf("%-*ls%*RU64%*RU64%*RU64%*s%s",
+                         cwFileSys, bstr.raw(),               /* Filesystem */
+                         cwSizeTotal, u64,                    /* Total */
+                         cwSizeUsed,  u64 - u64_2,            /* Used */
+                         cwSizeAvail, u64_2,                  /* Available */
+                         cwPathSpacing, "",
+                         ValueUnion.psz);                     /* Path */
+            }
+            RTPrintf("\n");
+        }
+
+        /* Next path. */
+        ch = RTGetOpt(&GetState, &ValueUnion);
+    }
+
+    return rcExit;
+}
+
 static DECLCALLBACK(RTEXITCODE) gctlHandleStat(PGCTLCMDCTX pCtx, int argc, char **argv)
 {
@@ -3610 +3712 @@
         { "createtemporary",    gctlHandleMkTemp,           HELP_SCOPE_GUESTCONTROL_MKTEMP,    0 },
 
+        { "df",                 gctlHandleFsInfo,           HELP_SCOPE_GUESTCONTROL_FSINFO,    0 },
+        { "fsinfo",             gctlHandleFsInfo,           HELP_SCOPE_GUESTCONTROL_FSINFO,    0 },
+
         { "stat",               gctlHandleStat,             HELP_SCOPE_GUESTCONTROL_STAT,      0 },