Changeset 23879 in vbox

Timestamp:

Oct 19, 2009 5:26:44 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

53659

Message:

Main: rename snapshot APIs, remove DiscardCurrentSnapshotAndState; tree snapshots implementation still missing

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManageSnapshot.cpp (modified) (3 diffs)
• Frontends/VBoxSDL/VBoxSDL.cpp (modified) (2 diffs)
• Frontends/VirtualBox/include/VBoxSnapshotsWgt.h (modified) (2 diffs)
• Frontends/VirtualBox/src/VBoxConsoleWnd.cpp (modified) (1 diff)
• Frontends/VirtualBox/src/VBoxGlobal.cpp (modified) (3 diffs)
• Frontends/VirtualBox/src/VBoxSnapshotsWgt.cpp (modified) (10 diffs)
• Main/ConsoleImpl.cpp (modified) (5 diffs)
• Main/Global.cpp (modified) (1 diff)
• Main/MachineImpl.cpp (modified) (21 diffs)
• Main/idl/VirtualBox.xidl (modified) (16 diffs)
• Main/include/ConsoleImpl.h (modified) (1 diff)
• Main/include/MachineImpl.h (modified) (3 diffs)

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

@@ -181 +181 @@
 
             ComPtr<IProgress> progress;
-            CHECK_ERROR_BREAK(console, DiscardSnapshot(guid, progress.asOutParam()));
+            CHECK_ERROR_BREAK(console, DeleteSnapshot(guid, progress.asOutParam()));
 
             showProgress(progress);
@@ -200 +200 @@
             if (   (a->argc != 3)
                 || (   strcmp(a->argv[2], "--state")
-                    && strcmp(a->argv[2], "-state")
-                    && strcmp(a->argv[2], "--all")
-                    && strcmp(a->argv[2], "-all")))
+                    && strcmp(a->argv[2], "-state")))
             {
                 errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[2]).raw());
@@ -208 +206 @@
                 break;
             }
-            bool fAll = false;
-            if (   !strcmp(a->argv[2], "--all")
-                || !strcmp(a->argv[2], "-all"))
-                fAll = true;
-
-            ComPtr<IProgress> progress;
-
-            if (fAll)
-            {
-                CHECK_ERROR_BREAK(console, DiscardCurrentSnapshotAndState(progress.asOutParam()));
-            }
-            else
-            {
-                CHECK_ERROR_BREAK(console, DiscardCurrentState(progress.asOutParam()));
-            }
-
-            showProgress(progress);
+
+            ComPtr<ISnapshot> pCurrentSnapshot;
+            CHECK_ERROR_BREAK(machine, COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam()));
+
+            ComPtr<IProgress> pProgress;
+            CHECK_ERROR_BREAK(console, RestoreSnapshot(pCurrentSnapshot, pProgress.asOutParam()));
+
+            showProgress(pProgress);
             LONG iRc;
-            progress->COMGETTER(ResultCode)(&iRc);
+            pProgress->COMGETTER(ResultCode)(&iRc);
             rc = iRc;
             if (FAILED(rc))
             {
-                com::ProgressErrorInfo info(progress);
+                com::ProgressErrorInfo info(pProgress);
                 if (info.isBasicAvailable())
-                    RTPrintf("Error: failed to discard. Error message: %lS\n", info.getText().raw());
-                else
-                    RTPrintf("Error: failed to discard. No error message available!\n");
+                    RTPrintf("Error: failed to restore snapshot. Error message: %lS\n", info.getText().raw());
+                else
+                    RTPrintf("Error: failed to restore snapshot. No error message available!\n");
             }
 

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

@@ -602 +602 @@
         switch (machineState)
         {
-            case MachineState_Null:                return "<null>";
-            case MachineState_Running:             return "Running";
-            case MachineState_Restoring:           return "Restoring";
-            case MachineState_TeleportingFrom:     return "TeleportingFrom";
-            case MachineState_Starting:            return "Starting";
-            case MachineState_PoweredOff:          return "PoweredOff";
-            case MachineState_Saved:               return "Saved";
-            case MachineState_Aborted:             return "Aborted";
-            case MachineState_Stopping:            return "Stopping";
-            case MachineState_Paused:              return "Paused";
-            case MachineState_Stuck:               return "Stuck";
-            case MachineState_Saving:              return "Saving";
-            case MachineState_Discarding:          return "Discarding";
-            case MachineState_SettingUp:           return "SettingUp";
-            default:                               return "no idea";
+            case MachineState_Null:                 return "<null>";
+            case MachineState_PoweredOff:           return "PoweredOff";
+            case MachineState_Saved:                return "Saved";
+            case MachineState_Aborted:              return "Aborted";
+            case MachineState_Running:              return "Running";
+            case MachineState_Paused:               return "Paused";
+            case MachineState_Stuck:                return "GuruMeditation";
+            case MachineState_Starting:             return "Starting";
+            case MachineState_Stopping:             return "Stopping";
+            case MachineState_Saving:               return "Saving";
+            case MachineState_Restoring:            return "Restoring";
+            case MachineState_TeleportingFrom:      return "TeleportingFrom";
+            case MachineState_RestoringSnapshot:    return "RestoringSnapshot";
+            case MachineState_DeletingSnapshot:     return "DeletingSnapshot";
+            case MachineState_SettingUp:            return "SettingUp";
+            default:                                return "no idea";
         }
     }
@@ -1774 +1775 @@
         {
             gProgress = NULL;
-            CHECK_ERROR(gConsole, DiscardCurrentState(gProgress.asOutParam()));
+
+            ComPtr<ISnapshot> pCurrentSnapshot;
+            CHECK_ERROR_BREAK(gMachine, COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam()));
+
+            CHECK_ERROR(gConsole, RestoreSnapshot(pCurrentSnapshot, gProgress.asOutParam()));
             rc = gProgress->WaitForCompletion(-1);
         }

