VBoxManageSnapshot.cpp@ 40673

Last change on this file since 40673 was 39120, checked in by vboxsync, 13 years ago
VBoxManage: added a list sub-command to snapshot: snapshot myvm list
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 18.7 KB

Line
1	/* $Id: VBoxManageSnapshot.cpp 39120 2011-10-26 13:08:13Z vboxsync $ */
2	/** @file
3	* VBoxManage - The 'snapshot' command.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 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 rptrMachine Reference to the VM (locked) we're operating on.
165	*/
166	static RTEXITCODE handleSnapshotList(HandlerArg *pArgs, ComPtr<IMachine> &rptrMachine)
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	/* See showVMInfo. */
191	ComPtr<ISnapshot> ptrSnapshot;
192	CHECK_ERROR2_RET(rptrMachine, FindSnapshot(Bstr().raw(), ptrSnapshot.asOutParam()), RTEXITCODE_FAILURE);
193	if (ptrSnapshot)
194	{
195	ComPtr<ISnapshot> ptrCurrentSnapshot;
196	CHECK_ERROR2_RET(rptrMachine,COMGETTER(CurrentSnapshot)(ptrCurrentSnapshot.asOutParam()), RTEXITCODE_FAILURE);
197	HRESULT hrc = showSnapshots(ptrSnapshot, ptrCurrentSnapshot, enmDetails);
198	if (FAILED(hrc))
199	return RTEXITCODE_FAILURE;
200	}
201	return RTEXITCODE_SUCCESS;
202	}
203
204	/**
205	* Implementation for "VBoxManage snapshot ... dump". This goes thru the machine's
206	* medium attachments and calls DumpMediumWithChildren() for each hard disk medium found,
207	* which then dumps the parent/child tree of that medium together with the corresponding
208	* snapshots.
209	* @param pMachine Machine to dump snapshots for.
210	*/
211	void DumpSnapshot(ComPtr<IMachine> &pMachine)
212	{
213	HRESULT rc;
214
215	do
216	{
217	// get root snapshot
218	ComPtr<ISnapshot> pSnapshot;
219	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr("").raw(), pSnapshot.asOutParam()));
220
221	// get current snapshot
222	ComPtr<ISnapshot> pCurrentSnapshot;
223	CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(pCurrentSnapshot.asOutParam()));
224
225	// get media attachments
226	SafeIfaceArray<IMediumAttachment> aAttachments;
227	CHECK_ERROR_BREAK(pMachine, COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(aAttachments)));
228	for (uint32_t i = 0;
229	i < aAttachments.size();
230	++i)
231	{
232	ComPtr<IMediumAttachment> pAttach(aAttachments[i]);
233	DeviceType_T type;
234	CHECK_ERROR_BREAK(pAttach, COMGETTER(Type)(&type));
235	if (type == DeviceType_HardDisk)
236	{
237	ComPtr<IMedium> pCurrentStateMedium;
238	CHECK_ERROR_BREAK(pAttach, COMGETTER(Medium)(pCurrentStateMedium.asOutParam()));
239
240	ComPtr<IMedium> pBaseMedium;
241	CHECK_ERROR_BREAK(pCurrentStateMedium, COMGETTER(Base)(pBaseMedium.asOutParam()));
242
243	Bstr bstrBaseMediumName;
244	CHECK_ERROR_BREAK(pBaseMedium, COMGETTER(Name)(bstrBaseMediumName.asOutParam()));
245
246	RTPrintf("[%RI32] Images and snapshots for medium \"%ls\"\n", i, bstrBaseMediumName.raw());
247
248	DumpMediumWithChildren(pCurrentStateMedium,
249	pBaseMedium,
250	pSnapshot,
251	pCurrentSnapshot,
252	0);
253	}
254	}
255	} while (0);
256	}
257
258	/**
259	* Implementation for all VBoxManage snapshot ... subcommands.
260	* @param a
261	* @return
262	*/
263	int handleSnapshot(HandlerArg *a)
264	{
265	HRESULT rc;
266
267	/* we need at least a VM and a command */
268	if (a->argc < 2)
269	return errorSyntax(USAGE_SNAPSHOT, "Not enough parameters");
270
271	/* the first argument must be the VM */
272	Bstr bstrMachine(a->argv[0]);
273	ComPtr<IMachine> ptrMachine;
274	CHECK_ERROR(a->virtualBox, FindMachine(bstrMachine.raw(),
275	ptrMachine.asOutParam()));
276	if (!ptrMachine)
277	return 1;
278
279	do
280	{
281	/* we have to open a session for this task (new or shared) */
282	rc = ptrMachine->LockMachine(a->session, LockType_Shared);
283	ComPtr<IConsole> console;
284	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
285
286	/* switch based on the command */
287	bool fDelete = false,
288	fRestore = false,
289	fRestoreCurrent = false;
290
291	if (!strcmp(a->argv[1], "take"))
292	{
293	/* there must be a name */
294	if (a->argc < 3)
295	{
296	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
297	rc = E_FAIL;
298	break;
299	}
300	Bstr name(a->argv[2]);
301
302	/* parse the optional arguments */
303	Bstr desc;
304	bool fPause = false;
305	static const RTGETOPTDEF s_aTakeOptions[] =
306	{
307	{ "--description", 'd', RTGETOPT_REQ_STRING },
308	{ "-description", 'd', RTGETOPT_REQ_STRING },
309	{ "-desc", 'd', RTGETOPT_REQ_STRING },
310	{ "--pause", 'p', RTGETOPT_REQ_NOTHING }
311	};
312	RTGETOPTSTATE GetOptState;
313	RTGetOptInit(&GetOptState, a->argc, a->argv, s_aTakeOptions, RT_ELEMENTS(s_aTakeOptions),
314	3, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
315	int ch;
316	RTGETOPTUNION Value;
317	while ( SUCCEEDED(rc)
318	&& (ch = RTGetOpt(&GetOptState, &Value)))
319	{
320	switch (ch)
321	{
322	case 'p':
323	fPause = true;
324	break;
325
326	case 'd':
327	desc = Value.psz;
328	break;
329
330	default:
331	errorGetOpt(USAGE_SNAPSHOT, ch, &Value);
332	rc = E_FAIL;
333	break;
334	}
335	}
336	if (FAILED(rc))
337	break;
338
339	if (fPause)
340	{
341	MachineState_T machineState;
342	CHECK_ERROR_BREAK(console, COMGETTER(State)(&machineState));
343	if (machineState == MachineState_Running)
344	CHECK_ERROR_BREAK(console, Pause());
345	else
346	fPause = false;
347	}
348
349	ComPtr<IProgress> progress;
350	CHECK_ERROR_BREAK(console, TakeSnapshot(name.raw(), desc.raw(),
351	progress.asOutParam()));
352
353	rc = showProgress(progress);
354	CHECK_PROGRESS_ERROR(progress, ("Failed to take snapshot"));
355
356	if (fPause)
357	{
358	MachineState_T machineState;
359	CHECK_ERROR_BREAK(console, COMGETTER(State)(&machineState));
360	if (machineState == MachineState_Paused)
361	{
362	if (SUCCEEDED(rc))
363	CHECK_ERROR_BREAK(console, Resume());
364	else
365	console->Resume();
366	}
367	}
368	}
369	else if ( (fDelete = !strcmp(a->argv[1], "delete"))
370	\|\| (fRestore = !strcmp(a->argv[1], "restore"))
371	\|\| (fRestoreCurrent = !strcmp(a->argv[1], "restorecurrent"))
372	)
373	{
374	if (fRestoreCurrent)
375	{
376	if (a->argc > 2)
377	{
378	errorSyntax(USAGE_SNAPSHOT, "Too many arguments");
379	rc = E_FAIL;
380	break;
381	}
382	}
383	/* exactly one parameter: snapshot name */
384	else if (a->argc != 3)
385	{
386	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
387	rc = E_FAIL;
388	break;
389	}
390
391	ComPtr<ISnapshot> pSnapshot;
392	ComPtr<IProgress> pProgress;
393	Bstr bstrSnapGuid;
394
395	if (fRestoreCurrent)
396	{
397	CHECK_ERROR_BREAK(ptrMachine, COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam()));
398	}
399	else
400	{
401	// restore or delete snapshot: then resolve cmd line argument to snapshot instance
402	CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
403	pSnapshot.asOutParam()));
404	}
405
406	CHECK_ERROR_BREAK(pSnapshot, COMGETTER(Id)(bstrSnapGuid.asOutParam()));
407
408	if (fDelete)
409	{
410	CHECK_ERROR_BREAK(console, DeleteSnapshot(bstrSnapGuid.raw(),
411	pProgress.asOutParam()));
412	}
413	else
414	{
415	// restore or restore current
416	RTPrintf("Restoring snapshot %ls\n", bstrSnapGuid.raw());
417	CHECK_ERROR_BREAK(console, RestoreSnapshot(pSnapshot, pProgress.asOutParam()));
418	}
419
420	rc = showProgress(pProgress);
421	CHECK_PROGRESS_ERROR(pProgress, ("Snapshot operation failed"));
422	}
423	else if (!strcmp(a->argv[1], "edit"))
424	{
425	if (a->argc < 3)
426	{
427	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
428	rc = E_FAIL;
429	break;
430	}
431
432	ComPtr<ISnapshot> snapshot;
433
434	if ( !strcmp(a->argv[2], "--current")
435	\|\| !strcmp(a->argv[2], "-current"))
436	{
437	CHECK_ERROR_BREAK(ptrMachine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam()));
438	}
439	else
440	{
441	CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
442	snapshot.asOutParam()));
443	}
444
445	/* parse options */
446	for (int i = 3; i < a->argc; i++)
447	{
448	if ( !strcmp(a->argv[i], "--name")
449	\|\| !strcmp(a->argv[i], "-name")
450	\|\| !strcmp(a->argv[i], "-newname"))
451	{
452	if (a->argc <= i + 1)
453	{
454	errorArgument("Missing argument to '%s'", a->argv[i]);
455	rc = E_FAIL;
456	break;
457	}
458	i++;
459	snapshot->COMSETTER(Name)(Bstr(a->argv[i]).raw());
460	}
461	else if ( !strcmp(a->argv[i], "--description")
462	\|\| !strcmp(a->argv[i], "-description")
463	\|\| !strcmp(a->argv[i], "-newdesc"))
464	{
465	if (a->argc <= i + 1)
466	{
467	errorArgument("Missing argument to '%s'", a->argv[i]);
468	rc = E_FAIL;
469	break;
470	}
471	i++;
472	snapshot->COMSETTER(Description)(Bstr(a->argv[i]).raw());
473	}
474	else
475	{
476	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[i]).c_str());
477	rc = E_FAIL;
478	break;
479	}
480	}
481
482	}
483	else if (!strcmp(a->argv[1], "showvminfo"))
484	{
485	/* exactly one parameter: snapshot name */
486	if (a->argc != 3)
487	{
488	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
489	rc = E_FAIL;
490	break;
491	}
492
493	ComPtr<ISnapshot> snapshot;
494
495	CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
496	snapshot.asOutParam()));
497
498	/* get the machine of the given snapshot */
499	ComPtr<IMachine> ptrMachine2;
500	snapshot->COMGETTER(Machine)(ptrMachine2.asOutParam());
501	showVMInfo(a->virtualBox, ptrMachine2, VMINFO_NONE, console);
502	}
503	else if (!strcmp(a->argv[1], "list"))
504	rc = handleSnapshotList(a, ptrMachine) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
505	else if (!strcmp(a->argv[1], "dump")) // undocumented parameter to debug snapshot info
506	DumpSnapshot(ptrMachine);
507	else
508	{
509	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str());
510	rc = E_FAIL;
511	}
512	} while (0);
513
514	a->session->UnlockMachine();
515
516	return SUCCEEDED(rc) ? 0 : 1;
517	}
518

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

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

Download in other formats: