Changeset 17359 in vbox for trunk/src

Timestamp:

Mar 4, 2009 5:54:03 PM (16 years ago)

Author:

vboxsync

Message:

Main: Prototyped IHardDisk::autoReset and reset (including XML structure changes, backward compatible).

Location:

trunk/src/VBox/Main

Files:

• HardDiskImpl.cpp (modified) (9 diffs)
• idl/VirtualBox.xidl (modified) (4 diffs)
• include/HardDiskImpl.h (modified) (4 diffs)
• xml/VirtualBox-settings-common.xsd (modified) (4 diffs)

trunk/src/VBox/Main/HardDiskImpl.cpp

@@ -59 +59 @@
 {
     enum Operation { CreateDynamic, CreateFixed, CreateDiff,
-                     Merge, Clone, Delete };
+                     Merge, Clone, Delete, Reset };
 
     HardDisk *that;
@@ -509 +509 @@
  * @param aLocaiton     Storage unit location.
  */
-HRESULT HardDisk::init(VirtualBox *aVirtualBox, CBSTR aFormat,
-                       CBSTR aLocation)
+HRESULT HardDisk::init (VirtualBox *aVirtualBox, CBSTR aFormat,
+                        CBSTR aLocation)
 {
     AssertReturn (aVirtualBox != NULL, E_FAIL);
@@ -644 +644 @@
  *
  * @param aVirtualBox   VirtualBox object.
- * @param aParent       Parent hard disk or NULL for a root hard disk.
+ * @param aParent       Parent hard disk or NULL for a root (base) hard disk.
  * @param aNode         <HardDisk> settings node.
  *
  * @note Locks VirtualBox lock for writing, treeLock() for writing.
  */
-HRESULT HardDisk::init(VirtualBox *aVirtualBox, HardDisk *aParent,
-                       const settings::Key &aNode)
+HRESULT HardDisk::init (VirtualBox *aVirtualBox, HardDisk *aParent,
+                        const settings::Key &aNode)
 {
     using namespace settings;
@@ -698 +698 @@
     rc = setFormat (format);
     CheckComRCReturnRC (rc);
+
+    /* optional, only for diffs, default is false */
+    if (aParent != NULL)
+        mm.autoReset = aNode.value <bool> ("autoReset");
+    else
+        mm.autoReset = false;
 
     /* properties (after setting the format as it populates the map). Note that
@@ -976 +982 @@
 STDMETHODIMP HardDisk::COMGETTER(LogicalSize) (ULONG64 *aLogicalSize)
 {
-    if (aLogicalSize == NULL)
-        return E_POINTER;
+    CheckComArgOutPointerValid (aLogicalSize);
 
     {
@@ -1003 +1008 @@
 
     return root()->COMGETTER (LogicalSize) (aLogicalSize);
+}
+
+STDMETHODIMP HardDisk::COMGETTER(AutoReset) (BOOL *aAutoReset)
+{
+    CheckComArgOutPointerValid (aAutoReset);
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    AutoReadLock alock (this);
+
+    if (mParent.isNull())
+        *aAutoReset = FALSE;
+
+    *aAutoReset = mm.autoReset;
+
+    return S_OK;
+}
+
+STDMETHODIMP HardDisk::COMSETTER(AutoReset) (BOOL aAutoReset)
+{
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    /* VirtualBox::saveSettings() needs a write lock */
+    AutoMultiWriteLock2 alock (mVirtualBox, this);
+
+    if (mParent.isNull())
+        return setError (VBOX_E_NOT_SUPPORTED,
+            tr ("Hard disk '%ls' is not differencing"),
+            m.locationFull.raw());
+
+    if (mm.autoReset != aAutoReset)
+    {
+        mm.autoReset = aAutoReset;
+
+        return mVirtualBox->saveSettings();
+    }
+
+    return S_OK;
 }
 
@@ -1394 +1439 @@
 }
 
+STDMETHODIMP HardDisk::Reset (IProgress **aProgress)
+{
+    CheckComArgOutPointerValid (aProgress);
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    AutoWriteLock alock (this);
+
+    HRESULT rc = LockWrite (NULL);
+    CheckComRCReturnRC (rc);
+
+    ComObjPtr <Progress> progress;
+
+    try
+    {
+        progress.createObject();
+        rc = progress->init (mVirtualBox, static_cast <IHardDisk *> (this),
+            BstrFmt (tr ("Resettng differencing hard disk '%ls'"),
+                     m.locationFull.raw()),
+            FALSE /* aCancelable */);
+        CheckComRCThrowRC (rc);
+
+        /* setup task object and thread to carry out the operation
+         * asynchronously */
+
+        std::auto_ptr <Task> task (new Task (this, progress, Task::Reset));
+        AssertComRCThrowRC (task->autoCaller.rc());
+
+        rc = task->startThread();
+        CheckComRCThrowRC (rc);
+
+        /* task is now owned (or already deleted) by taskThread() so release it */
+        task.release();
+    }
+    catch (HRESULT aRC)
+    {
+        rc = aRC;
+    }
+
+    if (FAILED (rc))
+    {
+        HRESULT rc2 = UnlockWrite (NULL);
+        AssertComRC (rc2);
+        /* Note: on success, taskThread() will unlock this */
+    }
+    else
+    {
+        /* return progress to the caller */
+        progress.queryInterfaceTo (aProgress);
+    }
+
+    return rc;
+}
+
 // public methods for internal purposes only
 ////////////////////////////////////////////////////////////////////////////////
@@ -1553 +1653 @@
     /* required */
     diskNode.setValue <Bstr> ("format", mm.format);
+    /* optional, only for diffs, default is false */
+    if (!mParent.isNull())
+        diskNode.setValueOr <bool> ("autoReset", !!mm.autoReset, false);
     /* optional */
     if (!m.description.isNull())
@@ -4052 +4155 @@
         }
 
+        case Task::Reset:
+        {
+            /// @todo
+
+            if (isAsync)
+            {
+                /* unlock ourselves when done */
+                HRESULT rc2 = that->UnlockWrite (NULL);
+                AssertComRC (rc2);
+            }
+
+            /* Note that in sync mode, it's the caller's responsibility to
+             * unlock the hard disk */
+
+            break;
+        }
+
         default:
             AssertFailedReturn (VERR_GENERAL_FAILURE);

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

@@ -8314 +8314 @@
   <interface
     name="IHardDisk" extends="IMedium"
-    uuid="244f89fe-1943-464d-baad-2efd73e5d532"
+    uuid="a4d391a5-e2b1-474d-824e-2ff668a92d58"
     wsmap="managed"
   >
@@ -8711 +8711 @@
     </attribute>
 
+    <attribute name="autoReset" type="boolean">
+      <desc>
+        Whether this differencing hard disk will be automatically reset each
+        time a virtual machine it is attached to is powered up.
+
+        See <link to="#reset()"/> for more information about resetting
+        differencing hard disks.
+
+        <note>
+          Reading this property on a base (non-differencing) hard disk will
+          always <tt>false</tt>. Changing the value of this property in this
+          case is not supported.
+        </note>
+
+        <result name="VBOX_E_NOT_SUPPORTED">
+          This is not a differencing hard disk (when changing the attribute
+          value).
+        </result>
+      </desc>
+    </attribute>
+
     <!-- storage methods -->
 
@@ -9118 +9139 @@
     </method>
 
+    <!-- other methods -->
+
     <method name="compact">
       <desc>
@@ -9125 +9148 @@
         substantial amount of additional disk space.
 
-        After the returned progress object reports that the operation is
-        successfully complete, the media state will be set back to the
-        current state.
-
-        <note>
-          This hard disk and all its parent hard disks will be placed to <link
-          to="MediaState_LockedRead"/> state for the duration of this
-          operation.
-        </note>
+        This hard disk will be placed to <link to="MediaState_LockedWrite"/>
+        state and all its parent hard disks (if any) will be placed to
+        <link to="MediaState_LockedRead"/> state for the duration of this
+        operation.
+      </desc>
+      <param name="progress" type="IProgress" dir="return">
+        <desc>Progress object to track the operation completion.</desc>
+      </param>
+    </method>
+
+    <method name="reset">
+      <desc>
+        Starts erasing the contents of this differencing hard disk.
+
+        This operation will reset the differencing hard disk to its initial
+        state when it does not contain any sector data and any read operation is
+        redirected to its parent hard disk.
+
+        This hard disk will be placed to <link to="MediaState_LockedWrite"/>
+        for the duration of this operation.
+
+        <result name="VBOX_E_NOT_SUPPORTED">
+          This is not a differencing hard disk.
+        </result>
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Hard disk is not in <link to="MediaState_Created"/> or
+          <link to="MediaState_Inaccessible"/> state.
+        </result>
       </desc>
       <param name="progress" type="IProgress" dir="return">

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

@@ -97 +97 @@
     STDMETHOD(COMGETTER(ReadOnly)) (BOOL *aReadOnly);
     STDMETHOD(COMGETTER(LogicalSize)) (ULONG64 *aLogicalSize);
+    STDMETHOD(COMGETTER(AutoReset)) (BOOL *aAutoReset);
+    STDMETHOD(COMSETTER(AutoReset)) (BOOL aAutoReset);
 
     // IHardDisk methods
@@ -114 +116 @@
     STDMETHOD(FlattenTo) (IHardDisk *aTarget, IProgress **aProgress);
     STDMETHOD(Compact) (IProgress **aProgress);
+    STDMETHOD(Reset) (IProgress **aProgress);
 
     // public methods for internal purposes only
@@ -269 +272 @@
     struct Data
     {
-        Data() : type (HardDiskType_Normal), logicalSize (0)
+        Data() : type (HardDiskType_Normal), logicalSize (0), autoReset (false)
                , implicit (false), numCreateDiffTasks (0)
                , vdProgress (NULL) , vdDiskIfaces (NULL) {}
@@ -279 +282 @@
         uint64_t logicalSize;   /*< In MBytes. */
 
+        BOOL autoReset : 1;
+
         typedef std::map <Bstr, Bstr> PropertyMap;
         PropertyMap properties;

trunk/src/VBox/Main/xml/VirtualBox-settings-common.xsd

@@ -263 +263 @@
 -->
 
-<xsd:complexType name="TDiffHardDisk2">
+<xsd:complexType name="THardDiskBase">
   <xsd:sequence>
     <xsd:element name="Description" type="xsd:string" minOccurs="0"/>
@@ -272 +272 @@
       </xsd:complexType>
     </xsd:element>
-    <xsd:element name="HardDisk" type="TDiffHardDisk2" minOccurs="0" maxOccurs="unbounded"/>
+    <xsd:element name="HardDisk" type="TDiffHardDisk" minOccurs="0" maxOccurs="unbounded"/>
   </xsd:sequence>
   <xsd:attribute name="uuid" type="TNonNullUUID" use="required"/>
@@ -279 +279 @@
 </xsd:complexType>
 
-<xsd:complexType name="THardDisk2">
+<xsd:complexType name="TDiffHardDisk">
   <xsd:complexContent>
-    <xsd:extension base="TDiffHardDisk2">
+    <xsd:extension base="THardDiskBase">
+      <xsd:attribute name="autoReset" type="xsd:boolean" default="false"/>
+    </xsd:extension>
+  </xsd:complexContent>
+</xsd:complexType>
+
+<xsd:complexType name="THardDisk">
+  <xsd:complexContent>
+    <xsd:extension base="THardDiskBase">
       <xsd:attribute name="type" use="required">
         <xsd:simpleType>
@@ -374 +382 @@
             <xsd:complexType>
               <xsd:sequence>
-                <xsd:element name="HardDisk" type="THardDisk2" minOccurs="0" maxOccurs="unbounded"/>
+                <xsd:element name="HardDisk" type="THardDisk" minOccurs="0" maxOccurs="unbounded"/>
               </xsd:sequence>
             </xsd:complexType>