trunk/src/VBox/Frontends/VirtualBox/include/VBoxSnapshotsWgt.h

@@ -60 +60 @@
     void takeSnapshot();
     void discardCurState();
-    void discardCurSnapAndState();
     void showSnapshotDetails();
 
@@ -91 +90 @@
     QAction         *mTakeSnapshotAction;
     QAction         *mRevertToCurSnapAction;
-    QAction         *mDiscardCurSnapAndStateAction;
     QAction         *mShowSnapshotDetailsAction;
 };

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

@@ -1388 +1388 @@
                         if (dlg.mCbDiscardCurState->isChecked() && dlg.mCbDiscardCurState->isVisibleTo (&dlg))
                         {
-                            CProgress progress = console.DiscardCurrentState();
+                            CProgress progress = console.RestoreSnapshot(machine.GetCurrentSnapshot());
                             if (console.isOk())
                             {

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

@@ -2643 +2643 @@
     mMachineStates [KMachineState_Restoring] =  tr ("Restoring", "MachineState");
     mMachineStates [KMachineState_TeleportingFrom] = tr ("Teleporting From", "MachineState");
-    mMachineStates [KMachineState_Discarding] = tr ("Discarding", "MachineState");
+    mMachineStates [KMachineState_RestoringSnapshot] = tr ("Restoring Snapshot", "MachineState");
+    mMachineStates [KMachineState_DeletingSnapshot] = tr ("Deleting Snapshot", "MachineState");
     mMachineStates [KMachineState_SettingUp] =  tr ("Setting Up", "MachineState");
 
@@ -4613 +4614 @@
         {KMachineState_Restoring, ":/state_restoring_16px.png"},
         {KMachineState_TeleportingFrom, ":/state_restoring_16px.png"}, /** @todo Live Migration: New icon? (not really important) */
-        {KMachineState_Discarding, ":/state_discarding_16px.png"},
+        {KMachineState_RestoringSnapshot, ":/state_discarding_16px.png"},
+        {KMachineState_DeletingSnapshot, ":/state_discarding_16px.png"},
         {KMachineState_SettingUp, ":/settings_16px.png"},
     };
@@ -4635 +4637 @@
     mVMStateColors.insert (KMachineState_Restoring,     new QColor (Qt::green));
     mVMStateColors.insert (KMachineState_TeleportingFrom, new QColor (Qt::green));
-    mVMStateColors.insert (KMachineState_Discarding,    new QColor (Qt::green));
+    mVMStateColors.insert (KMachineState_RestoringSnapshot, new QColor (Qt::green));
+    mVMStateColors.insert (KMachineState_DeletingSnapshot, new QColor (Qt::green));
     mVMStateColors.insert (KMachineState_SettingUp,     new QColor (Qt::green));
 

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

@@ -256 +256 @@
     , mTakeSnapshotAction (new QAction (this))
     , mRevertToCurSnapAction (new QAction (mCurStateActionGroup))
-    , mDiscardCurSnapAndStateAction (new QAction (mCurStateActionGroup))
     , mShowSnapshotDetailsAction (new QAction (this))
 {
@@ -292 +291 @@
         ":/discard_cur_state_22px.png", ":/discard_cur_state_16px.png",
         ":/discard_cur_state_dis_22px.png", ":/discard_cur_state_dis_16px.png"));
