VBoxManageSnapshot.cpp@ 53402

Last change on this file since 53402 was 53267, checked in by vboxsync, 10 years ago
Frontends/VBoxManage: undo accidental changes to VBoxManageSnapshot.cpp
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 18.9 KB

Line
1	/* $Id: VBoxManageSnapshot.cpp 53267 2014-11-07 16:20:24Z vboxsync $ */
2	/** @file
3	* VBoxManage - The 'snapshot' command.
4	*/
5
6	/*
7	* Copyright (C) 2006-2014 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	/*******************************************************************************
19	* Header Files *
20	*******************************************************************************/
21	#include <VBox/com/com.h>
22	#include <VBox/com/string.h>
23	#include <VBox/com/array.h>
24	#include <VBox/com/ErrorInfo.h>
25	#include <VBox/com/errorprint.h>
26
27	#include <VBox/com/VirtualBox.h>
28
29	#include <iprt/stream.h>
30	#include <iprt/getopt.h>
31
32	#include "VBoxManage.h"
33	using namespace com;
34
35	/**
36	* Helper function used with "VBoxManage snapshot ... dump". Gets called to find the
37	* snapshot in the machine's snapshot tree that uses a particular diff image child of
38	* a medium.
39	* Horribly inefficient since we keep re-querying the snapshots tree for each image,
40	* but this is for quick debugging only.
41	* @param pMedium
42	* @param pThisSnapshot
43	* @param pCurrentSnapshot
44	* @param uMediumLevel
45	* @param uSnapshotLevel
46	* @return
47	*/
48	bool FindAndPrintSnapshotUsingMedium(ComPtr<IMedium> &pMedium,
49	ComPtr<ISnapshot> &pThisSnapshot,
50	ComPtr<ISnapshot> &pCurrentSnapshot,
51	uint32_t uMediumLevel,
52	uint32_t uSnapshotLevel)
53	{
54	HRESULT rc;
55
56	do
57	{
58	// get snapshot machine so we can figure out which diff image this created
59	ComPtr<IMachine> pSnapshotMachine;
60	CHECK_ERROR_BREAK(pThisSnapshot, COMGETTER(Machine)(pSnapshotMachine.asOutParam()));
61
62	// get media attachments
63	SafeIfaceArray<IMediumAttachment> aAttachments;
64	CHECK_ERROR_BREAK(pSnapshotMachine, COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(aAttachments)));
65
66	for (uint32_t i = 0;
67	i < aAttachments.size();
68	++i)
69	{
70	ComPtr<IMediumAttachment> pAttach(aAttachments[i]);
71	DeviceType_T type;
72	CHECK_ERROR_BREAK(pAttach, COMGETTER(Type)(&type));
73	if (type == DeviceType_HardDisk)
74	{
75	ComPtr<IMedium> pMediumInSnapshot;
76	CHECK_ERROR_BREAK(pAttach, COMGETTER(Medium)(pMediumInSnapshot.asOutParam()));
77
78	if (pMediumInSnapshot == pMedium)
79	{
80	// get snapshot name
81	Bstr bstrSnapshotName;
82	CHECK_ERROR_BREAK(pThisSnapshot, COMGETTER(Name)(bstrSnapshotName.asOutParam()));
83
84	RTPrintf("%*s \"%ls\"%s\n",
85	50 + uSnapshotLevel * 2, "", // indent
86	bstrSnapshotName.raw(),
87	(pThisSnapshot == pCurrentSnapshot) ? " (CURSNAP)" : "");
88	return true; // found
89	}
90	}
91	}
92
93	// not found: then recurse into child snapshots
94	SafeIfaceArray<ISnapshot> aSnapshots;
95	CHECK_ERROR_BREAK(pThisSnapshot, COMGETTER(Children)(ComSafeArrayAsOutParam(aSnapshots)));
96
97	for (uint32_t i = 0;
98	i < aSnapshots.size();
99	++i)
100	{
101	ComPtr<ISnapshot> pChild(aSnapshots[i]);
102	if (FindAndPrintSnapshotUsingMedium(pMedium,
103	pChild,
104	pCurrentSnapshot,
105	uMediumLevel,
106	uSnapshotLevel + 1))
107	// found:
108	break;
109	}
110	} while (0);
111
112	return false;
113	}
114
115	/**
116	* Helper function used with "VBoxManage snapshot ... dump". Called from DumpSnapshot()
117	* for each hard disk attachment found in a virtual machine. This then writes out the
118	* root (base) medium for that hard disk attachment and recurses into the children
119	* tree of that medium, correlating it with the snapshots of the machine.
120	* @param pCurrentStateMedium constant, the medium listed in the current machine data (latest diff image).
121	* @param pMedium variant, initially the base medium, then a child of the base medium when recursing.
122	* @param pRootSnapshot constant, the root snapshot of the machine, if any; this then looks into the child snapshots.
123	* @param pCurrentSnapshot constant, the machine's current snapshot (so we can mark it in the output).
124	* @param uLevel variant, the recursion level for output indentation.
125	*/
126	void DumpMediumWithChildren(ComPtr<IMedium> &pCurrentStateMedium,
127	ComPtr<IMedium> &pMedium,
128	ComPtr<ISnapshot> &pRootSnapshot,
129	ComPtr<ISnapshot> &pCurrentSnapshot,
130	uint32_t uLevel)
131	{
132	HRESULT rc;
133	do
134	{
135	// print this medium
136	Bstr bstrMediumName;
137	CHECK_ERROR_BREAK(pMedium, COMGETTER(Name)(bstrMediumName.asOutParam()));
138	RTPrintf("%*s \"%ls\"%s\n",
139	uLevel * 2, "", // indent
140	bstrMediumName.raw(),
141	(pCurrentStateMedium == pMedium) ? " (CURSTATE)" : "");
142
143	// find and print the snapshot that uses this particular medium (diff image)
144	FindAndPrintSnapshotUsingMedium(pMedium, pRootSnapshot, pCurrentSnapshot, uLevel, 0);
145
146	// recurse into children
147	SafeIfaceArray<IMedium> aChildren;
148	CHECK_ERROR_BREAK(pMedium, COMGETTER(Children)(ComSafeArrayAsOutParam(aChildren)));
149	for (uint32_t i = 0;
150	i < aChildren.size();
151	++i)
152	{
153	ComPtr<IMedium> pChild(aChildren[i]);
154	DumpMediumWithChildren(pCurrentStateMedium, pChild, pRootSnapshot, pCurrentSnapshot, uLevel + 1);
155	}
156	} while (0);
157	}
158
159
160	/**
161	* Handles the 'snapshot myvm list' sub-command.
162	* @returns Exit code.
163	* @param pArgs The handler argument package.
164	* @param pMachine Reference to the VM (locked) we're operating on.
165	*/
166	static RTEXITCODE handleSnapshotList(HandlerArg *pArgs, ComPtr<IMachine> &pMachine)
167	{
168	static const RTGETOPTDEF g_aOptions[] =
169	{
170	{ "--details", 'D', RTGETOPT_REQ_NOTHING },
171	{ "--machinereadable", 'M', RTGETOPT_REQ_NOTHING },
172	};
173
174	VMINFO_DETAILS enmDetails = VMINFO_STANDARD;
175
176	int c;
177	RTGETOPTUNION ValueUnion;
178	RTGETOPTSTATE GetState;
179	RTGetOptInit(&GetState, pArgs->argc, pArgs->argv, g_aOptions, RT_ELEMENTS(g_aOptions), 2 /iArg/, 0 /fFlags/);
180	while ((c = RTGetOpt(&GetState, &ValueUnion)))
181	{
182	switch (c)
183	{
184	case 'D': enmDetails = VMINFO_FULL; break;
185	case 'M': enmDetails = VMINFO_MACHINEREADABLE; break;
186	default: return errorGetOpt(USAGE_SNAPSHOT, c, &ValueUnion);
187	}
188	}
189
190	ComPtr<ISnapshot> pSnapshot;
191	HRESULT hrc = pMachine->FindSnapshot(Bstr().raw(), pSnapshot.asOutParam());
192	if (FAILED(hrc))
193	{
194	RTPrintf("This machine does not have any snapshots\n");
195	return RTEXITCODE_FAILURE;
196	}
197	if (pSnapshot)
198	{
199	ComPtr<ISnapshot> pCurrentSnapshot;
200	CHECK_ERROR2_RET(pMachine,COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam()), RTEXITCODE_FAILURE);
201	hrc = showSnapshots(pSnapshot, pCurrentSnapshot, enmDetails);
202	if (FAILED(hrc))
203	return RTEXITCODE_FAILURE;
204	}
205	return RTEXITCODE_SUCCESS;
206	}
207
208	/**
209	* Implementation for "VBoxManage snapshot ... dump". This goes thru the machine's
210	* medium attachments and calls DumpMediumWithChildren() for each hard disk medium found,
211	* which then dumps the parent/child tree of that medium together with the corresponding
212	* snapshots.
213	* @param pMachine Machine to dump snapshots for.
214	*/
215	void DumpSnapshot(ComPtr<IMachine> &pMachine)
216	{
217	HRESULT rc;
218
219	do
220	{
221	// get root snapshot
222	ComPtr<ISnapshot> pSnapshot;
223	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr("").raw(), pSnapshot.asOutParam()));
224
225	// get current snapshot
226	ComPtr<ISnapshot> pCurrentSnapshot;
227	CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam()));
228
229	// get media attachments
230	SafeIfaceArray<IMediumAttachment> aAttachments;
231	CHECK_ERROR_BREAK(pMachine, COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(aAttachments)));
232	for (uint32_t i = 0;
233	i < aAttachments.size();
234	++i)
235	{
236	ComPtr<IMediumAttachment> pAttach(aAttachments[i]);
237	DeviceType_T type;
238	CHECK_ERROR_BREAK(pAttach, COMGETTER(Type)(&type));
239	if (type == DeviceType_HardDisk)
240	{
241	ComPtr<IMedium> pCurrentStateMedium;
242	CHECK_ERROR_BREAK(pAttach, COMGETTER(Medium)(pCurrentStateMedium.asOutParam()));
243
244	ComPtr<IMedium> pBaseMedium;
245	CHECK_ERROR_BREAK(pCurrentStateMedium, COMGETTER(Base)(pBaseMedium.asOutParam()));
246
247	Bstr bstrBaseMediumName;
248	CHECK_ERROR_BREAK(pBaseMedium, COMGETTER(Name)(bstrBaseMediumName.asOutParam()));
249
250	RTPrintf("[%RI32] Images and snapshots for medium \"%ls\"\n", i, bstrBaseMediumName.raw());
251
252	DumpMediumWithChildren(pCurrentStateMedium,
253	pBaseMedium,
254	pSnapshot,
255	pCurrentSnapshot,
256	0);
257	}
258	}
259	} while (0);
260	}
261
262	/**
263	* Implementation for all VBoxManage snapshot ... subcommands.
264	* @param a
265	* @return
266	*/
267	int handleSnapshot(HandlerArg *a)
268	{
269	HRESULT rc;
270
271	/* we need at least a VM and a command */
272	if (a->argc < 2)
273	return errorSyntax(USAGE_SNAPSHOT, "Not enough parameters");
274
275	/* the first argument must be the VM */
276	Bstr bstrMachine(a->argv[0]);
277	ComPtr<IMachine> pMachine;
278	CHECK_ERROR(a->virtualBox, FindMachine(bstrMachine.raw(),
279	pMachine.asOutParam()));
280	if (!pMachine)
281	return 1;
282
283	do
284	{
285	/* we have to open a session for this task (new or shared) */
286	rc = pMachine->LockMachine(a->session, LockType_Shared);
287	ComPtr<IConsole> pConsole;
288	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(pConsole.asOutParam()));
289
290	/* switch based on the command */
291	bool fDelete = false,
292	fRestore = false,
293	fRestoreCurrent = false;
294
295	if (!strcmp(a->argv[1], "take"))
296	{
297	/* there must be a name */
298	if (a->argc < 3)
299	{
300	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
301	rc = E_FAIL;
302	break;
303	}
304	Bstr name(a->argv[2]);
305
306	/* parse the optional arguments */
307	Bstr desc;
308	bool fPause = true; /* default is NO live snapshot */
309	static const RTGETOPTDEF s_aTakeOptions[] =
310	{
311	{ "--description", 'd', RTGETOPT_REQ_STRING },
312	{ "-description", 'd', RTGETOPT_REQ_STRING },
313	{ "-desc", 'd', RTGETOPT_REQ_STRING },
314	{ "--pause", 'p', RTGETOPT_REQ_NOTHING },
315	{ "--live", 'l', RTGETOPT_REQ_NOTHING }
316	};
317	RTGETOPTSTATE GetOptState;
318	RTGetOptInit(&GetOptState, a->argc, a->argv, s_aTakeOptions, RT_ELEMENTS(s_aTakeOptions),
319	3, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
320	int ch;
321	RTGETOPTUNION Value;
322	while ( SUCCEEDED(rc)
323	&& (ch = RTGetOpt(&GetOptState, &Value)))
324	{
325	switch (ch)
326	{
327	case 'p':
328	fPause = true;
329	break;
330
331	case 'l':
332	fPause = false;
333	break;
334
335	case 'd':
336	desc = Value.psz;
337	break;
338
339	default:
340	errorGetOpt(USAGE_SNAPSHOT, ch, &Value);
341	rc = E_FAIL;
342	break;
343	}
344	}
345	if (FAILED(rc))
346	break;
347
348	if (fPause)
349	{
350	MachineState_T machineState;
351	CHECK_ERROR_BREAK(pConsole, COMGETTER(State)(&machineState));
352	if (machineState == MachineState_Running)
353	CHECK_ERROR_BREAK(pConsole, Pause());
354	else
355	fPause = false;
356	}
357
358	ComPtr<IProgress> progress;
359	CHECK_ERROR_BREAK(pConsole, TakeSnapshot(name.raw(), desc.raw(),
360	progress.asOutParam()));
361
362	rc = showProgress(progress);
363	CHECK_PROGRESS_ERROR(progress, ("Failed to take snapshot"));
364
365	if (fPause)
366	{
367	MachineState_T machineState;
368	CHECK_ERROR_BREAK(pConsole, COMGETTER(State)(&machineState));
369	if (machineState == MachineState_Paused)
370	{
371	if (SUCCEEDED(rc))
372	CHECK_ERROR_BREAK(pConsole, Resume());
373	else
374	pConsole->Resume();
375	}
376	}
377	}
378	else if ( (fDelete = !strcmp(a->argv[1], "delete"))
379	\|\| (fRestore = !strcmp(a->argv[1], "restore"))
380	\|\| (fRestoreCurrent = !strcmp(a->argv[1], "restorecurrent"))
381	)
382	{
383	if (fRestoreCurrent)
384	{
385	if (a->argc > 2)
386	{
387	errorSyntax(USAGE_SNAPSHOT, "Too many arguments");
388	rc = E_FAIL;
389	break;
390	}
391	}
392	/* exactly one parameter: snapshot name */
393	else if (a->argc != 3)
394	{
395	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
396	rc = E_FAIL;
397	break;
398	}
399
400	ComPtr<ISnapshot> pSnapshot;
401	ComPtr<IProgress> pProgress;
402	Bstr bstrSnapGuid;
403
404	if (fRestoreCurrent)
405	{
406	CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam()));
407	}
408	else
409	{
410	// restore or delete snapshot: then resolve cmd line argument to snapshot instance
411	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
412	pSnapshot.asOutParam()));
413	}
414
415	CHECK_ERROR_BREAK(pSnapshot, COMGETTER(Id)(bstrSnapGuid.asOutParam()));
416
417	if (fDelete)
418	{
419	CHECK_ERROR_BREAK(pConsole, DeleteSnapshot(bstrSnapGuid.raw(),
420	pProgress.asOutParam()));
421	}
422	else
423	{
424	// restore or restore current
425	RTPrintf("Restoring snapshot %ls\n", bstrSnapGuid.raw());
426	CHECK_ERROR_BREAK(pConsole, RestoreSnapshot(pSnapshot, pProgress.asOutParam()));
427	}
428
429	rc = showProgress(pProgress);
430	CHECK_PROGRESS_ERROR(pProgress, ("Snapshot operation failed"));
431	}
432	else if (!strcmp(a->argv[1], "edit"))
433	{
434	if (a->argc < 3)
435	{
436	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
437	rc = E_FAIL;
438	break;
439	}
440
441	ComPtr<ISnapshot> pSnapshot;
442
443	if ( !strcmp(a->argv[2], "--current")
444	\|\| !strcmp(a->argv[2], "-current"))
445	{
446	CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam()));
447	}
448	else
449	{
450	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
451	pSnapshot.asOutParam()));
452	}
453
454	/* parse options */
455	for (int i = 3; i < a->argc; i++)
456	{
457	if ( !strcmp(a->argv[i], "--name")
458	\|\| !strcmp(a->argv[i], "-name")
459	\|\| !strcmp(a->argv[i], "-newname"))
460	{
461	if (a->argc <= i + 1)
462	{
463	errorArgument("Missing argument to '%s'", a->argv[i]);
464	rc = E_FAIL;
465	break;
466	}
467	i++;
468	pSnapshot->COMSETTER(Name)(Bstr(a->argv[i]).raw());
469	}
470	else if ( !strcmp(a->argv[i], "--description")
471	\|\| !strcmp(a->argv[i], "-description")
472	\|\| !strcmp(a->argv[i], "-newdesc"))
473	{
474	if (a->argc <= i + 1)
475	{
476	errorArgument("Missing argument to '%s'", a->argv[i]);
477	rc = E_FAIL;
478	break;
479	}
480	i++;
481	pSnapshot->COMSETTER(Description)(Bstr(a->argv[i]).raw());
482	}
483	else
484	{
485	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[i]).c_str());
486	rc = E_FAIL;
487	break;
488	}
489	}
490
491	}
492	else if (!strcmp(a->argv[1], "showvminfo"))
493	{
494	/* exactly one parameter: snapshot name */
495	if (a->argc != 3)
496	{
497	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
498	rc = E_FAIL;
499	break;
500	}
501
502	ComPtr<ISnapshot> pSnapshot;
503
504	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
505	pSnapshot.asOutParam()));
506
507	/* get the machine of the given snapshot */
508	ComPtr<IMachine> pMachine2;
509	pSnapshot->COMGETTER(Machine)(pMachine2.asOutParam());
510	showVMInfo(a->virtualBox, pMachine2, NULL, VMINFO_NONE);
511	}
512	else if (!strcmp(a->argv[1], "list"))
513	rc = handleSnapshotList(a, pMachine) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
514	else if (!strcmp(a->argv[1], "dump")) // undocumented parameter to debug snapshot info
515	DumpSnapshot(pMachine);
516	else
517	{
518	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str());
519	rc = E_FAIL;
520	}
521	} while (0);
522
523	a->session->UnlockMachine();
524
525	return SUCCEEDED(rc) ? 0 : 1;
526	}
527

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Frontends/VBoxManage/VBoxManageSnapshot.cpp@ 53402

Download in other formats: