Changeset 14783 in vbox for trunk/src/VBox/Main

Timestamp:

Nov 28, 2008 2:55:59 PM (16 years ago)

Author:

vboxsync

Message:

Main: Treat hard disks with no Create capabilities as Created right after IVirtualBox::createHardDisk2() and don't allow IHardDisk2::create*Storage()/deleteStorage() for them.

Location:

trunk/src/VBox/Main

Files:

• HardDisk2Impl.cpp (modified) (12 diffs)
• VirtualBoxImpl.cpp (modified) (1 diff)
• idl/VirtualBox.xidl (modified) (5 diffs)
• include/HardDisk2Impl.h (modified) (1 diff)
• testcase/tstAPI.cpp (modified) (2 diffs)

trunk/src/VBox/Main/HardDisk2Impl.cpp

@@ -438 +438 @@
     mm.vdIfCallsProgress.enmInterface = VDINTERFACETYPE_PROGRESS;
     mm.vdIfCallsProgress.pfnProgress = vdProgressCall;
+
+    /* Initialize the callbacks of the VD config interface */
+    mm.vdIfCallsConfig.cbSize = sizeof (VDINTERFACEPROGRESS);
+    mm.vdIfCallsConfig.enmInterface = VDINTERFACETYPE_CONFIG;
+/// @todo later
+//  mm.vdIfCallsConfig.pfnAreValuesValid = ...;
+//  mm.vdIfCallsConfig.pfnQueryBytes = ...;
 
     /* Initialize the per-disk interface chain */
@@ -467 +474 @@
  * storage unit.
  *
+ * For hard disks that don't have the VD_CAP_CREATE_FIXED or
+ * VD_CAP_CREATE_DYNAMIC capability (and therefore cannot be created or deleted
+ * with the means of VirtualBox) the associated storage unit is assumed to be
+ * ready for use so the state of the hard disk object will be set to Created.
+ *
  * @param aVirtualBox   VirtualBox object.
  * @param aLocaiton     Storage unit location.
@@ -473 +485 @@
                          const BSTR aLocation)
 {
-    AssertReturn (aVirtualBox != NULL, E_INVALIDARG);
-    AssertReturn (aLocation != NULL, E_INVALIDARG);
-    AssertReturn (aFormat != NULL && *aFormat != '\0', E_INVALIDARG);
+    AssertReturn (aVirtualBox != NULL, E_FAIL);
+    AssertReturn (aFormat != NULL && *aFormat != '\0', E_FAIL);
 
     /* Enclose the state transition NotReady->InInit->Ready */
@@ -498 +509 @@
     CheckComRCReturnRC (rc);
 
-    rc = setLocation (aLocation);
-    CheckComRCReturnRC (rc);
+    if (mm.formatObj->capabilities() & HardDiskFormatCapabilities_File)
+    {
+        rc = setLocation (aLocation);
+        CheckComRCReturnRC (rc);
+    }
+    else
+    {
+        rc = setLocation (aLocation);
+        CheckComRCReturnRC (rc);
+
+        /// @todo later we may want to use a pfnComposeLocation backend info
+        /// callback to generate a well-formed location value (based on the hard
+        /// disk properties we have) rather than allowing each caller to invent
+        /// its own (pseudo-)location.
+    }
+
+    if (!(mm.formatObj->capabilities() &
+          (HardDiskFormatCapabilities_CreateFixed |
+           HardDiskFormatCapabilities_CreateDynamic)))
+    {
+        /* storage for hard disks of this format can neither be explicitly
+         * created by VirtualBox nor deleted, so we place the hard disk to
+         * Created state here and also add it to the registry */
+        m.state = MediaState_Created;
+        unconst (m.id).create();
+        rc = mVirtualBox->registerHardDisk2 (this);
+
+        /// @todo later we may want to use a pfnIsConfigSufficient backend info
+        /// callback that would tell us when we have enough properties to work
+        /// with the hard disk and this information could be used to actually
+        /// move such hard disks from NotCreated to Created state. Instead of
+        /// pfnIsConfigSufficient we can use HardDiskFormat property
+        /// descriptions to see which properties are mandatory
+    }
 
     /* Confirm a successful initialization when it's the case */
@@ -626 +669 @@
     CheckComRCReturnRC (rc);
 
-    /* properties (note: after setting the format as it populates the map) */
+    /* properties (after setting the format as it populates the map). Note that
+     * if some properties are not supported but preseint in the settings file,
+     * they will still be read and accessible (for possible backward
+     * compatibility; we can also clean them up from the XML upon next
+     * XML format versino change if we wish) */
     Key::List properties = aNode.keys ("Property");
     for (Key::List::const_iterator it = properties.begin();
@@ -1024 +1071 @@
     AutoWriteLock alock (this);
 
+    if (!(mm.formatObj->capabilities() &
+          HardDiskFormatCapabilities_CreateDynamic))
+        return setError (VBOX_E_NOT_SUPPORTED,
+            tr ("Hard disk format '%ls' does not support dynamic storage "
+                "creation"), mm.format.raw());
+
     switch (m.state)
     {
@@ -1031 +1084 @@
             return setStateError();
     }
-
-    /// @todo NEWMEDIA use backend capabilities to decide if dynamic storage
-    /// is supported
 
     ComObjPtr <Progress> progress;
@@ -1076 +1126 @@
 
     AutoWriteLock alock (this);
+
+    if (!(mm.formatObj->capabilities() &
+          HardDiskFormatCapabilities_CreateFixed))
+        return setError (VBOX_E_NOT_SUPPORTED,
+            tr ("Hard disk format '%ls' does not support fixed storage "
+                "creation"), mm.format.raw());
 
     switch (m.state)
@@ -1469 +1525 @@
     return name;
 }
-
-/// @todo NEWMEDIA remove, should not need anymore
-#if 0
-
-/**
- * Returns @c true if the given location is a file in the host's filesystem.
- *
- * @param aLocation     Location to check.
- */
-/*static*/
-bool HardDisk2::isFileLocation (const char *aLocation)
-{
-    /// @todo NEWMEDIA need some library that deals with URLs in a generic way
-
-    if (aLocation == NULL)
-        return false;
-
-    size_t len = strlen (aLocation);
-
-    /* unix-like paths */
-    if (len >= 1 && RTPATH_IS_SLASH (aLocation [0]))
-        return true;
-
-    /* dos-like paths */
-    if (len >= 2 && RTPATH_IS_VOLSEP (aLocation [1]) &&
-        ((aLocation [0] >= 'A' && aLocation [0] <= 'Z') ||
-         (aLocation [0] >= 'a' && aLocation [0] <= 'z')))
-        return true;
-
-    /* if there is a '<protocol>:' suffux which is not 'file:', return false */
-    const char *s = strchr (aLocation, ':');
-    if (s != NULL)
-    {
-        if (s - aLocation != 4)
-            return false;
-        if ((aLocation [0] != 'f' && aLocation [0] == 'F') ||
-            (aLocation [1] != 'i' && aLocation [1] == 'I') ||
-            (aLocation [2] != 'l' && aLocation [2] == 'L') ||
-            (aLocation [3] != 'e' && aLocation [3] == 'E'))
-            return false;
-    }
-
-    /* everything else is treaten as file */
-    return true;
-}
-
-#endif /* if 0 */
 
 /**
@@ -1835 +1844 @@
 
     AutoWriteLock alock (this);
+
+    if (!(mm.formatObj->capabilities() &
+          (HardDiskFormatCapabilities_CreateDynamic |
+           HardDiskFormatCapabilities_CreateFixed)))
+        return setError (VBOX_E_NOT_SUPPORTED,
+            tr ("Hard disk format '%ls' does not support storage deletion "),
+            mm.format.raw());
 
     switch (m.state)
@@ -2353 +2369 @@
 HRESULT HardDisk2::setLocation (const BSTR aLocation)
 {
-    if (aLocation == NULL)
-        return E_INVALIDARG;
+    /// @todo so far, we assert but later it makes sense to support null
+    /// locations for hard disks that are not yet created fail to create a
+    /// storage unit instead
+    CheckComArgStrNotEmptyOrNull (aLocation);
 
     AutoCaller autoCaller (this);
@@ -2504 +2522 @@
             = mVirtualBox->systemProperties()->hardDiskFormat (aFormat);
         if (mm.formatObj.isNull())
-            return setError (E_FAIL,
+            return setError (VBOX_E_OBJECT_NOT_FOUND,
                 tr ("Invalid hard disk storage format '%ls'"), aFormat);
 

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -1087 +1087 @@
                                           IHardDisk2 **aHardDisk)
 {
-    if (!aFormat)
-        return E_INVALIDARG;
-    if (!aLocation)
-        return E_INVALIDARG;
-    if (!aHardDisk)
-        return E_POINTER;
+    CheckComArgStrNotEmptyOrNull (aFormat);
+    CheckComArgOutPointerValid (aHardDisk);
 
     AutoCaller autoCaller (this);

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

@@ -316 +316 @@
   </result>
 
+  <result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
+    <desc>
+       Requested operation is not supported.
+    </desc>
+  </result>
+
   <!--
     Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
@@ -1602 +1608 @@
         See <link to="IMedium::location"/>, IHardDisk2 and
         <link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
+
+        <result name="VBOX_E_OBJECT_NOT_FOUND">
+          @a format identifier is invalid. See
+          <link to="ISystemProperties::hardDiskFormats"/>.
+        </result>
+        <result name="VBOX_E_FILE_ERROR">
+          @a location is a not valid file name (for file-based formats only).
+        </result>
+        <result name="E_INVALIDARG">
+          @a format is a null or empty string.
+        </result>
       </desc>
       <param name="format" type="wstring" dir="in">
@@ -7389 +7406 @@
         to="MediaState::Created"/>, the hard disk will be remembered by this
         VirtualBox installation and may be attached to virtual machines.
+
+        <result name="VBOX_E_NOT_SUPPORTED">
+          Dynamic storage creation operation is not supported. See <link
+          to="IHardDiskFormat::capabilities"/>.
+        </result>
       </desc>
       <param name="logicalSize" type="unsigned long long" dir="in">
@@ -7414 +7436 @@
         to="MediaState::Created"/>, the hard disk will be remembered by this
         VirtualBox installation and may be attached to virtual machines.
+
+        <result name="VBOX_E_NOT_SUPPORTED">
+          Fixed storage creation operation is not supported. See
+          <link to="IHardDiskFormat::capabilities"/>.
+        </result>
       </desc>
       <param name="logicalSize" type="unsigned long long" dir="in">
@@ -7449 +7476 @@
         <result name="VBOX_E_OBJECT_IN_USE">
           Hard disk is attached to a virtual machine.
+        </result>
+        <result name="VBOX_E_NOT_SUPPORTED">
+          Storage deletion is not allowed because neither of storage creation
+          operations are supported. See
+          <link to="IHardDiskFormat::capabilities"/>.
         </result>
       </desc>

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

@@ -285 +285 @@
         VDINTERFACEPROGRESS vdIfCallsProgress;
 
+        VDINTERFACE vdIfConfig;
+        VDINTERFACECONFIG vdIfCallsConfig;
+
         PVDINTERFACE vdDiskIfaces;
     };

trunk/src/VBox/Main/testcase/tstAPI.cpp

@@ -641 +641 @@
                     printf (" <none>\n");
 
+#if 0
                 Bstr name ("TargetAddress");
                 Bstr value = Utf8StrFmt ("lalala (%llu)", RTTimeMilliTS());
@@ -646 +647 @@
                 printf ("Settings property %ls to %ls...\n", name.raw(), value.raw());
                 CHECK_ERROR (hd, SetProperty (name, value));
+#endif
             }
             else