VBoxManageSnapshot.cpp@ 32718

Last change on this file since 32718 was 32718, checked in by vboxsync, 14 years ago
com/string: Remove bool conversion operator and other convenience error operators. They are hiding programming errors (like incorrect empty string checks, and in one case a free of the wrong pointer).
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 32718 2010-09-23 12:57:52Z 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	* 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("").raw(), 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.raw(), pMachine.asOutParam());
231	if (FAILED(rc) \|\| !pMachine)
232	{
233	/* must be a name */
234	CHECK_ERROR(a->virtualBox, FindMachine(bstrMachine.raw(),
235	pMachine.asOutParam()));
236	}
237	if (!pMachine)
238	return 1;
239
240	do
241	{
242	/* we have to open a session for this task (new or shared) */
243	rc = pMachine->LockMachine(a->session, LockType_Shared);
244	ComPtr<IConsole> console;
245	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
246
247	/* switch based on the command */
248	bool fDelete = false,
249	fRestore = false,
250	fRestoreCurrent = false;
251
252	if (!strcmp(a->argv[1], "take"))
253	{
254	/* there must be a name */
255	if (a->argc < 3)
256	{
257	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
258	rc = E_FAIL;
259	break;
260	}
261	Bstr name(a->argv[2]);
262
263	/* parse the optional arguments */
264	Bstr desc;
265	bool fPause = false;
266	static const RTGETOPTDEF s_aTakeOptions[] =
267	{
268	{ "--description", 'd', RTGETOPT_REQ_STRING },
269	{ "-description", 'd', RTGETOPT_REQ_STRING },
270	{ "-desc", 'd', RTGETOPT_REQ_STRING },
271	{ "--pause", 'p', RTGETOPT_REQ_NOTHING }
272	};
273	RTGETOPTSTATE GetOptState;
274	RTGetOptInit(&GetOptState, a->argc, a->argv, s_aTakeOptions, RT_ELEMENTS(s_aTakeOptions),
275	3, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
276	int ch;
277	RTGETOPTUNION Value;
278	while ( SUCCEEDED(rc)
279	&& (ch = RTGetOpt(&GetOptState, &Value)))
280	{
281	switch (ch)
282	{
283	case 'p':
284	fPause = true;
285	break;
286
287	case 'd':
288	desc = Value.psz;
289	break;
290
291	default:
292	errorGetOpt(USAGE_SNAPSHOT, ch, &Value);
293	rc = E_FAIL;
294	break;
295	}
296	}
297	if (FAILED(rc))
298	break;
299
300	if (fPause)
301	{
302	MachineState_T machineState;
303	CHECK_ERROR_BREAK(console, COMGETTER(State)(&machineState));
304	if (machineState == MachineState_Running)
305	CHECK_ERROR_BREAK(console, Pause());
306	else
307	fPause = false;
308	}
309
310	ComPtr<IProgress> progress;
311	CHECK_ERROR_BREAK(console, TakeSnapshot(name.raw(), desc.raw(),
312	progress.asOutParam()));
313
314	rc = showProgress(progress);
315	if (FAILED(rc))
316	{
317	com::ProgressErrorInfo info(progress);
318	if (info.isBasicAvailable())
319	RTMsgError("Failed to take snapshot. Error message: %lS", info.getText().raw());
320	else
321	RTMsgError("Failed to take snapshot. No error message available!");
322	}
323
324	if (fPause)
325	{
326	MachineState_T machineState;
327	CHECK_ERROR_BREAK(console, COMGETTER(State)(&machineState));
328	if (machineState == MachineState_Paused)
329	{
330	if (SUCCEEDED(rc))
331	CHECK_ERROR_BREAK(console, Resume());
332	else
333	console->Resume();
334	}
335	}
336	}
337	else if ( (fDelete = !strcmp(a->argv[1], "delete"))
338	\|\| (fRestore = !strcmp(a->argv[1], "restore"))
339	\|\| (fRestoreCurrent = !strcmp(a->argv[1], "restorecurrent"))
340	)
341	{
342	if (fRestoreCurrent)
343	{
344	if (a->argc > 2)
345	{
346	errorSyntax(USAGE_SNAPSHOT, "Too many arguments");
347	rc = E_FAIL;
348	break;
349	}
350	}
351	/* exactly one parameter: snapshot name */
352	else if (a->argc != 3)
353	{
354	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
355	rc = E_FAIL;
356	break;
357	}
358
359	ComPtr<ISnapshot> pSnapshot;
360	ComPtr<IProgress> pProgress;
361	Bstr bstrSnapGuid;
362
363	if (fRestoreCurrent)
364	{
365	CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam()));
366	CHECK_ERROR_BREAK(pSnapshot, COMGETTER(Id)(bstrSnapGuid.asOutParam()));
367	}
368	else
369	{
370	// restore or delete snapshot: then resolve cmd line argument to snapshot instance
371	// assume it's a UUID
372	bstrSnapGuid = a->argv[2];
373	if (FAILED(pMachine->GetSnapshot(bstrSnapGuid.raw(),
374	pSnapshot.asOutParam())))
375	{
376	// then it must be a name
377	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
378	pSnapshot.asOutParam()));
379	CHECK_ERROR_BREAK(pSnapshot, COMGETTER(Id)(bstrSnapGuid.asOutParam()));
380	}
381	}
382
383	if (fDelete)
384	{
385	CHECK_ERROR_BREAK(console, DeleteSnapshot(bstrSnapGuid.raw(),
386	pProgress.asOutParam()));
387	}
388	else
389	{
390	// restore or restore current
391	RTPrintf("Restoring snapshot %ls\n", bstrSnapGuid.raw());
392	CHECK_ERROR_BREAK(console, RestoreSnapshot(pSnapshot, pProgress.asOutParam()));
393	}
394
395	rc = showProgress(pProgress);
396	if (FAILED(rc))
397	{
398	com::ProgressErrorInfo info(pProgress);
399	if (info.isBasicAvailable())
400	RTMsgError("Snapshot operation failed. Error message: %lS", info.getText().raw());
401	else
402	RTMsgError("Snapshot operation failed. No error message available!");
403	}
404	}
405	else if (!strcmp(a->argv[1], "edit"))
406	{
407	if (a->argc < 3)
408	{
409	errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
410	rc = E_FAIL;
411	break;
412	}
413
414	ComPtr<ISnapshot> snapshot;
415
416	if ( !strcmp(a->argv[2], "--current")
417	\|\| !strcmp(a->argv[2], "-current"))
418	{
419	CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam()));
420	}
421	else
422	{
423	/* assume it's a UUID */
424	rc = pMachine->GetSnapshot(Bstr(a->argv[2]).raw(),
425	snapshot.asOutParam());
426	if (FAILED(rc) \|\| !snapshot)
427	{
428	/* then it must be a name */
429	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
430	snapshot.asOutParam()));
431	}
432	}
433
434	/* parse options */
435	for (int i = 3; i < a->argc; i++)
436	{
437	if ( !strcmp(a->argv[i], "--name")
438	\|\| !strcmp(a->argv[i], "-name")
439	\|\| !strcmp(a->argv[i], "-newname"))
440	{
441	if (a->argc <= i + 1)
442	{
443	errorArgument("Missing argument to '%s'", a->argv[i]);
444	rc = E_FAIL;
445	break;
446	}
447	i++;
448	snapshot->COMSETTER(Name)(Bstr(a->argv[i]).raw());
449	}
450	else if ( !strcmp(a->argv[i], "--description")
451	\|\| !strcmp(a->argv[i], "-description")
452	\|\| !strcmp(a->argv[i], "-newdesc"))
453	{
454	if (a->argc <= i + 1)
455	{
456	errorArgument("Missing argument to '%s'", a->argv[i]);
457	rc = E_FAIL;
458	break;
459	}
460	i++;
461	snapshot->COMSETTER(Description)(Bstr(a->argv[i]).raw());
462	}
463	else
464	{
465	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[i]).c_str());
466	rc = E_FAIL;
467	break;
468	}
469	}
470
471	}
472	else if (!strcmp(a->argv[1], "showvminfo"))
473	{
474	/* exactly one parameter: snapshot name */
475	if (a->argc != 3)
476	{
477	errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
478	rc = E_FAIL;
479	break;
480	}
481
482	ComPtr<ISnapshot> snapshot;
483
484	/* assume it's a UUID */
485	rc = pMachine->GetSnapshot(Bstr(a->argv[2]).raw(),
486	snapshot.asOutParam());
487	if (FAILED(rc) \|\| !snapshot)
488	{
489	/* then it must be a name */
490	CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
491	snapshot.asOutParam()));
492	}
493
494	/* get the machine of the given snapshot */
495	ComPtr<IMachine> pMachine2;
496	snapshot->COMGETTER(Machine)(pMachine2.asOutParam());
497	showVMInfo(a->virtualBox, pMachine2, VMINFO_NONE, console);
498	}
499	else if (!strcmp(a->argv[1], "dump")) // undocumented parameter to debug snapshot info
500	DumpSnapshot(pMachine);
501	else
502	{
503	errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str());
504	rc = E_FAIL;
505	}
506	} while (0);
507
508	a->session->UnlockMachine();
509
510	return SUCCEEDED(rc) ? 0 : 1;
511	}
512

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

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

Download in other formats: