/* $Id: VBoxManageSnapshot.cpp 39119 2011-10-26 13:07:47Z vboxsync $ */ /** @file * VBoxManage - The 'snapshot' command. */ /* * Copyright (C) 2006-2010 Oracle Corporation * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. */ /******************************************************************************* * Header Files * *******************************************************************************/ #include #include #include #include #include #include #include #include #include "VBoxManage.h" using namespace com; /** * Helper function used with "VBoxManage snapshot ... dump". Gets called to find the * snapshot in the machine's snapshot tree that uses a particular diff image child of * a medium. * Horribly inefficient since we keep re-querying the snapshots tree for each image, * but this is for quick debugging only. * @param pMedium * @param pThisSnapshot * @param pCurrentSnapshot * @param uMediumLevel * @param uSnapshotLevel * @return */ bool FindAndPrintSnapshotUsingMedium(ComPtr &pMedium, ComPtr &pThisSnapshot, ComPtr &pCurrentSnapshot, uint32_t uMediumLevel, uint32_t uSnapshotLevel) { HRESULT rc; do { // get snapshot machine so we can figure out which diff image this created ComPtr pSnapshotMachine; CHECK_ERROR_BREAK(pThisSnapshot, COMGETTER(Machine)(pSnapshotMachine.asOutParam())); // get media attachments SafeIfaceArray aAttachments; CHECK_ERROR_BREAK(pSnapshotMachine, COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(aAttachments))); for (uint32_t i = 0; i < aAttachments.size(); ++i) { ComPtr pAttach(aAttachments[i]); DeviceType_T type; CHECK_ERROR_BREAK(pAttach, COMGETTER(Type)(&type)); if (type == DeviceType_HardDisk) { ComPtr pMediumInSnapshot; CHECK_ERROR_BREAK(pAttach, COMGETTER(Medium)(pMediumInSnapshot.asOutParam())); if (pMediumInSnapshot == pMedium) { // get snapshot name Bstr bstrSnapshotName; CHECK_ERROR_BREAK(pThisSnapshot, COMGETTER(Name)(bstrSnapshotName.asOutParam())); RTPrintf("%*s \"%ls\"%s\n", 50 + uSnapshotLevel * 2, "", // indent bstrSnapshotName.raw(), (pThisSnapshot == pCurrentSnapshot) ? " (CURSNAP)" : ""); return true; // found } } } // not found: then recurse into child snapshots SafeIfaceArray aSnapshots; CHECK_ERROR_BREAK(pThisSnapshot, COMGETTER(Children)(ComSafeArrayAsOutParam(aSnapshots))); for (uint32_t i = 0; i < aSnapshots.size(); ++i) { ComPtr pChild(aSnapshots[i]); if (FindAndPrintSnapshotUsingMedium(pMedium, pChild, pCurrentSnapshot, uMediumLevel, uSnapshotLevel + 1)) // found: break; } } while (0); return false; } /** * Helper function used with "VBoxManage snapshot ... dump". Called from DumpSnapshot() * for each hard disk attachment found in a virtual machine. This then writes out the * root (base) medium for that hard disk attachment and recurses into the children * tree of that medium, correlating it with the snapshots of the machine. * @param pCurrentStateMedium constant, the medium listed in the current machine data (latest diff image). * @param pMedium variant, initially the base medium, then a child of the base medium when recursing. * @param pRootSnapshot constant, the root snapshot of the machine, if any; this then looks into the child snapshots. * @param pCurrentSnapshot constant, the machine's current snapshot (so we can mark it in the output). * @param uLevel variant, the recursion level for output indentation. */ void DumpMediumWithChildren(ComPtr &pCurrentStateMedium, ComPtr &pMedium, ComPtr &pRootSnapshot, ComPtr &pCurrentSnapshot, uint32_t uLevel) { HRESULT rc; do { // print this medium Bstr bstrMediumName; CHECK_ERROR_BREAK(pMedium, COMGETTER(Name)(bstrMediumName.asOutParam())); RTPrintf("%*s \"%ls\"%s\n", uLevel * 2, "", // indent bstrMediumName.raw(), (pCurrentStateMedium == pMedium) ? " (CURSTATE)" : ""); // find and print the snapshot that uses this particular medium (diff image) FindAndPrintSnapshotUsingMedium(pMedium, pRootSnapshot, pCurrentSnapshot, uLevel, 0); // recurse into children SafeIfaceArray aChildren; CHECK_ERROR_BREAK(pMedium, COMGETTER(Children)(ComSafeArrayAsOutParam(aChildren))); for (uint32_t i = 0; i < aChildren.size(); ++i) { ComPtr pChild(aChildren[i]); DumpMediumWithChildren(pCurrentStateMedium, pChild, pRootSnapshot, pCurrentSnapshot, uLevel + 1); } } while (0); } /** * Handles the 'snapshot myvm list' sub-command. * @returns Exit code. * @param pArgs The handler argument package. * @param rptrMachine Reference to the VM (locked) we're operating on. */ static RTEXITCODE handleSnapshotList(HandlerArg *pArgs, ComPtr &rptrMachine) { static const RTGETOPTDEF g_aOptions[] = { { "--details", 'D', RTGETOPT_REQ_NOTHING }, { "--machinereadable", 'M', RTGETOPT_REQ_NOTHING }, }; VMINFO_DETAILS enmDetails = VMINFO_STANDARD; int c; RTGETOPTUNION ValueUnion; RTGETOPTSTATE GetState; // start at 0 because main() has hacked both the argc and argv given to us RTGetOptInit(&GetState, pArgs->argc, pArgs->argv, g_aOptions, RT_ELEMENTS(g_aOptions), 2 /*iArg*/, 0 /*fFlags*/); while ((c = RTGetOpt(&GetState, &ValueUnion))) { switch (c) { case 'D': enmDetails = VMINFO_FULL; break; case 'M': enmDetails = VMINFO_MACHINEREADABLE; break; default: return errorGetOpt(USAGE_SNAPSHOT, c, &ValueUnion); } } /* See showVMInfo. */ ComPtr ptrSnapshot; CHECK_ERROR2_RET(rptrMachine, FindSnapshot(Bstr().raw(), ptrSnapshot.asOutParam()), RTEXITCODE_FAILURE); if (ptrSnapshot) { ComPtr ptrCurrentSnapshot; CHECK_ERROR2_RET(rptrMachine,COMGETTER(CurrentSnapshot)(ptrCurrentSnapshot.asOutParam()), RTEXITCODE_FAILURE); HRESULT hrc = showSnapshots(ptrSnapshot, ptrCurrentSnapshot, enmDetails); if (FAILED(hrc)) return RTEXITCODE_FAILURE; } return RTEXITCODE_SUCCESS; } /** * Implementation for "VBoxManage snapshot ... dump". This goes thru the machine's * medium attachments and calls DumpMediumWithChildren() for each hard disk medium found, * which then dumps the parent/child tree of that medium together with the corresponding * snapshots. * @param pMachine Machine to dump snapshots for. */ void DumpSnapshot(ComPtr &pMachine) { HRESULT rc; do { // get root snapshot ComPtr pSnapshot; CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr("").raw(), pSnapshot.asOutParam())); // get current snapshot ComPtr pCurrentSnapshot; CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam())); // get media attachments SafeIfaceArray aAttachments; CHECK_ERROR_BREAK(pMachine, COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(aAttachments))); for (uint32_t i = 0; i < aAttachments.size(); ++i) { ComPtr pAttach(aAttachments[i]); DeviceType_T type; CHECK_ERROR_BREAK(pAttach, COMGETTER(Type)(&type)); if (type == DeviceType_HardDisk) { ComPtr pCurrentStateMedium; CHECK_ERROR_BREAK(pAttach, COMGETTER(Medium)(pCurrentStateMedium.asOutParam())); ComPtr pBaseMedium; CHECK_ERROR_BREAK(pCurrentStateMedium, COMGETTER(Base)(pBaseMedium.asOutParam())); Bstr bstrBaseMediumName; CHECK_ERROR_BREAK(pBaseMedium, COMGETTER(Name)(bstrBaseMediumName.asOutParam())); RTPrintf("[%RI32] Images and snapshots for medium \"%ls\"\n", i, bstrBaseMediumName.raw()); DumpMediumWithChildren(pCurrentStateMedium, pBaseMedium, pSnapshot, pCurrentSnapshot, 0); } } } while (0); } /** * Implementation for all VBoxManage snapshot ... subcommands. * @param a * @return */ int handleSnapshot(HandlerArg *a) { HRESULT rc; /* we need at least a VM and a command */ if (a->argc < 2) return errorSyntax(USAGE_SNAPSHOT, "Not enough parameters"); /* the first argument must be the VM */ Bstr bstrMachine(a->argv[0]); ComPtr ptrMachine; CHECK_ERROR(a->virtualBox, FindMachine(bstrMachine.raw(), ptrMachine.asOutParam())); if (!ptrMachine) return 1; do { /* we have to open a session for this task (new or shared) */ rc = ptrMachine->LockMachine(a->session, LockType_Shared); ComPtr console; CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam())); /* switch based on the command */ bool fDelete = false, fRestore = false, fRestoreCurrent = false; if (!strcmp(a->argv[1], "take")) { /* there must be a name */ if (a->argc < 3) { errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name"); rc = E_FAIL; break; } Bstr name(a->argv[2]); /* parse the optional arguments */ Bstr desc; bool fPause = false; static const RTGETOPTDEF s_aTakeOptions[] = { { "--description", 'd', RTGETOPT_REQ_STRING }, { "-description", 'd', RTGETOPT_REQ_STRING }, { "-desc", 'd', RTGETOPT_REQ_STRING }, { "--pause", 'p', RTGETOPT_REQ_NOTHING } }; RTGETOPTSTATE GetOptState; RTGetOptInit(&GetOptState, a->argc, a->argv, s_aTakeOptions, RT_ELEMENTS(s_aTakeOptions), 3, RTGETOPTINIT_FLAGS_NO_STD_OPTS); int ch; RTGETOPTUNION Value; while ( SUCCEEDED(rc) && (ch = RTGetOpt(&GetOptState, &Value))) { switch (ch) { case 'p': fPause = true; break; case 'd': desc = Value.psz; break; default: errorGetOpt(USAGE_SNAPSHOT, ch, &Value); rc = E_FAIL; break; } } if (FAILED(rc)) break; if (fPause) { MachineState_T machineState; CHECK_ERROR_BREAK(console, COMGETTER(State)(&machineState)); if (machineState == MachineState_Running) CHECK_ERROR_BREAK(console, Pause()); else fPause = false; } ComPtr progress; CHECK_ERROR_BREAK(console, TakeSnapshot(name.raw(), desc.raw(), progress.asOutParam())); rc = showProgress(progress); CHECK_PROGRESS_ERROR(progress, ("Failed to take snapshot")); if (fPause) { MachineState_T machineState; CHECK_ERROR_BREAK(console, COMGETTER(State)(&machineState)); if (machineState == MachineState_Paused) { if (SUCCEEDED(rc)) CHECK_ERROR_BREAK(console, Resume()); else console->Resume(); } } } else if ( (fDelete = !strcmp(a->argv[1], "delete")) || (fRestore = !strcmp(a->argv[1], "restore")) || (fRestoreCurrent = !strcmp(a->argv[1], "restorecurrent")) ) { if (fRestoreCurrent) { if (a->argc > 2) { errorSyntax(USAGE_SNAPSHOT, "Too many arguments"); rc = E_FAIL; break; } } /* exactly one parameter: snapshot name */ else if (a->argc != 3) { errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only"); rc = E_FAIL; break; } ComPtr pSnapshot; ComPtr pProgress; Bstr bstrSnapGuid; if (fRestoreCurrent) { CHECK_ERROR_BREAK(ptrMachine, COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam())); } else { // restore or delete snapshot: then resolve cmd line argument to snapshot instance CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(), pSnapshot.asOutParam())); } CHECK_ERROR_BREAK(pSnapshot, COMGETTER(Id)(bstrSnapGuid.asOutParam())); if (fDelete) { CHECK_ERROR_BREAK(console, DeleteSnapshot(bstrSnapGuid.raw(), pProgress.asOutParam())); } else { // restore or restore current RTPrintf("Restoring snapshot %ls\n", bstrSnapGuid.raw()); CHECK_ERROR_BREAK(console, RestoreSnapshot(pSnapshot, pProgress.asOutParam())); } rc = showProgress(pProgress); CHECK_PROGRESS_ERROR(pProgress, ("Snapshot operation failed")); } else if (!strcmp(a->argv[1], "edit")) { if (a->argc < 3) { errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name"); rc = E_FAIL; break; } ComPtr snapshot; if ( !strcmp(a->argv[2], "--current") || !strcmp(a->argv[2], "-current")) { CHECK_ERROR_BREAK(ptrMachine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam())); } else { CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(), snapshot.asOutParam())); } /* parse options */ for (int i = 3; i < a->argc; i++) { if ( !strcmp(a->argv[i], "--name") || !strcmp(a->argv[i], "-name") || !strcmp(a->argv[i], "-newname")) { if (a->argc <= i + 1) { errorArgument("Missing argument to '%s'", a->argv[i]); rc = E_FAIL; break; } i++; snapshot->COMSETTER(Name)(Bstr(a->argv[i]).raw()); } else if ( !strcmp(a->argv[i], "--description") || !strcmp(a->argv[i], "-description") || !strcmp(a->argv[i], "-newdesc")) { if (a->argc <= i + 1) { errorArgument("Missing argument to '%s'", a->argv[i]); rc = E_FAIL; break; } i++; snapshot->COMSETTER(Description)(Bstr(a->argv[i]).raw()); } else { errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[i]).c_str()); rc = E_FAIL; break; } } } else if (!strcmp(a->argv[1], "showvminfo")) { /* exactly one parameter: snapshot name */ if (a->argc != 3) { errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only"); rc = E_FAIL; break; } ComPtr snapshot; CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(), snapshot.asOutParam())); /* get the machine of the given snapshot */ ComPtr ptrMachine2; snapshot->COMGETTER(Machine)(ptrMachine2.asOutParam()); showVMInfo(a->virtualBox, ptrMachine2, VMINFO_NONE, console); } else if (!strcmp(a->argv[1], "list")) rc = handleSnapshotList(a, ptrMachine) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL; else if (!strcmp(a->argv[1], "dump")) // undocumented parameter to debug snapshot info DumpSnapshot(ptrMachine); else { errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str()); rc = E_FAIL; } } while (0); a->session->UnlockMachine(); return SUCCEEDED(rc) ? 0 : 1; }