Changeset 34587 in vbox for trunk/src/VBox/Frontends/VBoxManage

Timestamp:

Dec 1, 2010 8:30:02 PM (14 years ago)

Author:

vboxsync

Message:

Main: Bandwidth groups for disks (and later network)

This introduces two new interfaces. The first one named IBandwidthGroup
represents one I/O limit and can be assigned to several mediums which
share this limit (which works only for harddisk images with the disabled
host cache).
The second one IBandwdithControl manages the groups and can create new ones
and destroy them if not required anymore.

VBoxManage: commands to access the bandwidth groups

Syntax:
VBoxManage storageattach <uuid|vmname>

...
--bandwidthgroup <name>

--bandwidthgroup assigns the specified device to the given group.

VBoxManage bandwidthctl <uuid|vmname>

--name <name>
--add disk|network
--limit <megabytes per second>
--delete

The --name parameter gives the name of the bandwidth group.
--add creates a new group of the given type (only disk is implemented so far)

with the given name.

--limit sets the limit to the given amount of MB/s

Note that limit can be changed while the VM is running. The VM
will immediately pick up the new limit for the given group name.

--delete deletes the group with the given name if it isn't used anymore.

Trying to delete a still used group will result in an error.

Example:

VBoxManage bandwidthctl "Test VM" --name Limit --add disk --limit 20
Creates a group named Test having a 20 MB/s limit.

VBoxManage storageattach "Test VM" --storagectl "SATA Controller" --port 0 --device 0 --type hdd --medium test.vdi --bandwidthgroup Limit
Adds a new disk to the SATA controller and assigns the bandwidth group Limit to it.

VBoxManage storageattach "Test VM" --storagectl "SATA Controller" --port 0 --device 0 --type hdd --medium test.vdi --bandwidthgroup none
Removes the bandwidth limit from the disk.

VBoxManage bandwidthctl "Test VM" --name Limit --add disk --limit 10
Changes the limit of bandwidth group Limit to 10 MB/s. If the VM is running the limit will be picked up
immediately.

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• Makefile.kmk (modified) (1 diff)
• VBoxManage.cpp (modified) (1 diff)
• VBoxManage.h (modified) (2 diffs)
• VBoxManageBandwidthControl.cpp (added)
• VBoxManageHelp.cpp (modified) (2 diffs)
• VBoxManageStorageController.cpp (modified) (5 diffs)

trunk/src/VBox/Frontends/VBoxManage/Makefile.kmk

@@ -50 +50 @@
         VBoxManageSnapshot.cpp \
         VBoxManageStorageController.cpp \
-        VBoxManageUSB.cpp
+        VBoxManageUSB.cpp \
+        VBoxManageBandwidthControl.cpp
 endif # !VBOX_ONLY_DOCS
 

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

@@ -432 +432 @@
             { "dhcpserver",       USAGE_DHCPSERVER,        handleDHCPServer},
             { "extpack",          USAGE_EXTPACK,           handleExtPack},
+            { "bandwidthctl",     USAGE_BANDWIDTHCONTROL,  handleBandwidthControl},
             { NULL,               0,                       NULL }
         };

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

@@ -98 +98 @@
 #define USAGE_PASSWORDHASH          RT_BIT_64(54)
 #define USAGE_EXTPACK               RT_BIT_64(55)
+#define USAGE_BANDWIDTHCONTROL      RT_BIT_64(56)
 #define USAGE_ALL                   (~(uint64_t)0)
 /** @} */
@@ -241 +242 @@
 int handleDHCPServer(HandlerArg *a);
 
+/* VBoxManageBandwidthControl.cpp */
+int handleBandwidthControl(HandlerArg *a);
+
 #endif /* !VBOX_ONLY_DOCS */
 

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

@@ -464 +464 @@
                      "                                      <uuid>|<filename>|host:<drive>]\n"
                      "                            [--passthrough on|off]\n"
+                     "                            [--bandwidthgroup <name>]\n"
                      "                            [--forceunmount]\n"
                      "\n");
@@ -481 +482 @@
                      "                            [--bootable on|off]\n"
                      "                            [--remove]\n"
+                     "\n");
+    }
+
+    if (u64Cmd & USAGE_BANDWIDTHCONTROL)
+    {
+        RTStrmPrintf(pStrm,
+                     "VBoxManage bandwidthctl     <uuid|vmname>\n"
+                     "                            --name <name>\n"
+                     "                            [--add disk|network]\n"
+                     "                            [--limit <megabytes per second>\n"
+                     "                            [--delete]\n"
                      "\n");
     }

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

@@ -51 +51 @@
     { "--type",           't', RTGETOPT_REQ_STRING },
     { "--passthrough",    'h', RTGETOPT_REQ_STRING },
+    { "--bandwidthgroup", 'b', RTGETOPT_REQ_STRING },
     { "--forceunmount",   'f', RTGETOPT_REQ_NOTHING },
 };
@@ -65 +66 @@
     const char *pszMedium = NULL;
     const char *pszPassThrough = NULL;
+    const char *pszBandwidthGroup = NULL;
     RTGETOPTUNION ValueUnion;
     RTGETOPTSTATE GetState;
@@ -127 +129 @@
                 if (ValueUnion.psz)
                     pszPassThrough = ValueUnion.psz;
+                else
+                    rc = E_FAIL;
+                break;
+            }
+
+            case 'b':   // bandwidthgroup <name>
+            {
+                if (ValueUnion.psz)
+                    pszBandwidthGroup = ValueUnion.psz;
                 else
                     rc = E_FAIL;
@@ -185 +196 @@
     {
         errorArgument("Drive passthrough state can't be changed while the VM is running\n");
+        goto leave;
+    }
+
+    if (fRunTime && pszBandwidthGroup)
+    {
+        errorArgument("Bandwidth group can't be changed while the VM is running\n");
         goto leave;
     }
@@ -626 +643 @@
     }
 
+    if (   pszBandwidthGroup
+        && !fRunTime
+        && SUCCEEDED(rc))
+    {
+
+        if (!RTStrICmp(pszBandwidthGroup, "none"))
+        {
+            /* Just remove the bandwidth gorup. */
+            CHECK_ERROR(machine, SetBandwidthGroupForDevice(Bstr(pszCtl).raw(),
+                                                            port, device, NULL));
+        }
+        else
+        {
+            ComPtr<IBandwidthControl> bwCtrl;
+            ComPtr<IBandwidthGroup> bwGroup;
+
+            CHECK_ERROR(machine, COMGETTER(BandwidthControl)(bwCtrl.asOutParam()));
+
+            if (SUCCEEDED(rc))
+            {
+                CHECK_ERROR(bwCtrl, GetBandwidthGroup(Bstr(pszBandwidthGroup).raw(), bwGroup.asOutParam()));
+                if (SUCCEEDED(rc))
+                {
+                    CHECK_ERROR(machine, SetBandwidthGroupForDevice(Bstr(pszCtl).raw(),
+                                                                    port, device, bwGroup));
+                }
+            }
+        }
+    }
+
     /* commit changes */
     if (SUCCEEDED(rc))