Changeset 37709 in vbox

Timestamp:

Jun 30, 2011 1:51:51 PM (14 years ago)

Author:

vboxsync

Message:

Main/MediumAttachment+Machine: add a setting which controls the guest-triggered medium eject behavior, fix handling "implicit" media, and corresponding VBoxManage and documentation updates

Location:

trunk

Files:

• doc/manual/en_US/user_VBoxManage.xml (modified) (2 diffs)
• include/VBox/settings.h (modified) (2 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageStorageController.cpp (modified) (4 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (3 diffs)
• src/VBox/Main/include/MachineImpl.h (modified) (1 diff)
• src/VBox/Main/include/MediumAttachmentImpl.h (modified) (4 diffs)
• src/VBox/Main/src-server/MachineImpl.cpp (modified) (8 diffs)
• src/VBox/Main/src-server/MediumAttachmentImpl.cpp (modified) (7 diffs)
• src/VBox/Main/xml/Settings.cpp (modified) (5 diffs)

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1510 +1510 @@
                             [--setparentuuid <uuid>]
                             [--passthrough on|off]
+                            [--tempeject on|off]
                             [--bandwidthgroup name|none]
                             [--forceunmount]
@@ -1670 +1671 @@
             support (currently experimental; see <xref
             linkend="storage-cds" />).</para>
+          </glossdef>
+        </glossentry>
+
+        <glossentry>
+          <glossterm>tempeject</glossterm>
+
+          <glossdef>
+            <para>For a virtual DVD drive only, you can configure the behavior
+            for guest-triggered medium eject. If this is set to "on", the eject
+            has only temporary effects. If the VM is powered off and restarted
+            the originally configured medium will be still in the drive.</para>
           </glossdef>
         </glossentry>

trunk/include/VBox/settings.h

@@ -806 +806 @@
         : deviceType(DeviceType_Null),
           fPassThrough(false),
+          fTempEject(false),
           lPort(0),
           lDevice(0)
@@ -816 +817 @@
     // DVDs can be in pass-through mode:
     bool                fPassThrough;
+
+    // Whether guest-triggered eject of DVDs will keep the medium in the
+    // VM config or not:
+    bool                fTempEject;
 
     int32_t             lPort;

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

@@ -466 +466 @@
                      "                            [--setparentuuid <uuid>]\n"
                      "                            [--passthrough on|off]\n"
+                     "                            [--tempeject on|off]\n"
                      "                            [--bandwidthgroup <name>]\n"
                      "                            [--forceunmount]\n"

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

@@ -52 +52 @@
     { "--mtype",            'M', RTGETOPT_REQ_STRING },
     { "--passthrough",      'h', RTGETOPT_REQ_STRING },
+    { "--tempeject",        'e', RTGETOPT_REQ_STRING },
     { "--bandwidthgroup",   'b', RTGETOPT_REQ_STRING },
     { "--forceunmount",     'f', RTGETOPT_REQ_NOTHING },
@@ -84 +85 @@
     const char *pszMedium = NULL;
     const char *pszPassThrough = NULL;
+    const char *pszTempEject = NULL;
     const char *pszBandwidthGroup = NULL;
     Bstr bstrNewUuid;
@@ -162 +164 @@
                 if (ValueUnion.psz)
                     pszPassThrough = ValueUnion.psz;
+                else
+                    rc = E_FAIL;
+                break;
+            }
+
+            case 'e':   // tempeject <on|off>
+            {
+                if (ValueUnion.psz)
+                    pszTempEject = ValueUnion.psz;
                 else
                     rc = E_FAIL;
@@ -682 +693 @@
         }
 
+        if (   pszTempEject
+            && (SUCCEEDED(rc)))
+        {
+            ComPtr<IMediumAttachment> mattach;
+            CHECK_ERROR(machine, GetMediumAttachment(Bstr(pszCtl).raw(), port,
+                                                     device, mattach.asOutParam()));
+
+            if (SUCCEEDED(rc))
+            {
+                if (!RTStrICmp(pszTempEject, "on"))
+                {
+                    CHECK_ERROR(machine, TemporaryEjectDevice(Bstr(pszCtl).raw(),
+                                                              port, device, TRUE));
+                }
+                else if (!RTStrICmp(pszTempEject, "off"))
+                {
+                    CHECK_ERROR(machine, TemporaryEjectDevice(Bstr(pszCtl).raw(),
+                                                              port, device, FALSE));
+                }
+                else
+                    throw Utf8StrFmt("Invalid --tempeject argument '%s'", pszTempEject);
+            }
+            else
+                throw Utf8StrFmt("Couldn't find the controller attachment for the controller '%s'\n", pszCtl);
+        }
+
         if (   pszBandwidthGroup
             && !fRunTime

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

@@ -4643 +4643 @@
     </method>
 
+    <method name="temporaryEjectDevice">
+      <desc>
+        Sets the behavior for guest-triggered medium eject. In some situations
+        it is desirable that such ejects update the VM configuration, and in
+        others the eject should keep the VM configuration. The device must
+        already exist; see <link to="IMachine::attachDevice"/> for how to
+        attach a new device.
+
+        The @a controllerPort and @a device parameters specify the device slot and
+        have have the same meaning as with <link to="IMachine::attachDevice" />.
+
+        <result name="E_INVALIDARG">
+          SATA device, SATA port, IDE port or IDE slot out of range.
+        </result>
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Attempt to modify an unregistered virtual machine.
+        </result>
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Invalid machine state.
+        </result>
+
+      </desc>
+      <param name="name" type="wstring" dir="in">
+        <desc>Name of the storage controller.</desc>
+      </param>
+      <param name="controllerPort" type="long" dir="in">
+        <desc>Storage controller port.</desc>
+      </param>
+      <param name="device" type="long" dir="in">
+        <desc>Device slot in the given port.</desc>
+      </param>
+      <param name="temporaryEject" type="boolean" dir="in">
+        <desc>New value for the eject behavior.</desc>
+      </param>
+    </method>
+
     <method name="setBandwidthGroupForDevice">
       <desc>
@@ -9572 +9608 @@
   <interface
     name="IMediumAttachment" extends="$unknown"
-    uuid="8d48f68f-807a-4e4e-9449-827fe9ea8498"
+    uuid="b5dfbb8c-7498-48c3-bf10-78fc60f064e1"
     wsmap="struct"
     >
@@ -9783 +9819 @@
     <attribute name="passthrough" type="boolean" readonly="yes">
       <desc>Pass I/O requests through to a device on the host.</desc>
+    </attribute>
+
+    <attribute name="temporaryEject" type="boolean" readonly="yes">
+      <desc>Whether guest-triggered eject results in unmounting the medium.</desc>
     </attribute>
 

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

@@ -477 +477 @@
     STDMETHOD(DetachDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice);
     STDMETHOD(PassthroughDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice, BOOL aPassthrough);
+    STDMETHOD(TemporaryEjectDevice)(IN_BSTR aControllerName, LONG aControllerPort, LONG aDevice, BOOL aTempEject);
     STDMETHOD(SetBandwidthGroupForDevice)(IN_BSTR aControllerName, LONG aControllerPort,
                                           LONG aDevice, IBandwidthGroup *aBandwidthGroup);

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

@@ -47 +47 @@
                  LONG aDevice,
                  DeviceType_T aType,
+                 bool fImplicit,
                  bool fPassthrough,
+                 bool fTempEject,
                  const Utf8Str &strBandwidthGroup);
     void uninit();
@@ -61 +63 @@
     STDMETHOD(COMGETTER(Type))(DeviceType_T *aType);
     STDMETHOD(COMGETTER(Passthrough))(BOOL *aPassthrough);
+    STDMETHOD(COMGETTER(TemporaryEject))(BOOL *aTemporaryEject);
     STDMETHOD(COMGETTER(IsEjected))(BOOL *aIsEjected);
     STDMETHOD(COMGETTER(BandwidthGroup))(IBandwidthGroup **aBwGroup);
@@ -79 +82 @@
     DeviceType_T getType() const;
     bool getPassthrough() const;
+    bool getTempEject() const;
     const Utf8Str& getBandwidthGroup() const;
 
@@ -88 +92 @@
     /** Must be called from under this object's write lock. */
     void updatePassthrough(bool aPassthrough);
+
+    /** Must be called from under this object's write lock. */
+    void updateTempEject(bool aTempEject);
 
     /** Must be called from under this object's write lock. */

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

@@ -3802 +3802 @@
                           aType,
                           fIndirect,
+                          false /* fPassthrough */,
+                          false /* fTempEject */,
                           Utf8Str::Empty);
     if (FAILED(rc)) return rc;
