VBoxManageSnapshot.cpp@ 31020

Last change on this file since 31020 was 31019, checked in by vboxsync, 14 years ago
Main: rename LockForSession() API to LockMachine() and fix parameters; move code from internal open*Session() methods into LockMachine()
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 18.2 KB

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

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

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

Download in other formats: