Changeset 36275 in vbox

Timestamp:

Mar 14, 2011 6:01:34 PM (14 years ago)

Author:

vboxsync

Message:

Main/NetworkAdapter: Bandwidth group attribute implementation (#5582)

Location:

trunk

Files:

• include/VBox/settings.h (modified) (2 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp (modified) (3 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (3 diffs)
• src/VBox/Main/include/NetworkAdapterImpl.h (modified) (5 diffs)
• src/VBox/Main/src-server/MachineImpl.cpp (modified) (3 diffs)
• src/VBox/Main/src-server/NetworkAdapterImpl.cpp (modified) (10 diffs)
• src/VBox/Main/xml/Settings.cpp (modified) (3 diffs)

trunk/include/VBox/settings.h

@@ -441 +441 @@
           mode(NetworkAttachmentType_Null),
           ulBootPriority(0),
-          fHasDisabledNAT(false),
-          ulBandwidthLimit(0)
+          fHasDisabledNAT(false)
     {}
 
@@ -466 +465 @@
     uint32_t                            ulBootPriority;
     bool                                fHasDisabledNAT;
-    uint32_t                            ulBandwidthLimit;
+    com::Utf8Str                        strBandwidthGroup; // requires settings version 1.13 (VirtualBox 4.2)
 };
 typedef std::list<NetworkAdapter> NetworkAdaptersList;

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

@@ -208 +208 @@
                      "                            [--nicbootprio<1-N> <priority>]\n"
                      "                            [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
+                     "                            [--nicbandwidthgroup<1-N> <name>\n"
                      "                            [--bridgeadapter<1-N> none|<devicename>]\n"
 #if defined(VBOX_WITH_NETFLT)

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

@@ -105 +105 @@
     MODIFYVM_NICBOOTPRIO,
     MODIFYVM_NICPROMISC,
+    MODIFYVM_NICBWGROUP,
     MODIFYVM_NIC,
     MODIFYVM_CABLECONNECTED,
@@ -232 +233 @@
     { "--nicbootprio",              MODIFYVM_NICBOOTPRIO,               RTGETOPT_REQ_UINT32 | RTGETOPT_FLAG_INDEX },
     { "--nicpromisc",               MODIFYVM_NICPROMISC,                RTGETOPT_REQ_STRING | RTGETOPT_FLAG_INDEX },
+    { "--nicbandwidthgroup",        MODIFYVM_NICBWGROUP,                RTGETOPT_REQ_STRING | RTGETOPT_FLAG_INDEX },
     { "--nic",                      MODIFYVM_NIC,                       RTGETOPT_REQ_STRING | RTGETOPT_FLAG_INDEX },
     { "--cableconnected",           MODIFYVM_CABLECONNECTED,            RTGETOPT_REQ_BOOL_ONOFF | RTGETOPT_FLAG_INDEX },
@@ -1109 +1111 @@
             }
 
+            case MODIFYVM_NICBWGROUP:
+            {
+                ComPtr<INetworkAdapter> nic;
+                CHECK_ERROR_BREAK(machine, GetNetworkAdapter(GetOptState.uIndex - 1, nic.asOutParam()));
+                ASSERT(nic);
+
+                if (!RTStrICmp(ValueUnion.psz, "none"))
+                {
+                    /* Just remove the bandwidth group. */
+                    CHECK_ERROR(nic, COMSETTER(BandwidthGroup)(NULL));
+                    //CHECK_ERROR(nic, COMSETTER(BandwidthGroup)(bwGroup));
+                    //CHECK_ERROR(machine, SetBandwidthGroupForNetworkAdapter(GetOptState.uIndex - 1, NULL));
+                }
+                else
+                {
+                    ComPtr<IBandwidthControl> bwCtrl;
+                    ComPtr<IBandwidthGroup> bwGroup;
+
+                    CHECK_ERROR(machine, COMGETTER(BandwidthControl)(bwCtrl.asOutParam()));
+
+                    if (SUCCEEDED(rc))
+                    {
+                        CHECK_ERROR(bwCtrl, GetBandwidthGroup(Bstr(ValueUnion.psz).raw(), bwGroup.asOutParam()));
+                        if (SUCCEEDED(rc))
+                        {
+                            CHECK_ERROR(nic, COMSETTER(BandwidthGroup)(bwGroup));
+                        }
+                    }
+                }
+                break;
+            }
+
             case MODIFYVM_NIC:
             {

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

@@ -488 +488 @@
     </const>
 
+    <const name="v1_13"     value="15">
+      <desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
+      <!--
+          NetworkAdapter changes: bandwidth group.
+      -->
+    </const>
+
     <const name="Future"     value="99999">
-      <desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
+      <desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
     </const>
   </enum>
@@ -11827 +11834 @@
   <interface
     name="INetworkAdapter" extends="$unknown"
-    uuid="2178cf4f-d961-42f4-ba76-59539234b337"
+    uuid="6aa240a1-dd58-478e-92e8-aac001ce5547"
     wsmap="managed"
     >
@@ -11949 +11956 @@
     </attribute>
 
-    <attribute name="bandwidthLimit" type="unsigned long">
-      <desc>
-        Maximum throughput allowed for this network adapter, in units of 1 mbps.
-        A zero value means uncapped/unlimited.
-      </desc>
+    <attribute name="bandwidthGroup" type="IBandwidthGroup">
+      <desc>The bandwidth group this network adapter is assigned to.</desc>
     </attribute>
 

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

@@ -23 +23 @@
 #include "VirtualBoxBase.h"
 #include "NATEngineImpl.h"
+#include "BandwidthGroupImpl.h"
 
 class GuestOSType;
@@ -71 +72 @@
         Bstr mNATNetwork;
         ULONG mBootPriority;
-        ULONG mBandwidthLimit;
+        ComObjPtr<BandwidthGroup> mBandwidthGroup;
     };
 
@@ -125 +126 @@
     STDMETHOD(COMGETTER(BootPriority)) (ULONG *aBootPriority);
     STDMETHOD(COMSETTER(BootPriority)) (ULONG aBootPriority);
-    STDMETHOD(COMGETTER(BandwidthLimit)) (ULONG *aLimit);
-    STDMETHOD(COMSETTER(BandwidthLimit)) (ULONG aLimit);
+    STDMETHOD(COMGETTER(BandwidthGroup)) (IBandwidthGroup **aBwGroup);
+    STDMETHOD(COMSETTER(BandwidthGroup)) (IBandwidthGroup *aBwGroup);
 
     // INetworkAdapter methods
@@ -138 +139 @@
     // public methods only for internal purposes
 
-    HRESULT loadSettings(const settings::NetworkAdapter &data);
+    HRESULT loadSettings(BandwidthControl *bwctl, const settings::NetworkAdapter &data);
     HRESULT saveSettings(settings::NetworkAdapter &data);
 
@@ -151 +152 @@
     void detach();
     void generateMACAddress();
+    HRESULT updateMacAddress(Utf8Str aMacAddress);
+    void updateBandwidthGroup(BandwidthGroup *aBwGroup);
 
     Machine * const     mParent;

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -7468 +7468 @@
         if (FAILED(rc)) return rc;
 
+        // Bandwidth control (must come before network adapters)
+        rc = mBandwidthControl->loadSettings(data.ioSettings);
+        if (FAILED(rc)) return rc;
+
         /* USB Controller */
         rc = mUSBController->loadSettings(data.usbController);
@@ -7481 +7485 @@
             /* slot unicity is guaranteed by XML Schema */
             AssertBreak(nic.ulSlot < RT_ELEMENTS(mNetworkAdapters));
-            rc = mNetworkAdapters[nic.ulSlot]->loadSettings(nic);
+            rc = mNetworkAdapters[nic.ulSlot]->loadSettings(mBandwidthControl, nic);
             if (FAILED(rc)) return rc;
         }
@@ -7533 +7537 @@
         mHWData->mIoCacheEnabled = data.ioSettings.fIoCacheEnabled;
         mHWData->mIoCacheSize = data.ioSettings.ulIoCacheSize;
-
-        // Bandwidth control
-        rc = mBandwidthControl->loadSettings(data.ioSettings);
-        if (FAILED(rc)) return rc;
 
         // Host PCI devices

trunk/src/VBox/Main/src-server/NetworkAdapterImpl.cpp

@@ -85 +85 @@
     /* initialize data */
     mData->mSlot = aSlot;
-
-    /* Default limit is not capped/unlimited. */
-    mData->mBandwidthLimit = 0;
 
     /* default to Am79C973 */
@@ -340 +337 @@
 }
 
-STDMETHODIMP NetworkAdapter::COMSETTER(MACAddress)(IN_BSTR aMACAddress)
-{
-    AutoCaller autoCaller(this);
-    if (FAILED(autoCaller.rc())) return autoCaller.rc();
-
-    /* the machine needs to be mutable */
-    AutoMutableStateDependency adep(mParent);
-    if (FAILED(adep.rc())) return adep.rc();
-
+HRESULT NetworkAdapter::updateMacAddress(Utf8Str aMACAddress)
+{
     HRESULT rc = S_OK;
-    bool emitChangeEvent = false;
 
     /*
      * Are we supposed to generate a MAC?
      */
-    if (!aMACAddress || !*aMACAddress)
-    {
-        AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
-        mData.backup();
-
+    if (aMACAddress.isEmpty())
         generateMACAddress();
-        emitChangeEvent = true;
-
-        m_fModified = true;
-        // leave the lock before informing callbacks
-        alock.release();
-
-        AutoWriteLock mlock(mParent COMMA_LOCKVAL_SRC_POS);       // mParent is const, no need to lock
-        mParent->setModified(Machine::IsModified_NetworkAdapters);
-        mlock.release();
-    }
     else
     {
-        AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
         if (mData->mMACAddress != aMACAddress)
         {
@@ -379 +353 @@
              * Verify given MAC address
              */
-            Utf8Str macAddressUtf = aMACAddress;
-            char *macAddressStr = macAddressUtf.mutableRaw();
+            char *macAddressStr = aMACAddress.mutableRaw();
             int i = 0;
             while ((i < 13) && macAddressStr && *macAddressStr && (rc == S_OK))
@@ -408 +381 @@
 
             if (SUCCEEDED(rc))
-            {
-                mData.backup();
-
-                mData->mMACAddress = macAddressUtf;
-
-                emitChangeEvent = true;
-
-                m_fModified = true;
-                // leave the lock before informing callbacks
-                alock.release();
-
-                AutoWriteLock mlock(mParent COMMA_LOCKVAL_SRC_POS);       // mParent is const, no need to lock
-                mParent->setModified(Machine::IsModified_NetworkAdapters);
-                mlock.release();
-            }
+                mData->mMACAddress = aMACAddress;
         }
     }
 
-    // we have left the lock in any case at this point
-
-    if (emitChangeEvent)
-    {
+    return rc;
+}
+
+STDMETHODIMP NetworkAdapter::COMSETTER(MACAddress)(IN_BSTR aMACAddress)
+{
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    /* the machine needs to be mutable */
+    AutoMutableStateDependency adep(mParent);
+    if (FAILED(adep.rc())) return adep.rc();
+
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+    mData.backup();
+
+    HRESULT rc = updateMacAddress(aMACAddress);
+    if (SUCCEEDED(rc))
+    {
+        m_fModified = true;
+        // leave the lock before informing callbacks
+        alock.release();
+
+        AutoWriteLock mlock(mParent COMMA_LOCKVAL_SRC_POS);       // mParent is const, no need to lock
+        mParent->setModified(Machine::IsModified_NetworkAdapters);
+        mlock.release();
+
         /* Changing the MAC via the Main API during runtime is not allowed,
          * therefore no immediate change in CFGM logic => changeAdapter=FALSE. */
@@ -799 +781 @@
 
     return hrc;
-}
-
-STDMETHODIMP NetworkAdapter::COMGETTER(BandwidthLimit) (ULONG *aLimit)
-{
-    CheckComArgOutPointerValid(aLimit);
-
-    AutoCaller autoCaller(this);
-    if (FAILED(autoCaller.rc())) return autoCaller.rc();
-
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    *aLimit = mData->mBandwidthLimit;
-    return S_OK;
-}
-
-STDMETHODIMP NetworkAdapter::COMSETTER(BandwidthLimit) (ULONG aLimit)
-{
-    AutoCaller autoCaller(this);
-    if (FAILED(autoCaller.rc())) return autoCaller.rc();
-
-    /* the machine doesn't need to be mutable */
-
-    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    if (aLimit != mData->mBandwidthLimit)
-    {
-        mData.backup();
-        mData->mBandwidthLimit = aLimit;
-
-        m_fModified = true;
-        // leave the lock before informing callbacks
-        alock.release();
-
-        AutoWriteLock mlock(mParent COMMA_LOCKVAL_SRC_POS);       // mParent is const, no need to lock
-        mParent->setModified(Machine::IsModified_NetworkAdapters);
-        mlock.release();
-
-        /* No change in CFGM logic => changeAdapter=FALSE. */
-        mParent->onNetworkAdapterChange(this, FALSE);
-    }
-    return S_OK;
 }
 
@@ -1279 +1220 @@
  *  @note Locks this object for writing.
  */
-HRESULT NetworkAdapter::loadSettings(const settings::NetworkAdapter &data)
+HRESULT NetworkAdapter::loadSettings(BandwidthControl *bwctl,
+                                     const settings::NetworkAdapter &data)
 {
     AutoCaller autoCaller(this);
     AssertComRCReturnRC(autoCaller.rc());
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
     /* Note: we assume that the default values for attributes of optional
@@ -1300 +1244 @@
     mData->mEnabled = data.fEnabled;
     /* MAC address (can be null) */
-    rc = COMSETTER(MACAddress)(Bstr(data.strMACAddress).raw());
+    rc = updateMacAddress(data.strMACAddress);
     if (FAILED(rc)) return rc;
     /* cable (required) */
@@ -1312 +1256 @@
     /* boot priority (defaults to 0, i.e. lowest) */
     mData->mBootPriority = data.ulBootPriority;
-    /* Bandwidth limit in Mbps. */
-    mData->mBandwidthLimit = data.ulBandwidthLimit;
+    /* bandwidth group */
+    if (data.strBandwidthGroup.isEmpty())
+        updateBandwidthGroup(NULL);
+    else
+    {
+        ComObjPtr<BandwidthGroup> group;
+        rc = bwctl->getBandwidthGroupByName(data.strBandwidthGroup, group, true); // TODO: set error?
+        if (FAILED(rc)) return rc;
+    }
+    
+    // leave the lock before attaching
+    alock.release();
 
     switch (data.mode)
@@ -1398 +1352 @@
     data.ulBootPriority = mData->mBootPriority;
 
-    data.ulBandwidthLimit = mData->mBandwidthLimit;
+    if (mData->mBandwidthGroup.isNull())
+        data.strBandwidthGroup = "";
+    else
+        data.strBandwidthGroup = mData->mBandwidthGroup->getName();
 
     data.type = mData->mAdapterType;
@@ -1629 +1586 @@
     mData->mMACAddress = strMAC;
 }
+
+STDMETHODIMP NetworkAdapter::COMGETTER(BandwidthGroup) (IBandwidthGroup **aBwGroup)
+{
+    LogFlowThisFuncEnter();
+    CheckComArgOutPointerValid(aBwGroup);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    mData->mBandwidthGroup.queryInterfaceTo(aBwGroup);
+
+    LogFlowThisFuncLeave();
+    return S_OK;
+}
+
+STDMETHODIMP NetworkAdapter::COMSETTER(BandwidthGroup) (IBandwidthGroup *aBwGroup)
+{
+    LogFlowThisFuncEnter();
+    CheckComArgOutPointerValid(aBwGroup);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    /* the machine needs to be mutable */
+    AutoMutableStateDependency adep(mParent);
+    if (FAILED(adep.rc())) return adep.rc();
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    //HRESULT hrc = S_OK;
+
+    if (mData->mBandwidthGroup != aBwGroup)
+    {
+        mData.backup();
+
+        updateBandwidthGroup(static_cast<BandwidthGroup*>(aBwGroup));
+
+        m_fModified = true;
+        // leave the lock before informing callbacks
+        alock.release();
+
+        AutoWriteLock mlock(mParent COMMA_LOCKVAL_SRC_POS);
+        mParent->setModified(Machine::IsModified_NetworkAdapters);
+        mlock.release();
+
+        /* TODO: changeAdapter=???. */
+        mParent->onNetworkAdapterChange(this, FALSE);
+    }
+
+    LogFlowThisFuncLeave();
+    return S_OK;
+}
+
+void NetworkAdapter::updateBandwidthGroup(BandwidthGroup *aBwGroup)
+{
+    LogFlowThisFuncEnter();
+    Assert(isWriteLockOnCurrentThread());
+
+    mData.backup();
+    if (!mData->mBandwidthGroup.isNull())
+    {
+        mData->mBandwidthGroup->release();
+        mData->mBandwidthGroup.setNull();
+    }
+
+    if (aBwGroup)
+    {
+        mData->mBandwidthGroup = aBwGroup;
+        mData->mBandwidthGroup->reference();
+    }
+
+    LogFlowThisFuncLeave();
+}
 /* vi: set tabstop=4 shiftwidth=4 expandtab: */

trunk/src/VBox/Main/xml/Settings.cpp

@@ -1946 +1946 @@
         pelmAdapter->getAttributeValue("tracefile", nic.strTraceFile);
         pelmAdapter->getAttributeValue("bootPriority", nic.ulBootPriority);
-        pelmAdapter->getAttributeValue("bandwidthLimit", nic.ulBandwidthLimit);
+        pelmAdapter->getAttributeValue("bandwidthGroup", nic.strBandwidthGroup);
 
         xml::ElementNodesList llNetworkModes;
@@ -3695 +3695 @@
             pelmAdapter->setAttribute("tracefile", nic.strTraceFile);
         }
-        if (nic.ulBandwidthLimit)
-            pelmAdapter->setAttribute("bandwidthLimit", nic.ulBandwidthLimit);
+        if (nic.strBandwidthGroup.isNotEmpty())
+            pelmAdapter->setAttribute("bandwidthGroup", nic.strBandwidthGroup);
 
         const char *pszPolicy;
@@ -4729 +4729 @@
              ++netit)
         {
-            if (    (m->sv < SettingsVersion_v1_11)
-                 && (netit->ulBandwidthLimit)
+            if (    (m->sv < SettingsVersion_v1_12)
+                 && (netit->strBandwidthGroup.isNotEmpty())
                )
             {
-                /* New in VirtualBox 4.0 */
-                m->sv = SettingsVersion_v1_11;
+                /* New in VirtualBox 4.1 */
+                m->sv = SettingsVersion_v1_12;
                 break;
             }