@@ -3955 +3957 @@
                         aDevice, aControllerPort, aControllerName);
     pAttach->updatePassthrough(!!aPassthrough);
+
+    return S_OK;
+}
+
+STDMETHODIMP Machine::TemporaryEjectDevice(IN_BSTR aControllerName, LONG aControllerPort,
+                                           LONG aDevice, BOOL aTemporaryEject)
+{
+    CheckComArgStrNotEmptyOrNull(aControllerName);
+
+    LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld aTemporaryEject=%d\n",
+                     aControllerName, aControllerPort, aDevice, aTemporaryEject));
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    HRESULT rc = checkStateDependency(MutableStateDep);
+    if (FAILED(rc)) return rc;
+
+    MediumAttachment *pAttach = findAttachment(mMediaData->mAttachments,
+                                               aControllerName,
+                                               aControllerPort,
+                                               aDevice);
+    if (!pAttach)
+        return setError(VBOX_E_OBJECT_NOT_FOUND,
+                        tr("No storage device attached to device slot %d on port %d of controller '%ls'"),
+                        aDevice, aControllerPort, aControllerName);
+
+
+    setModified(IsModified_Storage);
+    mMediaData.backup();
+
+    AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
+
+    if (pAttach->getType() != DeviceType_DVD)
+        return setError(E_INVALIDARG,
+                        tr("Setting passthrough rejected as the device attached to device slot %d on port %d of controller '%ls' is not a DVD"),
+                        aDevice, aControllerPort, aControllerName);
+    pAttach->updateTempEject(!!aTemporaryEject);
 
     return S_OK;
@@ -8053 +8095 @@
                                dev.lDevice,
                                dev.deviceType,
+                               false,
                                dev.fPassThrough,
+                               dev.fTempEject,
                                pBwGroup.isNull() ? Utf8Str::Empty : pBwGroup->getName());
         if (FAILED(rc)) break;
@@ -9000 +9044 @@
                 dev.uuid = pMedium->getId();
             dev.fPassThrough = pAttach->getPassthrough();
+            dev.fTempEject = pAttach->getTempEject();
         }
 
@@ -9321 +9366 @@
                                   DeviceType_HardDisk,
                                   true /* aImplicit */,
+                                  false /* aPassthrough */,
+                                  false /* aTempEject */,
                                   pAtt->getBandwidthGroup());
             if (FAILED(rc)) throw rc;
@@ -11653 +11700 @@
     if (FAILED(autoCaller.rc())) return autoCaller.rc();
 
-    /* Need to query the details first, as the IMediumAttachment reference
-     * might be to the original settings, which we are going to change. */
-    Bstr ctrlName;
-    HRESULT rc = aAttachment->COMGETTER(Controller)(ctrlName.asOutParam());
-    AssertComRC(rc);
-    LONG lDev;
-    rc = aAttachment->COMGETTER(Device)(&lDev);
-    AssertComRC(rc);
-    LONG lPort;
-    rc = aAttachment->COMGETTER(Port)(&lPort);
-    AssertComRC(rc);
-
     // request the host lock first, since might be calling Host methods for getting host drives;
     // next, protect the media tree all the while we're in here, as well as our member variables
@@ -11673 +11708 @@
     ComObjPtr<MediumAttachment> pAttach = static_cast<MediumAttachment *>(aAttachment);
 
-    /* Remember previously mounted medium. The medium before taking the
-     * backup is not necessarily the same thing. */
-    ComObjPtr<Medium> oldmedium;
-    oldmedium = pAttach->getMedium();
-
-    setModified(IsModified_Storage);
-    mMediaData.backup();
-
-    GuidList llRegistriesThatNeedSaving;
-
-    {
+    Bstr ctrlName;
+    LONG lPort;
+    LONG lDevice;
+    bool fTempEject;
+    {
+        AutoCaller autoAttachCaller(this);
+        if (FAILED(autoAttachCaller.rc())) return autoAttachCaller.rc();
+
+        AutoReadLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
+
+        /* Need to query the details first, as the IMediumAttachment reference
+         * might be to the original settings, which we are going to change. */
+        ctrlName = pAttach->getControllerName();
+        lPort = pAttach->getPort();
+        lDevice = pAttach->getDevice();
+        fTempEject = pAttach->getTempEject();
+    }
+
+    if (!fTempEject)
+    {
+        /* Remember previously mounted medium. The medium before taking the
+         * backup is not necessarily the same thing. */
+        ComObjPtr<Medium> oldmedium;
+        oldmedium = pAttach->getMedium();
+
+        setModified(IsModified_Storage);
+        mMediaData.backup();
+
         // The backup operation makes the pAttach reference point to the
         // old settings. Re-get the correct reference.
@@ -11689 +11741 @@
                                  ctrlName.raw(),
                                  lPort,
-                                 lDev);
-        AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
-        if (!oldmedium.isNull())
-            oldmedium->removeBackReference(mData->mUuid);
-
-        pAttach->updateMedium(NULL);
-        pAttach->updateEjected();
-
-        pAttach.queryInterfaceTo(aNewAttachment);
-    }
-
-    setModified(IsModified_Storage);
-
-    multiLock.release();
-
-    mParent->saveRegistries(llRegistriesThatNeedSaving);
-
-    return rc;
+                                 lDevice);
+
+        {
+            AutoCaller autoAttachCaller(this);
+            if (FAILED(autoAttachCaller.rc())) return autoAttachCaller.rc();
+
+            AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
+            if (!oldmedium.isNull())
+                oldmedium->removeBackReference(mData->mUuid);
+
+            pAttach->updateMedium(NULL);
+            pAttach->updateEjected();
+        }
+
+        setModified(IsModified_Storage);
+    }
+    else
+    {
+        {
+            AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
+            pAttach->updateEjected();
+        }
+    }
+
+    pAttach.queryInterfaceTo(aNewAttachment);
+
+    return S_OK;
 }
 

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