-    mDiscardCurSnapAndStateAction->setIcon (VBoxGlobal::iconSetFull (
-        QSize (22, 22), QSize (16, 16),
-        ":/discard_cur_state_snapshot_22px.png", ":/discard_cur_state_snapshot_16px.png",
-        ":/discard_cur_state_snapshot_dis_22px.png", ":/discard_cur_state_snapshot_dis_16px.png"));
     mShowSnapshotDetailsAction->setIcon (VBoxGlobal::iconSetFull (
         QSize (22, 22), QSize (16, 16),
@@ -304 +299 @@
     mTakeSnapshotAction->setShortcut (QString ("Ctrl+Shift+S"));
     mRevertToCurSnapAction->setShortcut (QString ("Ctrl+Shift+R"));
-    mDiscardCurSnapAndStateAction->setShortcut (QString ("Ctrl+Shift+B"));
     mShowSnapshotDetailsAction->setShortcut (QString ("Ctrl+Space"));
 
@@ -321 +315 @@
     connect (mRevertToCurSnapAction, SIGNAL (triggered()),
              this, SLOT (discardCurState()));
-    connect (mDiscardCurSnapAndStateAction, SIGNAL (triggered()),
-             this, SLOT (discardCurSnapAndState()));
     connect (mShowSnapshotDetailsAction, SIGNAL (triggered()),
              this, SLOT (showSnapshotDetails()));
@@ -467 +459 @@
 
     CConsole console = session.GetConsole();
-    CProgress progress = console.DiscardSnapshot (snapId);
+    CProgress progress = console.DeleteSnapshot(snapId);
     if (console.isOk())
     {
@@ -552 +544 @@
 
     CConsole console = session.GetConsole();
-    CProgress progress = console.DiscardCurrentState();
+    CProgress progress = console.RestoreSnapshot(mMachine.GetCurrentSnapshot());
     if (console.isOk())
     {
@@ -564 +556 @@
     else
         vboxProblem().cannotDiscardCurrentState (console);
-
-    session.Close();
-}
-
-void VBoxSnapshotsWgt::discardCurSnapAndState()
-{
-    if (!vboxProblem().askAboutSnapshotAndStateDiscarding())
-        return;
-
-    SnapshotWgtItem *item = mTreeWidget->selectedItems().isEmpty() ? 0 :
-        static_cast<SnapshotWgtItem*> (mTreeWidget->selectedItems() [0]);
-    AssertReturn (item, (void) 0);
-
-    /* Open a direct session (this call will handle all errors) */
-    CSession session = vboxGlobal().openSession (mMachineId);
-    if (session.isNull())
-        return;
-
-    CConsole console = session.GetConsole();
-    CProgress progress = console.DiscardCurrentSnapshotAndState();
-    if (console.isOk())
-    {
-        /* Show the progress dialog */
-        vboxProblem().showModalProgressDialog (progress, mMachine.GetName(),
-                                               vboxProblem().mainWindowShown());
-
-        if (progress.GetResultCode() != 0)
-            vboxProblem().cannotDiscardCurrentSnapshotAndState (progress);
-    }
-    else
-        vboxProblem().cannotDiscardCurrentSnapshotAndState (console);
 
     session.Close();
@@ -688 +649 @@
     mTakeSnapshotAction->setText (tr ("Take &Snapshot"));
     mRevertToCurSnapAction->setText (tr ("&Revert to Current Snapshot"));
-    mDiscardCurSnapAndStateAction->setText (tr ("D&iscard Current Snapshot and State"));
     mShowSnapshotDetailsAction->setText (tr ("S&how Details"));
 
@@ -694 +654 @@
     mTakeSnapshotAction->setStatusTip (tr ("Take a snapshot of the current virtual machine state"));
     mRevertToCurSnapAction->setStatusTip (tr ("Restore the virtual machine state from the state stored in the current snapshot"));
-    mDiscardCurSnapAndStateAction->setStatusTip (tr ("Discard the current snapshot and revert the machine to the state it had before the snapshot was taken"));
     mShowSnapshotDetailsAction->setStatusTip (tr ("Show details of the selected snapshot"));
 
@@ -703 +662 @@
     mRevertToCurSnapAction->setToolTip (mRevertToCurSnapAction->text().remove ('&').remove ('.') +
         QString (" (%1)").arg (mRevertToCurSnapAction->shortcut().toString()));
-    mDiscardCurSnapAndStateAction->setToolTip (mDiscardCurSnapAndStateAction->text().remove ('&').remove ('.') +
-        QString (" (%1)").arg (mDiscardCurSnapAndStateAction->shortcut().toString()));
     mShowSnapshotDetailsAction->setToolTip (mShowSnapshotDetailsAction->text().remove ('&').remove ('.') +
         QString (" (%1)").arg (mShowSnapshotDetailsAction->shortcut().toString()));

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -2516 +2516 @@
 }
 
-STDMETHODIMP Console::DiscardSnapshot(IN_BSTR aId, IProgress **aProgress)
+STDMETHODIMP Console::DeleteSnapshot(IN_BSTR aId, IProgress **aProgress)
 {
     CheckComArgExpr(aId, Guid(aId).isEmpty() == false);
@@ -2532 +2532 @@
 
     MachineState_T machineState = MachineState_Null;
-    HRESULT rc = mControl->DiscardSnapshot(this, aId, &machineState, aProgress);
+    HRESULT rc = mControl->DeleteSnapshot(this, aId, &machineState, aProgress);
     CheckComRCReturnRC(rc);
 
@@ -2539 +2539 @@
 }
 
-STDMETHODIMP Console::DiscardCurrentState(IProgress **aProgress)
+STDMETHODIMP Console::RestoreSnapshot(ISnapshot *aSnapshot, IProgress **aProgress)
 {
     AutoCaller autoCaller(this);
@@ -2548 +2548 @@
     if (Global::IsOnlineOrTransient(mMachineState))
         return setError(VBOX_E_INVALID_VM_STATE,
-            tr("Cannot discard the current state of the running machine (machine state: %s)"),
-            Global::stringifyMachineState(mMachineState));
+                        tr("Cannot discard the current state of the running machine (machine state: %s)"),
+                        Global::stringifyMachineState(mMachineState));
 
     MachineState_T machineState = MachineState_Null;
-    HRESULT rc = mControl->DiscardCurrentState(this, &machineState, aProgress);
-    CheckComRCReturnRC(rc);
-
-    setMachineStateLocally(machineState);
-    return S_OK;
-}
-
-STDMETHODIMP Console::DiscardCurrentSnapshotAndState(IProgress **aProgress)
-{
-    AutoCaller autoCaller(this);
-    CheckComRCReturnRC(autoCaller.rc());
-
-    AutoWriteLock alock(this);
-
-    if (Global::IsOnlineOrTransient(mMachineState))
-        return setError(VBOX_E_INVALID_VM_STATE,
-            tr("Cannot discard the current snapshot and state of the running machine (machine state: %s)"),
-            Global::stringifyMachineState(mMachineState));
-
-    MachineState_T machineState = MachineState_Null;
-    HRESULT rc =
-        mControl->DiscardCurrentSnapshotAndState(this, &machineState, aProgress);
+    HRESULT rc = mControl->RestoreSnapshot(this, aSnapshot, &machineState, aProgress);
     CheckComRCReturnRC(rc);
 
@@ -4031 +4010 @@
     AutoWriteLock alock(this);
 
-    AssertReturn(mMachineState == MachineState_Saving ||
-                  mMachineState == MachineState_Discarding,
-                  E_FAIL);
+    AssertReturn(    mMachineState == MachineState_Saving
+                  || mMachineState == MachineState_RestoringSnapshot
+                  || mMachineState == MachineState_DeletingSnapshot,
+                 E_FAIL);
 
     return setMachineStateLocally(aMachineState);

trunk/src/VBox/Main/Global.cpp

@@ -186 +186 @@
     switch (aState)
     {
-        case MachineState_Null:         return "Null";
-        case MachineState_PoweredOff:   return "PoweredOff";
-        case MachineState_Saved:        return "Saved";
-        case MachineState_Aborted:      return "Aborted";
-        case MachineState_Running:      return "Running";
-        case MachineState_Paused:       return "Paused";
-        case MachineState_Stuck:        return "GuruMeditation";
-        case MachineState_Starting:     return "Starting";
-        case MachineState_Stopping:     return "Stopping";
-        case MachineState_Saving:       return "Saving";
-        case MachineState_Restoring:    return "Restoring";
-        case MachineState_TeleportingFrom: return "TeleportingFrom";
-        case MachineState_Discarding:   return "Discarding";
-        case MachineState_SettingUp:    return "SettingUp";
+        case MachineState_Null:                 return "Null";
+        case MachineState_PoweredOff:           return "PoweredOff";
+        case MachineState_Saved:                return "Saved";
+        case MachineState_Aborted:              return "Aborted";
+        case MachineState_Running:              return "Running";
+        case MachineState_Paused:               return "Paused";
+        case MachineState_Stuck:                return "GuruMeditation";
+        case MachineState_Starting:             return "Starting";
+        case MachineState_Stopping:             return "Stopping";
+        case MachineState_Saving:               return "Saving";
+        case MachineState_Restoring:            return "Restoring";
+        case MachineState_TeleportingFrom:      return "TeleportingFrom";
+        case MachineState_RestoringSnapshot:    return "RestoringSnapshot";
+        case MachineState_DeletingSnapshot:     return "DeletingSnapshot";
+        case MachineState_SettingUp:            return "SettingUp";
         default:
         {

trunk/src/VBox/Main/MachineImpl.cpp

@@ -6528 +6528 @@
 
     /* must be in a protective state because we leave the lock below */
-    AssertReturn(   mData->mMachineState == MachineState_Saving
-                 || mData->mMachineState == MachineState_Discarding, E_FAIL);
+    AssertReturn(    mData->mMachineState == MachineState_Saving
+                  || mData->mMachineState == MachineState_RestoringSnapshot
+                  || mData->mMachineState == MachineState_DeletingSnapshot,
+                 E_FAIL);
 
     HRESULT rc = S_OK;
@@ -6744 +6746 @@
          * protected) */
         MachineState_T oldState = mData->mMachineState;
-        if (oldState != MachineState_Saving &&
-            oldState != MachineState_Discarding)
-        {
+        if (    oldState != MachineState_Saving
+             && oldState != MachineState_RestoringSnapshot
+             && oldState != MachineState_DeletingSnapshot
+           )
             setMachineState (MachineState_SettingUp);
-        }
 
         alock.leave();
@@ -7573 +7575 @@
 
 /** Discard snapshot task */
-struct SessionMachine::DiscardSnapshotTask
+struct SessionMachine::DeleteSnapshotTask
     : public SessionMachine::Task
 {
-    DiscardSnapshotTask(SessionMachine *m, Progress *p, Snapshot *s)
-        : Task (m, p),
-          snapshot (s)
+    DeleteSnapshotTask(SessionMachine *m, Progress *p, Snapshot *s)
+        : Task(m, p),
+          snapshot(s)
     {}
 
-    DiscardSnapshotTask (const Task &task, Snapshot *s)
-        : Task (task)
-        , snapshot (s)
+    DeleteSnapshotTask (const Task &task, Snapshot *s)
+        : Task(task)
+        , snapshot(s)
     {}
 
@@ -7594 +7596 @@
 };
 
-/** Discard current state task */
-struct SessionMachine::DiscardCurrentStateTask
+/** Restore snapshot state task */
+struct SessionMachine::RestoreSnapshotTask
     : public SessionMachine::Task
 {
-    DiscardCurrentStateTask(SessionMachine *m, Progress *p, bool discardCurSnapshot)
+    RestoreSnapshotTask(SessionMachine *m, Progress *p, bool discardCurSnapshot)
         : Task(m, p),
           discardCurrentSnapshot(discardCurSnapshot)
@@ -7605 +7607 @@
     void handler()
     {
-        machine->discardCurrentStateHandler(*this);
+        machine->restoreSnapshotHandler(*this);
     }
 
@@ -8605 +8607 @@
  *  @note Locks mParent + this + children objects for writing!
  */
-STDMETHODIMP SessionMachine::DiscardSnapshot(IConsole *aInitiator,
-                                             IN_BSTR aId,
-                                             MachineState_T *aMachineState,
-                                             IProgress **aProgress)
+STDMETHODIMP SessionMachine::DeleteSnapshot(IConsole *aInitiator,
+                                            IN_BSTR aId,
+                                            MachineState_T *aMachineState,
+                                            IProgress **aProgress)
 {
     LogFlowThisFunc(("\n"));
@@ -8648 +8650 @@
         {
             rc = saveSettings();
-            CheckComRCReturnRC (rc);
+            CheckComRCReturnRC(rc);
         }
     }
@@ -8657 +8659 @@
     ComObjPtr<Progress> progress;
     progress.createObject();
-    rc = progress->init (mParent, aInitiator,
-                         Bstr(Utf8StrFmt(tr("Discarding snapshot '%s'"),
-                                            snapshot->getName().c_str())),
-                         FALSE /* aCancelable */,
-                         1 + (ULONG)snapshot->getSnapshotMachine()->mMediaData->mAttachments.size() +
-                         (snapshot->stateFilePath().isNull() ? 0 : 1),
-                         Bstr (tr ("Preparing to discard snapshot")));
-    AssertComRCReturn (rc, rc);
+    rc = progress->init(mParent, aInitiator,
+                        BstrFmt(tr("Discarding snapshot '%s'"),
+                                snapshot->getName().c_str()),
+                        FALSE /* aCancelable */,
+                        1 + (ULONG)snapshot->getSnapshotMachine()->mMediaData->mAttachments.size() +
+                        (snapshot->stateFilePath().isNull() ? 0 : 1),
+                        Bstr (tr ("Preparing to discard snapshot")));
+    AssertComRCReturn(rc, rc);
 
     /* create and start the task on a separate thread */
-    DiscardSnapshotTask *task = new DiscardSnapshotTask (this, progress, snapshot);
-    int vrc = RTThreadCreate (NULL, taskHandler,
-                              (void *) task,
-                              0, RTTHREADTYPE_MAIN_WORKER, 0, "DiscardSnapshot");
+    DeleteSnapshotTask *task = new DeleteSnapshotTask(this, progress, snapshot);
+    int vrc = RTThreadCreate(NULL,
+                             taskHandler,
+                             (void*)task,
+                             0,
+                             RTTHREADTYPE_MAIN_WORKER,
+                             0,
+                             "DeleteSnapshot");
     if (RT_FAILURE(vrc))
         delete task;
@@ -8676 +8682 @@
 
     /* set the proper machine state (note: after creating a Task instance) */
-    setMachineState(MachineState_Discarding);
+    setMachineState(MachineState_DeletingSnapshot);
 
     /* return the progress to the caller */
@@ -8690 +8696 @@
  *  @note Locks this + children objects for writing!
  */
-STDMETHODIMP SessionMachine::DiscardCurrentState (
-    IConsole *aInitiator, MachineState_T *aMachineState, IProgress **aProgress)
+STDMETHODIMP SessionMachine::RestoreSnapshot(IConsole *aInitiator,
+                                             ISnapshot *aSnapshot,
+                                             MachineState_T *aMachineState,
+                                             IProgress **aProgress)
 {
     LogFlowThisFunc(("\n"));
@@ -8703 +8711 @@
     AutoWriteLock alock(this);
 
-    ComAssertRet (!Global::IsOnlineOrTransient (mData->mMachineState), E_FAIL);
+    ComAssertRet(!Global::IsOnlineOrTransient(mData->mMachineState),
+                 E_FAIL);
 
     if (mData->mCurrentSnapshot.isNull())
@@ -8726 +8735 @@
     /* create and start the task on a separate thread (note that it will not
      * start working until we release alock) */
-    DiscardCurrentStateTask *task =
-        new DiscardCurrentStateTask (this, progress, false /* discardCurSnapshot */);
-    int vrc = RTThreadCreate (NULL, taskHandler,
-                              (void *) task,
-                              0, RTTHREADTYPE_MAIN_WORKER, 0, "DiscardCurState");
-    if (RT_FAILURE(vrc))
-    {
-        delete task;
-        ComAssertRCRet (vrc, E_FAIL);
-    }
-
-    /* set the proper machine state (note: after creating a Task instance) */
-    setMachineState (MachineState_Discarding);
-
-    /* return the progress to the caller */
-    progress.queryInterfaceTo(aProgress);
-
-    /* return the new state to the caller */
-    *aMachineState = mData->mMachineState;
-
-    return S_OK;
-}
-
-/**
- *  @note Locks thos object for writing!
- */
-STDMETHODIMP SessionMachine::DiscardCurrentSnapshotAndState(IConsole *aInitiator,
-                                                            MachineState_T *aMachineState,
-                                                            IProgress **aProgress)
-{
-    LogFlowThisFunc(("\n"));
-
-    AssertReturn(aInitiator, E_INVALIDARG);
-    AssertReturn(aMachineState && aProgress, E_POINTER);
-
-    AutoCaller autoCaller(this);
-    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
-
-    AutoWriteLock alock(this);
-
-    ComAssertRet (!Global::IsOnlineOrTransient (mData->mMachineState), E_FAIL);
-
-    if (mData->mCurrentSnapshot.isNull())
-        return setError(VBOX_E_INVALID_OBJECT_STATE,
-                        tr("Could not discard the current state of the machine '%ls' "
-                           "because it doesn't have any snapshots"),
-                        mUserData->mName.raw());
-
-    /* create a progress object. The number of operations is:
-     *   1 (preparing) + # of hard disks in the current snapshot +
-     *   # of hard disks in the previous snapshot +
-     *   1 if we need to copy the saved state file of the previous snapshot +
-     *   1 if the current snapshot is online
-     * or (if there is no previous snapshot):
-     *   1 (preparing) + # of hard disks in the current snapshot * 2 +
-     *   1 if we need to copy the saved state file of the current snapshot * 2
-     */
-    ComObjPtr<Progress> progress;
-    progress.createObject();
-    {
-        ComObjPtr<Snapshot> curSnapshot = mData->mCurrentSnapshot;
-        ComObjPtr<Snapshot> prevSnapshot = mData->mCurrentSnapshot->parent();
-
-        ULONG opCount = 1;
-        if (prevSnapshot)
-        {
-            opCount += (ULONG)curSnapshot->getSnapshotMachine()->mMediaData->mAttachments.size();
-            opCount += (ULONG)prevSnapshot->getSnapshotMachine()->mMediaData->mAttachments.size();
-            if (prevSnapshot->stateFilePath())
-                ++opCount;
-            if (curSnapshot->stateFilePath())
-                ++opCount;
-        }
-        else
-        {
-            opCount +=
-                (ULONG)curSnapshot->getSnapshotMachine()->mMediaData->mAttachments.size() * 2;
-            if (curSnapshot->stateFilePath())
-                opCount += 2;
-        }
-
-        progress->init(mParent, aInitiator,
-                       Bstr (tr ("Discarding current machine snapshot and state")),
-                       FALSE /* aCancelable */, opCount,
-                       Bstr (tr ("Preparing to discard current snapshot and state")));
-    }
-
-    /* create and start the task on a separate thread */
-    DiscardCurrentStateTask *task =
-        new DiscardCurrentStateTask (this, progress, true /* discardCurSnapshot */);
-    int vrc = RTThreadCreate(NULL, taskHandler,
-                             (void *) task,
-                             0, RTTHREADTYPE_MAIN_WORKER, 0, "DiscardCurStSnp");
+    RestoreSnapshotTask *task = new RestoreSnapshotTask(this, progress, false /* discardCurSnapshot */);
+    int vrc = RTThreadCreate(NULL,
+                             taskHandler,
+                             (void*)task,
+                             0,
+                             RTTHREADTYPE_MAIN_WORKER,
+                             0,
+                             "DiscardCurState");
     if (RT_FAILURE(vrc))
     {
@@ -8826 +8750 @@
 
     /* set the proper machine state (note: after creating a Task instance) */
-    setMachineState(MachineState_Discarding);
+    setMachineState(MachineState_RestoringSnapshot);
 
     /* return the progress to the caller */
@@ -9558 +9482 @@
 /**
  * Discard snapshot task handler. Must be called only by
- * DiscardSnapshotTask::handler()!
+ * DeleteSnapshotTask::handler()!
  *
  * When aTask.subTask is true, the associated progress object is left
@@ -9566 +9490 @@
  * @note Locks mParent + this + child objects for writing!
  */
-void SessionMachine::discardSnapshotHandler(DiscardSnapshotTask &aTask)
+void SessionMachine::discardSnapshotHandler(DeleteSnapshotTask &aTask)
 {
     LogFlowThisFuncEnter();
@@ -9843 +9767 @@
 
 /**
- * Discard current state task handler. Must be called only by
- * DiscardCurrentStateTask::handler()!
+ * Restore snapshot state task handler. Must be called only by
+ * RestoreSnapshotTask::handler()!
  *
  * @note Locks mParent + this object for writing.
  */
-void SessionMachine::discardCurrentStateHandler (DiscardCurrentStateTask &aTask)
+void SessionMachine::restoreSnapshotHandler(RestoreSnapshotTask &aTask)
 {
     LogFlowThisFuncEnter();
@@ -9859 +9783 @@
         /* we might have been uninitialized because the session was accidentally
          * closed by the client, so don't assert */
-        aTask.progress->notifyComplete (
-            E_FAIL, COM_IIDOF (IMachine), getComponentName(),
-            tr ("The session has been accidentally closed"));
+        aTask.progress->notifyComplete(E_FAIL,
+                                       COM_IIDOF(IMachine),
+                                       getComponentName(),
+                                       tr("The session has been accidentally closed"));
 
         LogFlowThisFuncLeave();
@@ -9881 +9806 @@
      * session) */
     if (isModified())
-        rollback (false /* aNotify */);
+        rollback(false /* aNotify */);
 
     HRESULT rc = S_OK;
@@ -9910 +9835 @@
              * snapshot first */
 
-            DiscardSnapshotTask subTask (aTask, mData->mCurrentSnapshot);
+            DeleteSnapshotTask subTask (aTask, mData->mCurrentSnapshot);
             subTask.subTask = true;
             discardSnapshotHandler (subTask);
@@ -10059 +9984 @@
              * after discarding the current state. */
 
-            DiscardSnapshotTask subTask (aTask, mData->mCurrentSnapshot);
+            DeleteSnapshotTask subTask (aTask, mData->mCurrentSnapshot);
             subTask.subTask = true;
             discardSnapshotHandler (subTask);
@@ -10395 +10320 @@
     }
     else if (   oldMachineState >= MachineState_Running
-             && oldMachineState != MachineState_Discarding
+             && oldMachineState != MachineState_RestoringSnapshot
+             && oldMachineState != MachineState_DeletingSnapshot
              && oldMachineState != MachineState_SettingUp
              && aMachineState < MachineState_Running

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

@@ -574 +574 @@
     +-> PoweredOff --+
     |                |
-    |   Aborted -----+-->[discardSnapshot()    ]-------------> Discarding --+
-    |                |   [discardCurrentState()]                            |
-    +-> Saved -------+   [discardCurrentSnapshotAndState()]                 |
+    |   Aborted -----+-->[restoreSnapshot()    ]-------> RestoringSnapshot -+
+    |                |   [deleteSnapshot()     ]-------> DeletingSnapshot --+
+    +-> Saved -------+                                                      |
     |                                                                       |
     +---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
@@ -678 +678 @@
       </desc>
     </const>
-    <const name="Discarding"            value="12">
-      <desc>
-        Snapshot of the machine is being discarded.
-      </desc>
-    </const>
-    <const name="SettingUp"             value="13">
+    <const name="RestoringSnapshot"     value="12">
+      <desc>
+        A machine snapshot is being restored; this typically does not take long.
+      </desc>
+    </const>
+    <const name="DeletingSnapshot"      value="13">
+      <desc>
+        A machine snapshot is being deleted; this can take a long time since this
+        may require merging differencing hard disk images.
+      </desc>
+    </const>
+    <const name="SettingUp"             value="14">
       <desc>
         Lengthy setup operation is in progress.
@@ -705 +711 @@
       </desc>
     </const>
-    <const name="LastTransient"  value="13" wsmap="suppress"> <!-- SettingUp -->
+    <const name="LastTransient"  value="14" wsmap="suppress"> <!-- SettingUp -->
       <desc>
         Pseudo-state: last transient state (for use in relational expressions).
@@ -3631 +3637 @@
   <interface
      name="IInternalMachineControl" extends="$unknown"
-     uuid="6c08103e-b8e6-44fb-bc6c-36067153d4bd"
+     uuid="4e2b8f0f-6575-49d2-bb19-5cd15a6ca2f0"
      internal="yes"
      wsmap="suppress"
@@ -3854 +3860 @@
     </method>
 
-    <method name="discardSnapshot">
-      <desc>
-        Gets called by IConsole::discardSnapshot.
+    <method name="deleteSnapshot">
+      <desc>
+        Gets called by IConsole::deleteSnapshot.
         <result name="VBOX_E_INVALID_OBJECT_STATE">
           Snapshot has more than one child snapshot.
@@ -3875 +3881 @@
     </method>
 
-    <method name="discardCurrentState">
-      <desc>
-        Gets called by IConsole::discardCurrentState.
-        <result name="VBOX_E_INVALID_OBJECT_STATE">
-          Virtual machine does not have any snapshot.
-        </result>
+    <method name="restoreSnapshot">
+      <desc>
+        Gets called by IConsole::RestoreSnapshot.
       </desc>
       <param name="initiator" type="IConsole" dir="in">
         <desc>The console object that initiated this call.</desc>
       </param>
-      <param name="machineState" type="MachineState" dir="out">
-        <desc>New machine state after this operation is started.</desc>
-      </param>
-      <param name="progress" type="IProgress" dir="return">
-        <desc>Progress object to track the operation completion.</desc>
-      </param>
-    </method>
-
-    <method name="discardCurrentSnapshotAndState">
-      <desc>
-        Gets called by IConsole::discardCurrentSnapshotAndState.
-        <result name="VBOX_E_INVALID_OBJECT_STATE">
-          Virtual machine does not have any snapshot.
-        </result>
-      </desc>
-      <param name="initiator" type="IConsole" dir="in">
-        <desc>The console object that initiated this call.</desc>
+      <param name="snapshot" type="ISnapshot" dir="in">
+        <desc>The snapshot to restore the VM state from.</desc>
       </param>
       <param name="machineState" type="MachineState" dir="out">
@@ -4454 +4442 @@
       <desc>
         Current snapshot of this machine. This is @c null if the machine
-        currently has no snapshots. Otherwise, this is always the last snapshot
-        in the current implementation; see <link to="ISnapshot"/> for details.
+        currently has no snapshots. If it is not @c null, then it was
+        set by one of <link to="Console::takeSnapshot" />,
+        <link to="Console::deleteSnapshot" />
+        or <link to="Console::restoreSnapshot" />, depending on which
+        was called last. See <link to="ISnapshot"/> for details.
       </desc>
     </attribute>
@@ -4471 +4462 @@
         identical to the state stored in the current snapshot.
 
-        The current state is identical to the current snapshot right
-        after one of the following calls are made:
+        The current state is identical to the current snapshot only
+        directly after one of the following calls are made:
+
         <ul>
-          <li><link to="IConsole::discardCurrentState"/> or
-            <link to="IConsole::discardCurrentSnapshotAndState"/>
+          <li><link to="IConsole::restoreSnapshot"/>
           </li>
           <li><link to="IConsole::takeSnapshot"/> (issued on a
-            powered off or saved machine, for which
+            "powered off" or "saved" machine, for which
             <link to="#settingsModified"/> returns @c false)
           </li>
@@ -6088 +6079 @@
   <interface
      name="IConsole" extends="$unknown"
-     uuid="03312360-0364-4b7a-ad71-1a8450133774"
+     uuid="55dd56a5-1d1d-4d81-b742-b082b9571be6"
      wsmap="managed"
      >
@@ -6642 +6633 @@
     </method>
 
-    <method name="discardSnapshot">
+    <method name="deleteSnapshot">
       <desc>
         Starts discarding the specified snapshot asynchronously.
@@ -6738 +6729 @@
     </method>
 
-    <method name="discardCurrentState">
+    <method name="restoreSnapshot">
       <desc>
         Starts resetting the machine's current state to the state contained
-        in the current snapshot, asynchronously. All current settings of the
+        in the given snapshot, asynchronously. All current settings of the
         machine will be reset and changes stored in differencing media
         will be lost.
@@ -6749 +6740 @@
         media are created for all normal media of the machine.
 
-        If the current snapshot of the machine is an online snapshot, the
-        machine will go to the <link to="MachineState_Saved"> saved
-        state</link>, so that the next time it is powered on, the execution
-        state will be restored from the current snapshot.
+        If the given snapshot is an online snapshot, the machine will go to
+        the <link to="MachineState_Saved"> saved state</link>, so that the
+        next time it is powered on, the execution state will be restored
+        from the state of the snapshot.
 
         <note>
@@ -6769 +6760 @@
         </result>
       </desc>
-      <param name="progress" type="IProgress" dir="return">
-        <desc>Progress object to track the operation completion.</desc>
-      </param>
-    </method>
-
-    <method name="discardCurrentSnapshotAndState">
-      <desc>
-
-        This method is equivalent to
-        doing <link to="IConsole::discardSnapshot">discardSnapshot</link>
-        (currentSnapshot.id(), progress) followed by
-        <link to="IConsole::discardCurrentState"/>.
-
-        As a result, the machine will be fully restored from the
-        snapshot preceding the current snapshot, while both the current
-        snapshot and the current machine state will be discarded.
-
-        If the current snapshot is the first snapshot of the machine (i.e. it
-        has the only snapshot), the current machine state will be
-        discarded <b>before</b> discarding the snapshot. In other words, the
-        machine will be restored from its last snapshot, before discarding
-        it. This differs from performing a single
-        <link to="IConsole::discardSnapshot"/> call (note that no
-        <link to="IConsole::discardCurrentState"/> will be possible after it)
-        to the effect that the latter will preserve the current state instead of
-        discarding it.
-
-        Unless explicitly mentioned otherwise, all remarks and
-        limitations of the above two methods also apply to this method.
-
-        <note>
-          The machine must not be running, otherwise the operation
-          will fail.
-        </note>
-
-        <note>
-          If the machine state is <link to="MachineState_Saved">Saved</link>
-          prior to this operation, the saved state file will be implicitly
-          discarded (as if <link to="#forgetSavedState"/> were
-          called).
-        </note>
-
-        <note>
-          This method is more efficient than calling both of the above
-          methods separately: it requires less IPC calls and provides
-          a single progress object.
-        </note>
-
-        <result name="VBOX_E_INVALID_VM_STATE">
-          Virtual machine is running.
-        </result>
-      </desc>
+      <param name="snapshot" type="ISnapshot" dir="in">
+        <desc>The snapshot to restore the VM state from.</desc>
+      </param>
       <param name="progress" type="IProgress" dir="return">
         <desc>Progress object to track the operation completion.</desc>
@@ -8174 +8116 @@
           </li>
 
-          <li><link to="IConsole::discardCurrentState"/>: this goes back to
+          <li><link to="IConsole::restoreSnapshot"/>: this goes back to
               a previous snapshot. This resets the machine's state to that of
               the previous snapshot by deleting the differencing image of each
@@ -8183 +8125 @@
           </li>
 
-          <li><link to="IConsole::discardSnapshot"/>: deletes a snapshot
+          <li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
               without affecting the current machine state.
 
@@ -8194 +8136 @@
               by this operation, except that parent disk images will be modified
               to contain the disk data associated with the snapshot being deleted.
-          </li>
-
-          <li><link to="IConsole::discardCurrentSnapshotAndState"/>:
-              this completely reverts the virtual machine to the state it was in
-              before the current snapshot has been taken. Effectively, this goes
-              back to the state before the current snapshot, which might be
-              an earlier snapshot.
-
-              The current state, as well as the current snapshot, are lost.
           </li>
       </ul>

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

@@ -145 +145 @@
     STDMETHOD(TakeSnapshot) (IN_BSTR aName, IN_BSTR aDescription,
                              IProgress **aProgress);
-    STDMETHOD(DiscardSnapshot) (IN_BSTR aId, IProgress **aProgress);
-    STDMETHOD(DiscardCurrentState) (IProgress **aProgress);
-    STDMETHOD(DiscardCurrentSnapshotAndState) (IProgress **aProgress);
+    STDMETHOD(DeleteSnapshot)(IN_BSTR aId, IProgress **aProgress);
+    STDMETHOD(RestoreSnapshot)(ISnapshot *aSnapshot, IProgress **aProgress);
     STDMETHOD(Teleport)(IN_BSTR aHostname, ULONG aPort, IN_BSTR aPassword, IProgress **aProgress);
     STDMETHOD(RegisterCallback) (IConsoleCallback *aCallback);

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

@@ -968 +968 @@
                                    BSTR *aStateFilePath);
     STDMETHOD(EndTakingSnapshot)(BOOL aSuccess);
-    STDMETHOD(DiscardSnapshot)(IConsole *aInitiator, IN_BSTR aId,
-                               MachineState_T *aMachineState, IProgress **aProgress);
-    STDMETHOD(DiscardCurrentState)(IConsole *aInitiator, MachineState_T *aMachineState,
-                                   IProgress **aProgress);
-    STDMETHOD(DiscardCurrentSnapshotAndState)(IConsole *aInitiator, MachineState_T *aMachineState,
-                                              IProgress **aProgress);
+    STDMETHOD(DeleteSnapshot)(IConsole *aInitiator, IN_BSTR aId,
+                              MachineState_T *aMachineState, IProgress **aProgress);
+    STDMETHOD(RestoreSnapshot)(IConsole *aInitiator,
+                               ISnapshot *aSnapshot,
+                               MachineState_T *aMachineState,
+                               IProgress **aProgress);
     STDMETHOD(PullGuestProperties)(ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues),
               ComSafeArrayOut(ULONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
@@ -1024 +1024 @@
 
     struct Task;
-    struct DiscardSnapshotTask;
-    struct DiscardCurrentStateTask;
-
-    friend struct DiscardSnapshotTask;
-    friend struct DiscardCurrentStateTask;
+    struct DeleteSnapshotTask;
+    struct RestoreSnapshotTask;
+
+    friend struct DeleteSnapshotTask;
+    friend struct RestoreSnapshotTask;
 
     void uninit(Uninit::Reason aReason);
@@ -1037 +1037 @@
     typedef std::map<ComObjPtr<Machine>, MachineState_T> AffectedMachines;
 
-    void discardSnapshotHandler(DiscardSnapshotTask &aTask);
-    void discardCurrentStateHandler(DiscardCurrentStateTask &aTask);
+    void discardSnapshotHandler(DeleteSnapshotTask &aTask);
+    void restoreSnapshotHandler(RestoreSnapshotTask &aTask);
 
     HRESULT lockMedia();