Changeset 27886 in vbox

Timestamp:

Mar 31, 2010 12:18:38 PM (15 years ago)

Author:

vboxsync

Message:

Main/OVF: document import code

Location:

trunk/src/VBox/Main

Files:

• ApplianceImpl.cpp (modified) (1 diff)
• ApplianceImplExport.cpp (modified) (2 diffs)
• ApplianceImplImport.cpp (modified) (6 diffs)

trunk/src/VBox/Main/ApplianceImpl.cpp

@@ -931 +931 @@
 }
 
-int Appliance::TaskExportOVF::startThread()
-{
-    int vrc = RTThreadCreate(NULL, Appliance::taskThreadWriteOVF, this,
-                             0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
-                             "Appliance::Task");
-
-    ComAssertMsgRCRet(vrc,
-                      ("Could not create taskThreadWriteOVF (%Rrc)\n", vrc), E_FAIL);
-
-    return S_OK;
-}
-
 ////////////////////////////////////////////////////////////////////////////////
 //

trunk/src/VBox/Main/ApplianceImplExport.cpp

@@ -602 +602 @@
 /**
  * Implementation for writing out the OVF to disk. This starts a new thread which will call
- * Appliance::taskThreadWriteOVF(). This is in a separate private method because it is used
- * from two locations:
+ * Appliance::taskThreadWriteOVF().
+ *
+ * This is in a separate private method because it is used from two locations:
  *
  * 1) from the public Appliance::Write().
@@ -650 +651 @@
 
     return rc;
+}
+
+/**
+ *
+ * @return
+ */
+int Appliance::TaskExportOVF::startThread()
+{
+    int vrc = RTThreadCreate(NULL, Appliance::taskThreadWriteOVF, this,
+                             0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
+                             "Appliance::Task");
+
+    ComAssertMsgRCRet(vrc,
+                      ("Could not create taskThreadWriteOVF (%Rrc)\n", vrc), E_FAIL);
+
+    return S_OK;
 }
 

trunk/src/VBox/Main/ApplianceImplImport.cpp

@@ -562 +562 @@
 
 /**
+ * Implementation for reading an OVF. This starts a new thread which will call
+ * Appliance::taskThreadImportOVF() which will then call readFS() or readS3().
+ *
+ * This is in a separate private method because it is used from two locations:
+ *
+ * 1) from the public Appliance::Read().
+ * 2) from Appliance::readS3(), which got called from a previous instance of Appliance::taskThreadImportOVF().
  *
  * @param aLocInfo
@@ -615 +622 @@
 /**
  *
+ * @return
+ */
+int Appliance::TaskImportOVF::startThread()
+{
+    int vrc = RTThreadCreate(NULL, Appliance::taskThreadImportOVF, this,
+                             0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
+                             "Appliance::Task");
+
+    ComAssertMsgRCRet(vrc,
+                      ("Could not create taskThreadImportOVF (%Rrc)\n", vrc), E_FAIL);
+
+    return S_OK;
+}
+
+/**
+ * Thread function for the thread started in Appliance::readImpl() and Appliance::importImpl().
+ * This will in turn call Appliance::readFS() or Appliance::readS3() or Appliance::importFS()
+ * or Appliance::importS3().
+ *
+ * @param aThread
+ * @param pvUser
+ */
+/* static */
+DECLCALLBACK(int) Appliance::taskThreadImportOVF(RTTHREAD /* aThread */, void *pvUser)
+{
+    std::auto_ptr<TaskImportOVF> task(static_cast<TaskImportOVF*>(pvUser));
+    AssertReturn(task.get(), VERR_GENERAL_FAILURE);
+
+    Appliance *pAppliance = task->pAppliance;
+
+    LogFlowFuncEnter();
+    LogFlowFunc(("Appliance %p\n", pAppliance));
+
+    HRESULT taskrc = S_OK;
+
+    switch (task->taskType)
+    {
+        case TaskImportOVF::Read:
+        {
+            if (task->locInfo.storageType == VFSType_File)
+                taskrc = pAppliance->readFS(task.get());
+            else if (task->locInfo.storageType == VFSType_S3)
+                taskrc = pAppliance->readS3(task.get());
+            break;
+        }
+        case TaskImportOVF::Import:
+        {
+            if (task->locInfo.storageType == VFSType_File)
+                taskrc = pAppliance->importFS(task.get());
+            else if (task->locInfo.storageType == VFSType_S3)
+                taskrc = pAppliance->importS3(task.get());
+            break;
+        }
+    }
+
+    task->rc = taskrc;
+
+    LogFlowFuncLeave();
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * Actual worker code for reading an OVF from disk. This is called from Appliance::taskThreadImportOVF()
+ * and therefore runs on the OVF read worker thread. This runs in two contexts:
+ *
+ * 1) in a first worker thread; in that case, Appliance::Read() called Appliance::readImpl();
+ *
+ * 2) in a second worker thread; in that case, Appliance::Read() called Appliance::readImpl(), which
+ *    called Appliance::readS3(), which called Appliance::readImpl(), which then called this.
+ *
  * @param pTask
  * @return
@@ -666 +744 @@
 
 /**
+ * Worker code for writing out OVF to the cloud. This is called from Appliance::taskThreadImportOVF()
+ * in S3 mode and therefore runs on the OVF read worker thread. This then starts a second worker
+ * thread to create temporary files (see Appliance::readFS()).
  *
  * @param pTask
@@ -863 +944 @@
 
 /**
- * Implementation of the import code. This gets called from the public Appliance::ImportMachines()
- * method as well as Appliance::importS3().
+ * Implementation for importing OVF data into VirtualBox. This starts a new thread which will call
+ * Appliance::taskThreadImportOVF().
+ *
+ * This is in a separate private method because it is used from two locations:
+ *
+ * 1) from the public Appliance::ImportMachines().
+ * 2) from Appliance::importS3(), which got called from a previous instance of Appliance::taskThreadImportOVF().
+ *
  * @param aLocInfo
  * @param aProgress
@@ -902 +989 @@
 
 /**
- * Worker thread implementation for Read() (ovf reader).
- * @param aThread
- * @param pvUser
- */
-/* static */
-DECLCALLBACK(int) Appliance::taskThreadImportOVF(RTTHREAD /* aThread */, void *pvUser)
-{
-    std::auto_ptr<TaskImportOVF> task(static_cast<TaskImportOVF*>(pvUser));
-    AssertReturn(task.get(), VERR_GENERAL_FAILURE);
-
-    Appliance *pAppliance = task->pAppliance;
-
-    LogFlowFuncEnter();
-    LogFlowFunc(("Appliance %p\n", pAppliance));
-
-    switch (task->taskType)
-    {
-        case TaskImportOVF::Read:
-        {
-            if (task->locInfo.storageType == VFSType_File)
-                pAppliance->readFS(task.get());
-            else if (task->locInfo.storageType == VFSType_S3)
-                pAppliance->readS3(task.get());
-            break;
-        }
-        case TaskImportOVF::Import:
-        {
-            if (task->locInfo.storageType == VFSType_File)
-                pAppliance->importFS(task.get());
-            else if (task->locInfo.storageType == VFSType_S3)
-                pAppliance->importS3(task.get());
-            break;
-        }
-    }
-
-    LogFlowFuncLeave();
-
-    return VINF_SUCCESS;
-}
-
-/**
+ * Actual worker code for importing OVF data into VirtualBox. This is called from Appliance::taskThreadImportOVF()
+ * and therefore runs on the OVF import worker thread. This runs in two contexts:
  *
- * @return
- */
-int Appliance::TaskImportOVF::startThread()
-{
-    int vrc = RTThreadCreate(NULL, Appliance::taskThreadImportOVF, this,
-                             0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0,
-                             "Appliance::Task");
-
-    ComAssertMsgRCRet(vrc,
-                      ("Could not create taskThreadImportOVF (%Rrc)\n", vrc), E_FAIL);
-
-    return S_OK;
-}
-
-/**
+ * 1) in a first worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl();
+ *
+ * 2) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl(), which
+ *    called Appliance::importS3(), which called Appliance::importImpl(), which then called this.
  *
  * @param pTask
@@ -1800 +1837 @@
 
 /**
- *
+ * Gets called from taskThreadImportOVF().
  * @param pTask
  * @return