@@ -40 +40 @@
           type(DeviceType_Null),
           fPassthrough(false),
+          fTempEject(false),
           fImplicit(false)
     { }
@@ -56 +57 @@
     const DeviceType_T  type;
     bool                fPassthrough;
+    bool                fTempEject;
     bool                fImplicit;
 };
@@ -112 +114 @@
                                LONG aDevice,
                                DeviceType_T aType,
+                               bool aImplicit,
                                bool aPassthrough,
+                               bool aTempEject,
                                const Utf8Str &strBandwidthGroup)
 {
     LogFlowThisFuncEnter();
-    LogFlowThisFunc(("aParent=%p aMedium=%p aControllerName=%ls aPort=%d aDevice=%d aType=%d aPassthrough=%d\n", aParent, aMedium, aControllerName.raw(), aPort, aDevice, aType, aPassthrough));
+    LogFlowThisFunc(("aParent=%p aMedium=%p aControllerName=%ls aPort=%d aDevice=%d aType=%d aImplicit=%d aPassthrough=%d aTempEject=%d\n", aParent, aMedium, aControllerName.raw(), aPort, aDevice, aType, aImplicit, aPassthrough, aTempEject));
 
     if (aType == DeviceType_HardDisk)
@@ -138 +142 @@
 
     m->bd->fPassthrough = aPassthrough;
-    /* Newly created attachments never have an implicitly created medium
-     * associated with them. Implicit diff image creation happens later. */
-    m->bd->fImplicit = false;
+    m->bd->fTempEject = aTempEject;
+    m->bd->fImplicit = aImplicit;
 
     /* Confirm a successful initialization when it's the case */
@@ -282 +285 @@
 }
 
+STDMETHODIMP MediumAttachment::COMGETTER(TemporaryEject)(BOOL *aTemporaryEject)
+{
+    LogFlowThisFuncEnter();
+
+    CheckComArgOutPointerValid(aTemporaryEject);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    AutoReadLock lock(this COMMA_LOCKVAL_SRC_POS);
+
+    *aTemporaryEject = m->bd->fTempEject;
+
+    LogFlowThisFuncLeave();
+    return S_OK;
+}
+
 STDMETHODIMP MediumAttachment::COMGETTER(IsEjected)(BOOL *aEjected)
 {
@@ -403 +423 @@
 }
 
+bool MediumAttachment::getTempEject() const
+{
+    AutoReadLock lock(this COMMA_LOCKVAL_SRC_POS);
+    return m->bd->fTempEject;
+}
+
 const Utf8Str& MediumAttachment::getBandwidthGroup() const
 {
@@ -439 +465 @@
 
 /** Must be called from under this object's write lock. */
+void MediumAttachment::updateTempEject(bool aTempEject)
+{
+    Assert(isWriteLockOnCurrentThread());
+
+    m->bd.backup();
+    m->bd->fTempEject = aTempEject;
+}
+
+/** Must be called from under this object's write lock. */
 void MediumAttachment::updateEjected()
 {

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

@@ -1691 +1691 @@
              || (    (deviceType                == a.deviceType)
                   && (fPassThrough              == a.fPassThrough)
+                  && (fTempEject                == a.fTempEject)
                   && (lPort                     == a.lPort)
                   && (lDevice                   == a.lDevice)
@@ -2991 +2992 @@
                     att.deviceType = DeviceType_DVD;
                     pelmAttached->getAttributeValue("passthrough", att.fPassThrough);
+                    pelmAttached->getAttributeValue("tempeject", att.fTempEject);
                 }
                 else if (strTemp == "Floppy")
@@ -3062 +3064 @@
             att.lDevice = 0;
             pelmHwChild->getAttributeValue("passthrough", att.fPassThrough);
+            pelmHwChild->getAttributeValue("tempeject", att.fTempEject);
 
             const xml::ElementNode *pDriveChild;
@@ -3685 +3688 @@
 
                         pelmDVD->setAttribute("passthrough", att.fPassThrough);
+                        if (att.fTempEject)
+                            pelmDVD->setAttribute("tempeject", att.fTempEject);
                         if (!att.uuid.isEmpty())
                             pelmDVD->createChild("Image")->setAttribute("uuid", att.uuid.toStringCurly());
@@ -4229 +4234 @@
                     pcszType = "DVD";
                     pelmDevice->setAttribute("passthrough", att.fPassThrough);
+                    if (att.fTempEject)
+                        pelmDevice->setAttribute("tempeject", att.fTempEject);
                 break;