Changeset 37525 in vbox

Timestamp:

Jun 17, 2011 10:09:21 AM (13 years ago)

Author:

vboxsync

Message:

Main/VirtualBox+Medium: resurrect the feature of changing the medium UUID when opening the image, which allows to resolve duplicate UUIDs without using external tools. Also fixes Medium::setIDs, which wasn't correctly working.
Frontends/*: corresponding changes.

Location:

trunk

Files:

• doc/manual/en_US/SDKRef.xml (modified) (1 diff)
• doc/manual/en_US/user_VBoxManage.xml (modified) (2 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManage.h (modified) (2 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageDisk.cpp (modified) (7 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageModifyVM.cpp (modified) (4 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageStorageController.cpp (modified) (5 diffs)
• src/VBox/Frontends/VBoxSDL/VBoxSDL.cpp (modified) (4 diffs)
• src/VBox/Frontends/VirtualBox/src/VBoxMediaManagerDlg.cpp (modified) (2 diffs)
• src/VBox/Frontends/VirtualBox/src/globals/VBoxGlobal.cpp (modified) (1 diff)
• src/VBox/Frontends/VirtualBox/src/runtime/UISession.cpp (modified) (2 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
• src/VBox/Main/include/MediumImpl.h (modified) (2 diffs)
• src/VBox/Main/include/VirtualBoxImpl.h (modified) (1 diff)
• src/VBox/Main/src-server/MediumImpl.cpp (modified) (13 diffs)
• src/VBox/Main/src-server/VirtualBoxImpl.cpp (modified) (2 diffs)
• src/VBox/Main/testcase/tstVBoxAPILinux.cpp (modified) (2 diffs)

trunk/doc/manual/en_US/SDKRef.xml

@@ -3448 +3448 @@
       <itemizedlist>
         <listitem>
+          <para>The method <xref linkend="IVirtualBox__openMedium"
+          xreflabel="IVirtualBox::openMedium()" /> has one more parameter
+          now, which allows resolving duplicate medium UUIDs without the need
+          for external tools.</para>
+        </listitem>
+
+        <listitem>
           <para>The <xref linkend="INetworkAdapter" xreflabel="INetworkAdapter"/>
           interface has been cleaned up. The various methods to activate an

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1507 +1507 @@
                             [--mtype normal|writethrough|immutable|shareable]
                             [--comment <text>]
+                            [--setuuid <uuid>]
+                            [--setparentuuid <uuid>]
                             [--passthrough on|off]
                             [--bandwidthgroup name|none]
@@ -1643 +1645 @@
             server downstairs"). This is purely descriptive and not needed for
             the medium to function correctly.</para>
+          </glossdef>
+        </glossentry>
+
+        <glossentry>
+          <glossterm>setuuid, setparentuuid</glossterm>
+
+          <glossdef>
+            <para>Modifies the UUID or parent UUID of a medium before
+            attaching it to a VM. This is an expert option. Inappropriate use
+            can make the medium unusable or lead to broken VM configurations
+            if any other VM is referring to the same media already. The most
+            frequently used variant is <code>--setuuid ""</code>, which assigns
+            a new (random) UUID to an image. This is useful to resolve the
+            duplicate UUID errors if one duplicated an image using file copy
+            utilities.</para>
           </glossdef>
         </glossentry>

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -227 +227 @@
 HRESULT findOrOpenMedium(HandlerArg *a, const char *pszFilenameOrUuid,
                          DeviceType_T enmDevType, ComPtr<IMedium> &pMedium,
-                         bool *pfWasUnknown);
+                         bool fForceNewUuidOnOpen, bool *pfWasUnknown);
 int handleCreateHardDisk(HandlerArg *a);
 int handleModifyHardDisk(HandlerArg *a);

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -181 +181 @@
 HRESULT findOrOpenMedium(HandlerArg *a, const char *pszFilenameOrUuid,
                          DeviceType_T enmDevType, ComPtr<IMedium> &pMedium,
-                         bool *pfWasUnknown)
+                         bool fForceNewUuidOnOpen, bool *pfWasUnknown)
 {
     HRESULT rc;
@@ -207 +207 @@
         CHECK_ERROR(a->virtualBox, OpenMedium(Bstr(pszFilenameOrUuid).raw(),
                                               enmDevType, AccessMode_ReadWrite,
+                                              fForceNewUuidOnOpen,
                                               pMedium.asOutParam()));
         if (SUCCEEDED(rc))
@@ -476 +477 @@
     else
         rc = findOrOpenMedium(a, FilenameOrUuid, DeviceType_HardDisk,
-                              hardDisk, &unknown);
+                              hardDisk, false /* fForceNewUuidOnOpen */, &unknown);
     if (FAILED(rc))
         return 1;
@@ -630 +631 @@
     bool fDstUnknown = false;
 
-    rc = findOrOpenMedium(a, pszSrc, DeviceType_HardDisk, srcDisk, &fSrcUnknown);
+    rc = findOrOpenMedium(a, pszSrc, DeviceType_HardDisk, srcDisk,
+                          false /* fForceNewUuidOnOpen */, &fSrcUnknown);
     if (FAILED(rc))
         return 1;
@@ -639 +641 @@
         if (fExisting)
         {
-            rc = findOrOpenMedium(a, pszDst, DeviceType_HardDisk, dstDisk, &fDstUnknown);
+            rc = findOrOpenMedium(a, pszDst, DeviceType_HardDisk, dstDisk,
+                                  false /* fForceNewUuidOnOpen */, &fDstUnknown);
             if (FAILED(rc))
                 break;
@@ -925 +928 @@
     bool unknown = false;
 
-    rc = findOrOpenMedium(a, FilenameOrUuid, DeviceType_HardDisk, hardDisk, &unknown);
+    rc = findOrOpenMedium(a, FilenameOrUuid, DeviceType_HardDisk, hardDisk,
+                          false /* fForceNewUuidOnOpen */, &unknown);
     if (FAILED(rc))
         return 1;

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

@@ -462 +462 @@
                      "                                     readonly|multiattach]\n"
                      "                            [--comment <text>]\n"
+                     "                            [--setuuid <uuid>]\n"
+                     "                            [--setparentuuid <uuid>]\n"
                      "                            [--passthrough on|off]\n"
                      "                            [--bandwidthgroup <name>]\n"

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

@@ -712 +712 @@
                     ComPtr<IMedium> hardDisk;
                     rc = findOrOpenMedium(a, ValueUnion.psz, DeviceType_HardDisk,
-                                          hardDisk, NULL);
+                                          hardDisk, false /* fForceNewUuidOnOpen */,
+                                          NULL);
                     if (FAILED(rc))
                         break;
@@ -807 +808 @@
                     ComPtr<IMedium> hardDisk;
                     rc = findOrOpenMedium(a, ValueUnion.psz, DeviceType_HardDisk,
-                                          hardDisk, NULL);
+                                          hardDisk, false /* fForceNewUuidOnOpen */,
+                                          NULL);
                     if (FAILED(rc))
                         break;
@@ -934 +936 @@
                 {
                     rc = findOrOpenMedium(a, ValueUnion.psz, DeviceType_DVD,
-                                          dvdMedium, NULL);
+                                          dvdMedium, false /* fForceNewUuidOnOpen */,
+                                          NULL);
                     if (FAILED(rc))
                         break;
@@ -997 +1000 @@
                     {
                         rc = findOrOpenMedium(a, ValueUnion.psz, DeviceType_Floppy,
-                                              floppyMedium, NULL);
+                                              floppyMedium, false /* fForceNewUuidOnOpen */,
+                                              NULL);
                         if (FAILED(rc))
                             break;

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

@@ -55 +55 @@
     { "--forceunmount",     'f', RTGETOPT_REQ_NOTHING },
     { "--comment",          'C', RTGETOPT_REQ_STRING },
+    { "--setuuid",          'q', RTGETOPT_REQ_STRING },
+    { "--setparentuuid",    'Q', RTGETOPT_REQ_STRING },
     // iSCSI options
     { "--server",           'S', RTGETOPT_REQ_STRING },
@@ -74 +76 @@
     bool fForceUnmount = false;
     bool fSetMediumType = false;
+    bool fSetNewUuid = false;
+    bool fSetNewParentUuid = false;
     MediumType_T mediumType = MediumType_Normal;
     Bstr bstrComment;
@@ -81 +85 @@
     const char *pszPassThrough = NULL;
     const char *pszBandwidthGroup = NULL;
+    Bstr bstrNewUuid;
+    Bstr bstrNewParentUuid;
     // iSCSI options
     Bstr bstrServer;
@@ -181 +187 @@
                 else
                     rc = E_FAIL;
-            break;
+                break;
+
+            case 'q':
+                if (ValueUnion.psz)
+                {
+                    bstrNewUuid = ValueUnion.psz;
+                    fSetNewUuid = true;
+                }
+                else
+                    rc = E_FAIL;
+                break;
+
+            case 'Q':
+                if (ValueUnion.psz)
+                {
+                    bstrNewParentUuid = ValueUnion.psz;
+                    fSetNewParentUuid = true;
+                }
+                else
+                    rc = E_FAIL;
+                break;
 
             case 'S':   // --server
@@ -544 +570 @@
 
                 rc = findOrOpenMedium(a, pszMedium, devTypeRequested,
-                                      pMedium2Mount, NULL);
+                                      pMedium2Mount, fSetNewUuid, NULL);
                 if (FAILED(rc) || !pMedium2Mount)
                     throw Utf8StrFmt("Invalid UUID or filename \"%s\"", pszMedium);
+            }
+
+            // set medium/parent medium UUID, if so desired
+            if (fSetNewUuid || fSetNewParentUuid)
+            {
+                CHECK_ERROR(pMedium2Mount, SetIDs(fSetNewUuid, bstrNewUuid.raw(),
+                                                  fSetNewParentUuid, bstrNewParentUuid.raw()));
+                if (FAILED(rc))
+                    throw  Utf8Str("Failed to set the medium/parent medium UUID");
             }
 

trunk/src/VBox/Frontends/VBoxSDL/VBoxSDL.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -1459 +1459 @@
             RTPrintf("Adding hard disk '%s'...\n", hdaFile);
             pVirtualBox->OpenMedium(bstrHdaFile.raw(), DeviceType_HardDisk,
-                                    AccessMode_ReadWrite, pMedium.asOutParam());
+                                    AccessMode_ReadWrite, FALSE /* fForceNewUuid */,
+                                    pMedium.asOutParam());
         }
         /* do we have the right image now? */
@@ -1544 +1545 @@
                                                  DeviceType_Floppy,
                                                  AccessMode_ReadWrite,
+                                                 FALSE /* fForceNewUuid */,
                                                  pMedium.asOutParam()));
                 }
@@ -1624 +1626 @@
                                                  DeviceType_DVD,
                                                  AccessMode_ReadWrite,
+                                                 FALSE /* fForceNewUuid */,
                                                  pMedium.asOutParam()));
                 }

trunk/src/VBox/Frontends/VirtualBox/src/VBoxMediaManagerDlg.cpp

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -1651 +1651 @@
     }
 
-    CMedium med = mVBox.OpenMedium(aLocation, devType, KAccessMode_ReadWrite);
+    CMedium med = mVBox.OpenMedium(aLocation, devType, KAccessMode_ReadWrite, false /* fForceNewUuid */);
     if (mVBox.isOk())
         medium = VBoxMedium(CMedium(med), aType, KMediumState_Created);

trunk/src/VBox/Frontends/VirtualBox/src/globals/VBoxGlobal.cpp

@@ -2754 +2754 @@
 
     /* Open corresponding medium: */
-    CMedium comMedium = vbox.OpenMedium(strMediumLocation, mediumTypeToGlobal(mediumType), KAccessMode_ReadWrite);
+    CMedium comMedium = vbox.OpenMedium(strMediumLocation, mediumTypeToGlobal(mediumType), KAccessMode_ReadWrite, false);
 
     if (vbox.isOk())

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UISession.cpp

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2011 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -426 +426 @@
         if (image.isNull())
         {
-            image = vbox.OpenMedium(strSource, KDeviceType_DVD, KAccessMode_ReadWrite);
+            image = vbox.OpenMedium(strSource, KDeviceType_DVD, KAccessMode_ReadWrite, false /* fForceNewUuid */);
             if (vbox.isOk())
                 strUuid = image.GetId();

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

@@ -1392 +1392 @@
   <interface
     name="IVirtualBox" extends="$unknown"
-    uuid="bc166b9b-9b62-4145-b1f6-6c39068aaf00"
+    uuid="d627bf11-2758-46be-9a4d-7d9ef794c247"
     wsmap="managed"
     >
@@ -1913 +1913 @@
         <desc>Whether to open the image in read/write or read-only mode. For
         a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
+      </param>
+      <param name="forceNewUuid" type="boolean" dir="in">
+        <desc>Allows the caller to request a completely new medium UUID for
+        the image which is to be opened. Useful if one intends to open an exact
+        copy of a previously opened image, as this would normally fail due to
+        the duplicate UUID.</desc>
       </param>
       <param name="medium" type="IMedium" dir="return">

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

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2008-2010 Oracle Corporation
+ * Copyright (C) 2008-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -78 +78 @@
                  const Utf8Str &aLocation,
                  HDDOpenMode enOpenMode,
+                 bool fForceNewUuid,
                  DeviceType_T aDeviceType);
 

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

@@ -140 +140 @@
                           DeviceType_T deviceType,
                           AccessMode_T accessMode,
+                          BOOL fForceNewUuid,
                           IMedium **aMedium);
     STDMETHOD(FindMedium)(IN_BSTR aLocation,

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

@@ -138 +138 @@
     bool autoReset : 1;
 
+    /** New UUID to be set on the next queryInfo() call. */
     const Guid uuidImage;
+    /** New parent UUID to be set on the next queryInfo() call. */
     const Guid uuidParentImage;
 
@@ -929 +931 @@
  * @param aFormat
  * @param aLocation     Storage unit location.
- * @param uuidMachineRegistry The registry to which this medium should be added (global registry UUI or medium UUID or empty if none).
+ * @param uuidMachineRegistry The registry to which this medium should be added (global registry UUID or machine UUID or empty if none).
  * @param pllRegistriesThatNeedSaving Optional list to receive the UUIDs of the media registries that need saving.
  */
@@ -1012 +1014 @@
  * @param aLocation     Storage unit location.
  * @param enOpenMode    Whether to open the medium read/write or read-only.
+ * @param fForceNewUuid Whether a new UUID should be set to avoid duplicates.
  * @param aDeviceType   Device type of medium.
  */
@@ -1017 +1020 @@
                      const Utf8Str &aLocation,
                      HDDOpenMode enOpenMode,
+                     bool fForceNewUuid,
                      DeviceType_T aDeviceType)
 {
@@ -1051 +1055 @@
 
     /* get all the information about the medium from the storage unit */
-    rc = queryInfo(false /* fSetImageId */, false /* fSetParentId */);
+    if (fForceNewUuid)
+        unconst(m->uuidImage).create();
+    rc = queryInfo(fForceNewUuid /* fSetImageId */, false /* fSetParentId */);
 
     if (SUCCEEDED(rc))
@@ -1089 +1095 @@
  * @param aParent       Parent medium disk or NULL for a root (base) medium.
  * @param aDeviceType   Device type of the medium.
- * @param uuidMachineRegistry The registry to which this medium should be added (global registry UUI or medium UUID).
+ * @param uuidMachineRegistry The registry to which this medium should be added (global registry UUID or machine UUID).
  * @param aNode         Configuration settings.
  * @param strMachineFolder The machine folder with which to resolve relative paths; if empty, then we use the VirtualBox home directory
@@ -1953 +1959 @@
     if (aSetImageId)
     {
-        imageId = Guid(aImageId);
-        if (imageId.isEmpty())
-            return setError(E_INVALIDARG, tr("Argument %s is empty"), "aImageId");
+        if (Bstr(aImageId).isEmpty())
+            imageId.create();
+        else
+        {
+            imageId = Guid(aImageId);
+            if (imageId.isEmpty())
+                return setError(E_INVALIDARG, tr("Argument %s is empty"), "aImageId");
+        }
     }
     if (aSetParentId)
-        parentId = Guid(aParentId);
+    {
+        if (Bstr(aParentId).isEmpty())
+            parentId.create();
+        else
+            parentId = Guid(aParentId);
+    }
 
     unconst(m->uuidImage) = imageId;
@@ -5090 +5106 @@
      * time in VirtualBox (such as VMDK for which VDOpen() needs to
      * generate an UUID if it is missing) */
-    if (    (m->hddOpenMode == OpenReadOnly)
+    if (    m->hddOpenMode == OpenReadOnly
          || m->type == MediumType_Readonly
-         || !isImport
+         || (!isImport && !fSetImageId && !fSetParentId)
        )
         uOpenFlags |= VD_OPEN_FLAGS_READONLY;
@@ -5169 +5185 @@
                     vrc = VDSetUuid(hdd, 0, m->uuidImage.raw());
                     ComAssertRCThrow(vrc, E_FAIL);
+                    mediumId = m->uuidImage;
                 }
                 if (fSetParentId)
@@ -5198 +5215 @@
                     if (mediumId != uuid)
                     {
+                        /** @todo r=klaus this always refers to VirtualBox.xml as the medium registry, even for new VMs */
                         lastAccessError = Utf8StrFmt(
                                 tr("UUID {%RTuuid} of the medium '%s' does not match the value {%RTuuid} stored in the media registry ('%s')"),
@@ -5213 +5231 @@
                  * underlying storage so use what we store in XML */
 
-                /* generate an UUID for an imported UUID-less medium */
-                if (isImport)
+                if (fSetImageId)
                 {
-                    if (fSetImageId)
-                        mediumId = m->uuidImage;
-                    else
-                        mediumId.create();
+                    /* set the UUID if an API client wants to change it */
+                    mediumId = m->uuidImage;
+                }
+                else if (isImport)
+                {
+                    /* generate an UUID for an imported UUID-less medium */
+                    mediumId.create();
                 }
             }
@@ -5305 +5325 @@
                         && m->pParent->getId() != parentId)
                     {
+                        /** @todo r=klaus this always refers to VirtualBox.xml as the medium registry, even for new VMs */
                         lastAccessError = Utf8StrFmt(
                                 tr("Parent UUID {%RTuuid} of the medium '%s' does not match UUID {%RTuuid} of its parent medium stored in the media registry ('%s')"),
@@ -5338 +5359 @@
     alock.enter();
 
-    if (isImport)
+    if (isImport || fSetImageId)
         unconst(m->id) = mediumId;
 

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

@@ -1482 +1482 @@
                                     DeviceType_T deviceType,
                                     AccessMode_T accessMode,
+                                    BOOL fForceNewUuid,
                                     IMedium **aMedium)
 {
@@ -1529 +1530 @@
                            aLocation,
                            (accessMode == AccessMode_ReadWrite) ? Medium::OpenReadWrite : Medium::OpenReadOnly,
+                           fForceNewUuid,
                            deviceType);
 

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

@@ -8 +8 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -359 +359 @@
                                 DeviceType_DVD,
                                 AccessMode_ReadOnly,
+                                false /* fForceNewUuid */,
                                 getter_AddRefs(dvdImage));
     if (NS_FAILED(rc))