Changeset 40469 in vbox for trunk/src/VBox

Timestamp:

Mar 14, 2012 6:14:52 PM (13 years ago)

Author:

vboxsync

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

76837

Message:

VBoxManage: bandwidthctl uses sub-commands instead of options (#5582)

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManageBandwidthControl.cpp (modified) (6 diffs)
• VBoxManageHelp.cpp (modified) (1 diff)
• VBoxManageInfo.cpp (modified) (4 diffs)

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

@@ -43 +43 @@
 
 
-static const RTGETOPTDEF g_aBandwidthControlOptions[] =
-{
-    { "--name",   'n', RTGETOPT_REQ_STRING },
-    { "--add",    'a', RTGETOPT_REQ_STRING },
-    { "--limit",  'l', RTGETOPT_REQ_UINT32 },
-    { "--delete", 'd', RTGETOPT_REQ_NOTHING },
-};
-
-int handleBandwidthControl(HandlerArg *a)
-{
-    int c = VERR_INTERNAL_ERROR;        /* initialized to shut up gcc */
+/**
+ * Handles the 'bandwidthctl myvm add' sub-command.
+ * @returns Exit code.
+ * @param   a               The handler argument package.
+ * @param   bwCtrl          Reference to the bandwidth control interface.
+ */
+static RTEXITCODE handleBandwidthControlAdd(HandlerArg *a, ComPtr<IBandwidthControl> &bwCtrl)
+{
     HRESULT rc = S_OK;
-    const char *pszName  = NULL;
+    static const RTGETOPTDEF g_aBWCtlAddOptions[] =
+        {
+            { "--type",   't', RTGETOPT_REQ_STRING },
+            { "--limit",  'l', RTGETOPT_REQ_UINT32 }
+        };
+
+
+    Bstr name(a->argv[2]);
     const char *pszType  = NULL;
     ULONG cMaxMbPerSec   = UINT32_MAX;
-    bool fDelete = false;
+
+    int c;
     RTGETOPTUNION ValueUnion;
     RTGETOPTSTATE GetState;
-    ComPtr<IMachine> machine;
-    ComPtr<IBandwidthControl> bwCtrl;
-    ComPtr<IBandwidthGroup> bwGroup;
-
-    if (a->argc < 4)
-        return errorSyntax(USAGE_BANDWIDTHCONTROL, "Too few parameters");
-    else if (a->argc > 7)
-        return errorSyntax(USAGE_BANDWIDTHCONTROL, "Too many parameters");
-
-    RTGetOptInit(&GetState, a->argc, a->argv, g_aBandwidthControlOptions,
-                 RT_ELEMENTS(g_aBandwidthControlOptions), 1, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
+    RTGetOptInit(&GetState, a->argc, a->argv, g_aBWCtlAddOptions,
+                 RT_ELEMENTS(g_aBWCtlAddOptions), 3, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
 
     while (   SUCCEEDED(rc)
@@ -78 +74 @@
         switch (c)
         {
-            case 'n':   // bandwidth group name
-            {
-                if (ValueUnion.psz)
-                    pszName = ValueUnion.psz;
-                else
-                    rc = E_FAIL;
-                break;
-            }
-
-            case 'a':   // add
+            case 't':   // bandwidth group type
             {
                 if (ValueUnion.psz)
@@ -102 +89 @@
             }
 
-            case 'd':   // delete
-            {
-                fDelete = true;
-                break;
-            }
-
             default:
             {
@@ -116 +97 @@
         }
     }
-
-    if (FAILED(rc))
-        return 1;
-
-    if (!pszName)
-        return errorSyntax(USAGE_BANDWIDTHCONTROL, "Bandwidth group name not specified");
+    RTPrintf("Adding bwgroup: name=%ls type=%s limit=%u\n", name.raw(), pszType, cMaxMbPerSec);
+
+    BandwidthGroupType_T enmType;
+
+    if (!RTStrICmp(pszType, "disk"))
+        enmType = BandwidthGroupType_Disk;
+    else if (!RTStrICmp(pszType, "network"))
+        enmType = BandwidthGroupType_Network;
+    else
+    {
+        errorArgument("Invalid bandwidth group type\n");
+        return RTEXITCODE_FAILURE;
+    }
+    
+    CHECK_ERROR2_RET(bwCtrl, CreateBandwidthGroup(name.raw(), enmType, cMaxMbPerSec), RTEXITCODE_FAILURE);
+
+    return RTEXITCODE_SUCCESS;
+}
+
+/**
+ * Handles the 'bandwidthctl myvm set' sub-command.
+ * @returns Exit code.
+ * @param   a               The handler argument package.
+ * @param   bwCtrl          Reference to the bandwidth control interface.
+ */
+static RTEXITCODE handleBandwidthControlSet(HandlerArg *a, ComPtr<IBandwidthControl> &bwCtrl)
+{
+    HRESULT rc = S_OK;
+    static const RTGETOPTDEF g_aBWCtlAddOptions[] =
+        {
+            { "--limit",  'l', RTGETOPT_REQ_UINT32 }
+        };
+
+
+    Bstr name(a->argv[2]);
+    ULONG cMaxMbPerSec   = UINT32_MAX;
+
+    int c;
+    RTGETOPTUNION ValueUnion;
+    RTGETOPTSTATE GetState;
+    RTGetOptInit(&GetState, a->argc, a->argv, g_aBWCtlAddOptions,
+                 RT_ELEMENTS(g_aBWCtlAddOptions), 3, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
+
+    while (   SUCCEEDED(rc)
+           && (c = RTGetOpt(&GetState, &ValueUnion)))
+    {
+        switch (c)
+        {
+            case 'l': // limit
+            {
+                cMaxMbPerSec = ValueUnion.u32;
+                break;
+            }
+
+            default:
+            {
+                errorGetOpt(USAGE_BANDWIDTHCONTROL, c, &ValueUnion);
+                rc = E_FAIL;
+                break;
+            }
+        }
+    }
+    RTPrintf("Updating bwgroup: name=%ls limit=%u\n", name.raw(), cMaxMbPerSec);
+
+    
+    if (cMaxMbPerSec != UINT32_MAX)
+    {
+        ComPtr<IBandwidthGroup> bwGroup;
+        CHECK_ERROR2_RET(bwCtrl, GetBandwidthGroup(name.raw(), bwGroup.asOutParam()), RTEXITCODE_FAILURE);
+        if (SUCCEEDED(rc))
+            CHECK_ERROR2_RET(bwGroup, COMSETTER(MaxMbPerSec)(cMaxMbPerSec), RTEXITCODE_FAILURE);
+    }
+
+    return RTEXITCODE_SUCCESS;
+}
+
+/**
+ * Handles the 'bandwidthctl myvm remove' sub-command.
+ * @returns Exit code.
+ * @param   a               The handler argument package.
+ * @param   bwCtrl          Reference to the bandwidth control interface.
+ */
+static RTEXITCODE handleBandwidthControlRemove(HandlerArg *a, ComPtr<IBandwidthControl> &bwCtrl)
+{
+    Bstr name(a->argv[2]);
+    CHECK_ERROR2_RET(bwCtrl, DeleteBandwidthGroup(name.raw()), RTEXITCODE_FAILURE);
+    return RTEXITCODE_SUCCESS;
+}
+
+/**
+ * Converts bandwidth group type to a string.
+ * @returns String representation.
+ * @param   enmType         Bandwidth control group type.
+ */
+inline const char * typeToString(BandwidthGroupType_T enmType)
+{
+    switch (enmType)
+    {
+        case BandwidthGroupType_Disk:    return "Disk";
+        case BandwidthGroupType_Network: return "Network";
+    }
+    return "unknown";
+}
+
+/**
+ * Handles the 'bandwidthctl myvm list' sub-command.
+ * @returns Exit code.
+ * @param   a               The handler argument package.
+ * @param   bwCtrl          Reference to the bandwidth control interface.
+ */
+static RTEXITCODE handleBandwidthControlList(HandlerArg *pArgs, ComPtr<IBandwidthControl> &rptrBWControl)
+{
+    static const RTGETOPTDEF g_aOptions[] =
+    {
+        { "--machinereadable",  'M', RTGETOPT_REQ_NOTHING },
+    };
+
+    VMINFO_DETAILS enmDetails = VMINFO_STANDARD;
+
+    int c;
+    RTGETOPTUNION ValueUnion;
+    RTGETOPTSTATE GetState;
+    RTGetOptInit(&GetState, pArgs->argc, pArgs->argv, g_aOptions, RT_ELEMENTS(g_aOptions), 2 /*iArg*/, 0 /*fFlags*/);
+    while ((c = RTGetOpt(&GetState, &ValueUnion)))
+    {
+        switch (c)
+        {
+            case 'M':   enmDetails = VMINFO_MACHINEREADABLE; break;
+            default:    return errorGetOpt(USAGE_BANDWIDTHCONTROL, c, &ValueUnion);
+        }
+    }
+
+    /* See showVMInfo. */
+    com::SafeIfaceArray<IBandwidthGroup> bwGroups;
+    CHECK_ERROR2_RET(rptrBWControl, GetAllBandwidthGroups(ComSafeArrayAsOutParam(bwGroups)), RTEXITCODE_FAILURE);
+    for (size_t i = 0; i < bwGroups.size(); i++)
+    {
+        Bstr strName;
+        ULONG cMaxMbPerSec;
+        BandwidthGroupType_T enmType;
+
+        CHECK_ERROR2_RET(bwGroups[i], COMGETTER(Name)(strName.asOutParam()), RTEXITCODE_FAILURE);
+        CHECK_ERROR2_RET(bwGroups[i], COMGETTER(Type)(&enmType), RTEXITCODE_FAILURE);
+        CHECK_ERROR2_RET(bwGroups[i], COMGETTER(MaxMbPerSec)(&cMaxMbPerSec), RTEXITCODE_FAILURE);
+
+        RTPrintf(enmDetails == VMINFO_MACHINEREADABLE ?
+                 "Group=%ls\nType=%s\nLimit=%u\n\n" :
+                 "%-30ls %-10s %u MBytes/sec\n",
+                 strName.raw(),
+                 typeToString(enmType),
+                 cMaxMbPerSec);
+    }
+
+    return RTEXITCODE_SUCCESS;
+}
+
+
+/**
+ * Handles the 'bandwidthctl' command.
+ * @returns Exit code.
+ * @param   a               The handler argument package.
+ */
+int handleBandwidthControl(HandlerArg *a)
+{
+    int c = VERR_INTERNAL_ERROR;        /* initialized to shut up gcc */
+    HRESULT rc = S_OK;
+    ComPtr<IMachine> machine;
+    ComPtr<IBandwidthControl> bwCtrl;
+
+    if (a->argc < 2)
+        return errorSyntax(USAGE_BANDWIDTHCONTROL, "Too few parameters");
+    else if (a->argc > 7)
+        return errorSyntax(USAGE_BANDWIDTHCONTROL, "Too many parameters");
 
     /* try to find the given machine */
@@ -133 +281 @@
     bool fRunTime = (st == SessionType_Shared);
 
-    if (fRunTime && pszType)
-    {
-        errorArgument("Bandwidth groups cannot be created while the VM is running\n");
-        goto leave;
-    }
-
-    if (fRunTime && fDelete)
-    {
-        errorArgument("Bandwidth groups cannot be deleted while the VM is running\n");
-        goto leave;
-    }
-
-    if (fDelete && pszType)
-    {
-        errorArgument("Bandwidth groups cannot be created and deleted at the same time\n");
-        goto leave;
-    }
-
     /* get the mutable session machine */
     a->session->COMGETTER(Machine)(machine.asOutParam());
@@ -156 +286 @@
     if (FAILED(rc)) goto leave;
 
-    /* Add a new group if requested. */
-    if (pszType)
-    {
-        BandwidthGroupType_T enmType;
-
-        if (!RTStrICmp(pszType, "disk"))
-            enmType = BandwidthGroupType_Disk;
-        else if (!RTStrICmp(pszType, "network"))
-            enmType = BandwidthGroupType_Network;
-        else
-        {
-            errorArgument("Invalid bandwidth group type\n");
+    if (!strcmp(a->argv[1], "add"))
+    {
+        if (fRunTime)
+        {
+            errorArgument("Bandwidth groups cannot be created while the VM is running\n");
             goto leave;
         }
-
-        CHECK_ERROR(bwCtrl, CreateBandwidthGroup(Bstr(pszName).raw(), enmType, cMaxMbPerSec));
-    }
-    else if (fDelete)
-    {
-        CHECK_ERROR(bwCtrl, DeleteBandwidthGroup(Bstr(pszName).raw()));
-    }
-    else if (cMaxMbPerSec != UINT32_MAX)
-    {
-        CHECK_ERROR(bwCtrl, GetBandwidthGroup(Bstr(pszName).raw(), bwGroup.asOutParam()));
-        if (SUCCEEDED(rc))
-            CHECK_ERROR(bwGroup, COMSETTER(MaxMbPerSec)(cMaxMbPerSec));
+        rc = handleBandwidthControlAdd(a, bwCtrl) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
+    }
+    else if (!strcmp(a->argv[1], "remove"))
+    {
+        if (fRunTime)
+        {
+            errorArgument("Bandwidth groups cannot be deleted while the VM is running\n");
+            goto leave;
+        }
+        rc = handleBandwidthControlRemove(a, bwCtrl) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
+    }
+    else if (!strcmp(a->argv[1], "set"))
+        rc = handleBandwidthControlSet(a, bwCtrl) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
+    else if (!strcmp(a->argv[1], "list"))
+        rc = handleBandwidthControlList(a, bwCtrl) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
+    else
+    {
+        errorSyntax(USAGE_BANDWIDTHCONTROL, "Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str());
+        rc = E_FAIL;
     }
 

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

@@ -510 +510 @@
         RTStrmPrintf(pStrm,
                      "VBoxManage bandwidthctl     <uuid|vmname>\n"
-                     "                            --name <name>\n"
-                     "                            [--add disk|network]\n"
-                     "                            [--limit <megabytes per second>\n"
-                     "                            [--delete]\n"
+                     "                            add <name> --type <disk|network> --limit <megabytes per second> |\n"
+                     "                            set <name> --limit <megabytes per second> |\n"
+                     "                            remove <name> |\n"
+                     "                            list [--machinereadable]\n"
                      "\n");
 

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

@@ -1023 +1023 @@
                 nic->COMGETTER(BootPriority)(&ulBootPriority);
 
+                /* bandwidth group */
+                ComObjPtr<IBandwidthGroup> pBwGroup;
+                Bstr strBwGroup;
+                nic->COMGETTER(BandwidthGroup)(pBwGroup.asOutParam());
+                if (!pBwGroup.isNull())
+                    pBwGroup->COMGETTER(Name)(strBwGroup.asOutParam());
+
                 if (details == VMINFO_MACHINEREADABLE)
                 {
@@ -1030 +1037 @@
                 }
                 else
-                    RTPrintf("NIC %u:           MAC: %ls, Attachment: %s, Cable connected: %s, Trace: %s (file: %ls), Type: %s, Reported speed: %d Mbps, Boot priority: %d, Promisc Policy: %s\n",
+                    RTPrintf("NIC %u:           MAC: %ls, Attachment: %s, Cable connected: %s, Trace: %s (file: %ls), Type: %s, Reported speed: %d Mbps, Boot priority: %d, Promisc Policy: %s, Bandwidth group: %ls\n",
                              currentNIC + 1, strMACAddress.raw(), strAttachment.c_str(),
                              fConnected ? "on" : "off",
@@ -1038 +1045 @@
                              ulLineSpeed / 1000,
                              (int)ulBootPriority,
-                             pszPromiscuousGuestPolicy);
+                             pszPromiscuousGuestPolicy,
+                             strBwGroup.isEmpty() ? Bstr("none").raw() : strBwGroup.raw());
                 if (strNatSettings.length())
                     RTPrintf(strNatSettings.c_str());
@@ -1823 +1831 @@
 
     /*
+     * Bandwidth groups
+     */
+    if (details != VMINFO_MACHINEREADABLE)
+        RTPrintf("Bandwidth groups:\n\n");
+    {
+        ComPtr<IBandwidthControl> bwCtrl;
+        SafeIfaceArray<IBandwidthGroup> bwGroups;
+
+        CHECK_ERROR_RET(machine, COMGETTER(BandwidthControl)(bwCtrl.asOutParam()), rc);
+
+        CHECK_ERROR_RET(bwCtrl, GetAllBandwidthGroups(ComSafeArrayAsOutParam(bwGroups)), rc);
+
+        for (size_t i = 0; i < bwGroups.size(); i++)
+        {
+            Bstr strName;
+            ULONG cMaxMbPerSec;
+            BandwidthGroupType_T enmType;
+
+            CHECK_ERROR_RET(bwGroups[i], COMGETTER(Name)(strName.asOutParam()), rc);
+            CHECK_ERROR_RET(bwGroups[i], COMGETTER(Type)(&enmType), rc);
+            CHECK_ERROR_RET(bwGroups[i], COMGETTER(MaxMbPerSec)(&cMaxMbPerSec), rc);
+
+            const char *pszType = "unknown";
+            switch (enmType)
+            {
+                case BandwidthGroupType_Disk:    pszType = "disk";    break;
+                case BandwidthGroupType_Network: pszType = "network"; break;
+            }
+            if (details == VMINFO_MACHINEREADABLE)
+                RTPrintf("BandwidthGroup%zu=%ls,%s,%d\n", strName.raw(), pszType, cMaxMbPerSec);
+            else
+                RTPrintf("Name: '%ls', Type: %s, Limit: %d Mbytes/sec\n", strName.raw(), pszType, cMaxMbPerSec);
+        }
+        if (details != VMINFO_MACHINEREADABLE && bwGroups.size() != 0)
+            RTPrintf("\n");
+    }
+
+
+    /*
      * Shared folders
      */