Changeset 5292 in vbox for trunk/src

Timestamp:

Oct 15, 2007 12:04:26 PM (17 years ago)

Author:

vboxsync

Message:

API change to allow VM to be created with predefined UUID.

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManage.cpp (modified) (4 diffs)
• Frontends/VirtualBox/ui/VBoxNewVMWzd.ui.h (modified) (1 diff)
• Main/MachineImpl.cpp (modified) (8 diffs)
• Main/VirtualBoxImpl.cpp (modified) (4 diffs)
• Main/idl/VirtualBox.xidl (modified) (5 diffs)
• Main/include/VirtualBoxImpl.h (modified) (1 diff)
• Main/testcase/tstVBoxAPILinux.cpp (modified) (1 diff)

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

@@ -302 +302 @@
                  "                            [-register]\n"
                  "                            [-basefolder <path> | -settingsfile <path>]\n"
+                 "                            [-uuid <uuid>]\n"
                  "                            \n"
                  "\n");
@@ -3434 +3435 @@
     Bstr settingsFile;
     Bstr name;
+    RTUUID id;
     bool fRegister = false;
 
@@ -3465 +3467 @@
             name = argv[i];
         }
+        else if (strcmp(argv[i], "-uuid") == 0)
+        {
+            if (argc <= i + 1)
+            {
+                return errorArgument("Missing argument to '%s'", argv[i]);
+            }
+            i++;
+            if (VBOX_FAILURE(RTUuidFromStr(&id, argv[i])))
+            {
+                return errorArgument("Invalid UUID format %s\n", argv[i]);
+            }
+        }
         else if (strcmp(argv[i], "-register") == 0)
         {
@@ -3489 +3503 @@
         if (!settingsFile)
             CHECK_ERROR_BREAK(virtualBox,
-                CreateMachine(baseFolder, name, machine.asOutParam()));
+                CreateMachine(baseFolder, name, Guid(id), machine.asOutParam()));
         else
             CHECK_ERROR_BREAK(virtualBox,
-                CreateLegacyMachine(settingsFile, name, machine.asOutParam()));
+                CreateLegacyMachine(settingsFile, name, Guid(id), machine.asOutParam()));
 
         CHECK_ERROR_BREAK(machine, SaveSettings());

trunk/src/VBox/Frontends/VirtualBox/ui/VBoxNewVMWzd.ui.h

@@ -311 +311 @@
     if (cmachine.isNull())
     {
-        cmachine = vbox.CreateMachine (QString(), leName->text());
+        cmachine = vbox.CreateMachine (QString(), leName->text(), QUuid());
         if (!vbox.isOk())
         {

trunk/src/VBox/Main/MachineImpl.cpp

@@ -337 +337 @@
  *                      user and should never change. Used only in Init_New
  *                      mode (ignored otherwise).
- *  @param aId          UUID of the machine (used only for consistency
+ *  @param aId          UUID of the machine. Required for aMode==Init_Registered
+ *                      and optional for aMode==Init_New. Used for consistency
  *                      check when aMode is Init_Registered; must match UUID
- *                      stored in the settings file).
+ *                      stored in the settings file. Used for predefining the
+ *                      UUID of a VM when aMode is Init_New.
  *
  *  @return  Success indicator. if not S_OK, the machine object is invalid
@@ -454 +456 @@
             {
                 /* create the machine UUID */
-                unconst (mData->mUuid).create();
+                if (aId)
+                    unconst (mData->mUuid) = *aId;
+                else
+                    unconst (mData->mUuid).create();
 
                 /* memorize the provided new machine's name */
@@ -2618 +2623 @@
  *  Returns @c true if the given DVD image is attached to this machine either
  *  in the current state or in any of the snapshots.
- * 
+ *
  *  @param aId          Image ID to check.
  *  @param aUsage       Type of the check.
@@ -2691 +2696 @@
 }
 
-/** 
+/**
  *  Returns @c true if the given Floppy image is attached to this machine either
  *  in the current state or in any of the snapshots.
- * 
+ *
  *  @param aId          Image ID to check.
  *  @param aUsage       Type of the check.
@@ -3423 +3428 @@
 /////////////////////////////////////////////////////////////////////////////
 
-/** 
+/**
  *  Performs machine state checks based on the @a aDepType value. If a check
  *  fails, this method will set extended error info, otherwise it will return
@@ -3436 +3441 @@
  *  and not saved). It is useful to call this method from Machine setters
  *  before performing any change.
- * 
+ *
  *  When @a aDepType is MutableOrSavedStateDep, this method behaves the same
  *  as for MutableStateDep except that if the machine is saved, S_OK is also
@@ -6470 +6475 @@
                            !!mNetworkAdapters [slot]->data()->mCableConnected);
 
-            CFGLDRSetUInt32 (networkAdapterNode, "speed", 
+            CFGLDRSetUInt32 (networkAdapterNode, "speed",
                              mNetworkAdapters [slot]->data()->mLineSpeed);
 
@@ -6718 +6723 @@
                          mHWData->mMemoryBalloonSize);
         CFGLDRSetUInt32 (guestNode, "StatisticsUpdateInterval",
-                         mHWData->mStatisticsUpdateInterval);                
+                         mHWData->mStatisticsUpdateInterval);
 
         CFGLDRReleaseNode (guestNode);

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -626 +626 @@
 STDMETHODIMP VirtualBox::CreateMachine (INPTR BSTR aBaseFolder,
                                         INPTR BSTR aName,
+                                        INPTR GUIDPARAM aId,
                                         IMachine **aMachine)
 {
@@ -669 +670 @@
     if (SUCCEEDED (rc))
     {
+        /* Create UUID if an empty one was specified. */
+        Guid id = aId;
+        if (id.isEmpty())
+            id.create();
+
         /* initialize the machine object */
-        rc = machine->init (this, settingsFile, Machine::Init_New, aName);
+        rc = machine->init (this, settingsFile, Machine::Init_New, aName, TRUE, &id);
         if (SUCCEEDED (rc))
         {
@@ -687 +693 @@
 STDMETHODIMP VirtualBox::CreateLegacyMachine (INPTR BSTR aSettingsFile,
                                               INPTR BSTR aName,
+                                              INPTR GUIDPARAM aId,
                                               IMachine **aMachine)
 {
@@ -717 +724 @@
     if (SUCCEEDED (rc))
     {
+        /* Create UUID if an empty one was specified. */
+        Guid id = aId;
+        if (id.isEmpty())
+            id.create();
+
         /* initialize the machine object */
         rc = machine->init (this, Bstr (settingsFile), Machine::Init_New,
-                            aName, FALSE /* aNameSync */);
+                            aName, FALSE /* aNameSync */, &id);
         if (SUCCEEDED (rc))
         {

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

@@ -808 +808 @@
   <interface
      name="IVirtualBox" extends="$dispatched"
-     uuid="76b25f3c-15d4-4785-a9d3-adc6a462beec"
+     uuid="e1606565-8954-4703-b22a-620941b85a1c"
      wsmap="global"
      >
@@ -915 +915 @@
           &lt;base_folder&gt;/&lt;machine_name&gt;/&lt;machine_name&gt;.xml</pre>
 
+        Optionally the UUID of the machine can be predefined. If this is
+        not desired (i.e. a new UUID should be generated), pass just an
+        empty or null UUID.
+
         Note that the configuration of the newly created machine is not
         saved to disk (and therefore no settings subfolder and file are
@@ -940 +944 @@
         <desc>Machine name.</desc>
       </param>
+      <param name="id" type="uuid" dir="in">
+        <desc>
+          UUID of the newly created VM, when non-null or non-empty.
+          Otherwise a UUID is automatically generated.
+        </desc>
+      </param>
       <param name="machine" type="IMachine" dir="return">
         <desc>Created machine object.</desc>
@@ -962 +972 @@
         appended.
 
+        Optionally the UUID of the machine can be predefined. If this is
+        not desired (i.e. a new UUID should be generated), pass just an
+        empty or null UUID.
+
         Note that the configuration of the newly created machine is not
         saved to disk (and therefore no settings file is created)
@@ -990 +1004 @@
       <param name="name" type="wstring" dir="in">
         <desc>Machine name.</desc>
+      </param>
+      <param name="id" type="uuid" dir="in">
+        <desc>
+          UUID of the newly created VM, when non-null or non-empty.
+          Otherwise a UUID is automatically generated.
+        </desc>
       </param>
       <param name="machine" type="IMachine" dir="return">

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

@@ -124 +124 @@
 
     STDMETHOD(CreateMachine) (INPTR BSTR aBaseFolder, INPTR BSTR aName,
-                              IMachine **aMachine);
+                              INPTR GUIDPARAM aId, IMachine **aMachine);
     STDMETHOD(CreateLegacyMachine) (INPTR BSTR aSettingsFile, INPTR BSTR aName,
-                                    IMachine **aMachine);
+                                    INPTR GUIDPARAM aId, IMachine **aMachine);
     STDMETHOD(OpenMachine) (INPTR BSTR aSettingsFile, IMachine **aMachine);
     STDMETHOD(RegisterMachine) (IMachine *aMachine);

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

@@ -140 +140 @@
      * in the configuration until we explicitely choose to do so.
      */
+    nsID VMuuid = {0};
     nsCOMPtr <IMachine> machine;
     rc = virtualBox->CreateMachine(nsnull, NS_LITERAL_STRING("A brand new name").get(),
-                                   getter_AddRefs(machine));
+                                   VMuuid, getter_AddRefs(machine));
     if (NS_FAILED(rc))
     {