VBoxManageDisk.cpp@ 32814

Last change on this file since 32814 was 32718, checked in by vboxsync, 15 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: 57.7 KB

Line
1	/* $Id: VBoxManageDisk.cpp 32718 2010-09-23 12:57:52Z vboxsync $ */
2	/** @file
3	* VBoxManage - The disk related commands.
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	#ifndef VBOX_ONLY_DOCS
19
20	/*******************************************************************************
21	* Header Files *
22	*******************************************************************************/
23	#include <VBox/com/com.h>
24	#include <VBox/com/array.h>
25	#include <VBox/com/ErrorInfo.h>
26	#include <VBox/com/errorprint.h>
27	#include <VBox/com/VirtualBox.h>
28
29	#include <iprt/asm.h>
30	#include <iprt/file.h>
31	#include <iprt/path.h>
32	#include <iprt/param.h>
33	#include <iprt/stream.h>
34	#include <iprt/string.h>
35	#include <iprt/ctype.h>
36	#include <iprt/getopt.h>
37	#include <VBox/log.h>
38	#include <VBox/VBoxHDD.h>
39
40	#include "VBoxManage.h"
41	using namespace com;
42
43
44	// funcs
45	///////////////////////////////////////////////////////////////////////////////
46
47
48	static DECLCALLBACK(void) handleVDError(void pvUser, int rc, RT_SRC_POS_DECL, const char pszFormat, va_list va)
49	{
50	RTMsgError(pszFormat, va);
51	RTMsgError("Error code %Rrc at %s(%u) in function %s", rc, RT_SRC_POS_ARGS);
52	}
53
54
55	static int parseDiskVariant(const char psz, MediumVariant_T pDiskVariant)
56	{
57	int rc = VINF_SUCCESS;
58	unsigned DiskVariant = (unsigned)(*pDiskVariant);
59	while (psz && *psz && RT_SUCCESS(rc))
60	{
61	size_t len;
62	const char *pszComma = strchr(psz, ',');
63	if (pszComma)
64	len = pszComma - psz;
65	else
66	len = strlen(psz);
67	if (len > 0)
68	{
69	// Parsing is intentionally inconsistent: "standard" resets the
70	// variant, whereas the other flags are cumulative.
71	if (!RTStrNICmp(psz, "standard", len))
72	DiskVariant = MediumVariant_Standard;
73	else if ( !RTStrNICmp(psz, "fixed", len)
74	\|\| !RTStrNICmp(psz, "static", len))
75	DiskVariant \|= MediumVariant_Fixed;
76	else if (!RTStrNICmp(psz, "Diff", len))
77	DiskVariant \|= MediumVariant_Diff;
78	else if (!RTStrNICmp(psz, "split2g", len))
79	DiskVariant \|= MediumVariant_VmdkSplit2G;
80	else if ( !RTStrNICmp(psz, "stream", len)
81	\|\| !RTStrNICmp(psz, "streamoptimized", len))
82	DiskVariant \|= MediumVariant_VmdkStreamOptimized;
83	else if (!RTStrNICmp(psz, "esx", len))
84	DiskVariant \|= MediumVariant_VmdkESX;
85	else
86	rc = VERR_PARSE_ERROR;
87	}
88	if (pszComma)
89	psz += len + 1;
90	else
91	psz += len;
92	}
93
94	if (RT_SUCCESS(rc))
95	*pDiskVariant = (MediumVariant_T)DiskVariant;
96	return rc;
97	}
98
99	static int parseDiskType(const char psz, MediumType_T pDiskType)
100	{
101	int rc = VINF_SUCCESS;
102	MediumType_T DiskType = MediumType_Normal;
103	if (!RTStrICmp(psz, "normal"))
104	DiskType = MediumType_Normal;
105	else if (!RTStrICmp(psz, "immutable"))
106	DiskType = MediumType_Immutable;
107	else if (!RTStrICmp(psz, "writethrough"))
108	DiskType = MediumType_Writethrough;
109	else if (!RTStrICmp(psz, "shareable"))
110	DiskType = MediumType_Shareable;
111	else
112	rc = VERR_PARSE_ERROR;
113
114	if (RT_SUCCESS(rc))
115	*pDiskType = DiskType;
116	return rc;
117	}
118
119	/** @todo move this into getopt, as getting bool values is generic */
120	static int parseBool(const char psz, bool pb)
121	{
122	int rc = VINF_SUCCESS;
123	if ( !RTStrICmp(psz, "on")
124	\|\| !RTStrICmp(psz, "yes")
125	\|\| !RTStrICmp(psz, "true")
126	\|\| !RTStrICmp(psz, "1")
127	\|\| !RTStrICmp(psz, "enable")
128	\|\| !RTStrICmp(psz, "enabled"))
129	{
130	*pb = true;
131	}
132	else if ( !RTStrICmp(psz, "off")
133	\|\| !RTStrICmp(psz, "no")
134	\|\| !RTStrICmp(psz, "false")
135	\|\| !RTStrICmp(psz, "0")
136	\|\| !RTStrICmp(psz, "disable")
137	\|\| !RTStrICmp(psz, "disabled"))
138	{
139	*pb = false;
140	}
141	else
142	rc = VERR_PARSE_ERROR;
143
144	return rc;
145	}
146
147	static const RTGETOPTDEF g_aCreateHardDiskOptions[] =
148	{
149	{ "--filename", 'f', RTGETOPT_REQ_STRING },
150	{ "-filename", 'f', RTGETOPT_REQ_STRING }, // deprecated
151	{ "--size", 's', RTGETOPT_REQ_UINT64 },
152	{ "-size", 's', RTGETOPT_REQ_UINT64 }, // deprecated
153	{ "--sizebyte", 'S', RTGETOPT_REQ_UINT64 },
154	{ "--format", 'o', RTGETOPT_REQ_STRING },
155	{ "-format", 'o', RTGETOPT_REQ_STRING }, // deprecated
156	{ "--static", 'F', RTGETOPT_REQ_NOTHING },
157	{ "-static", 'F', RTGETOPT_REQ_NOTHING }, // deprecated
158	{ "--variant", 'm', RTGETOPT_REQ_STRING },
159	{ "-variant", 'm', RTGETOPT_REQ_STRING }, // deprecated
160	{ "--type", 't', RTGETOPT_REQ_STRING },
161	{ "-type", 't', RTGETOPT_REQ_STRING }, // deprecated
162	{ "--comment", 'c', RTGETOPT_REQ_STRING },
163	{ "-comment", 'c', RTGETOPT_REQ_STRING }, // deprecated
164	{ "--remember", 'r', RTGETOPT_REQ_NOTHING },
165	{ "-remember", 'r', RTGETOPT_REQ_NOTHING }, // deprecated
166	{ "--register", 'r', RTGETOPT_REQ_NOTHING }, // deprecated (inofficial)
167	{ "-register", 'r', RTGETOPT_REQ_NOTHING }, // deprecated
168	};
169
170	int handleCreateHardDisk(HandlerArg *a)
171	{
172	HRESULT rc;
173	int vrc;
174	Bstr filename;
175	uint64_t size = 0;
176	Bstr format = "VDI";
177	MediumVariant_T DiskVariant = MediumVariant_Standard;
178	Bstr comment;
179	bool fRemember = false;
180	MediumType_T DiskType = MediumType_Normal;
181
182	int c;
183	RTGETOPTUNION ValueUnion;
184	RTGETOPTSTATE GetState;
185	// start at 0 because main() has hacked both the argc and argv given to us
186	RTGetOptInit(&GetState, a->argc, a->argv, g_aCreateHardDiskOptions, RT_ELEMENTS(g_aCreateHardDiskOptions),
187	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
188	while ((c = RTGetOpt(&GetState, &ValueUnion)))
189	{
190	switch (c)
191	{
192	case 'f': // --filename
193	filename = ValueUnion.psz;
194	break;
195
196	case 's': // --size
197	size = ValueUnion.u64 * _1M;
198	break;
199
200	case 'S': // --sizebyte
201	size = ValueUnion.u64;
202	break;
203
204	case 'o': // --format
205	format = ValueUnion.psz;
206	break;
207
208	case 'F': // --static ("fixed"/"flat")
209	{
210	unsigned uDiskVariant = (unsigned)DiskVariant;
211	uDiskVariant \|= MediumVariant_Fixed;
212	DiskVariant = (MediumVariant_T)uDiskVariant;
213	break;
214	}
215
216	case 'm': // --variant
217	vrc = parseDiskVariant(ValueUnion.psz, &DiskVariant);
218	if (RT_FAILURE(vrc))
219	return errorArgument("Invalid hard disk variant '%s'", ValueUnion.psz);
220	break;
221
222	case 'c': // --comment
223	comment = ValueUnion.psz;
224	break;
225
226	case 'r': // --remember
227	fRemember = true;
228	break;
229
230	case 't': // --type
231	vrc = parseDiskType(ValueUnion.psz, &DiskType);
232	if ( RT_FAILURE(vrc)
233	\|\| ( DiskType != MediumType_Normal
234	&& DiskType != MediumType_Writethrough
235	&& DiskType != MediumType_Shareable))
236	return errorArgument("Invalid hard disk type '%s'", ValueUnion.psz);
237	break;
238
239	case VINF_GETOPT_NOT_OPTION:
240	return errorSyntax(USAGE_CREATEHD, "Invalid parameter '%s'", ValueUnion.psz);
241
242	default:
243	if (c > 0)
244	{
245	if (RT_C_IS_PRINT(c))
246	return errorSyntax(USAGE_CREATEHD, "Invalid option -%c", c);
247	else
248	return errorSyntax(USAGE_CREATEHD, "Invalid option case %i", c);
249	}
250	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
251	return errorSyntax(USAGE_CREATEHD, "unknown option: %s\n", ValueUnion.psz);
252	else if (ValueUnion.pDef)
253	return errorSyntax(USAGE_CREATEHD, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
254	else
255	return errorSyntax(USAGE_CREATEHD, "error: %Rrs", c);
256	}
257	}
258
259	/* check the outcome */
260	if ( filename.isEmpty()
261	\|\| size == 0)
262	return errorSyntax(USAGE_CREATEHD, "Parameters --filename and --size are required");
263
264	/* check for filename extension */
265	Utf8Str strName(filename);
266	if (!RTPathHaveExt(strName.c_str()))
267	{
268	Utf8Str strFormat(format);
269	if (strFormat.compare("vmdk", iprt::MiniString::CaseInsensitive) == 0)
270	strName.append(".vmdk");
271	else if (strFormat.compare("vhd", iprt::MiniString::CaseInsensitive) == 0)
272	strName.append(".vhd");
273	else
274	strName.append(".vdi");
275	filename = Bstr(strName);
276	}
277
278	ComPtr<IMedium> hardDisk;
279	CHECK_ERROR(a->virtualBox, CreateHardDisk(format.raw(), filename.raw(),
280	hardDisk.asOutParam()));
281	if (SUCCEEDED(rc) && hardDisk)
282	{
283	/* we will close the hard disk after the storage has been successfully
284	* created unless fRemember is set */
285	bool doClose = false;
286
287	if (!comment.isEmpty())
288	{
289	CHECK_ERROR(hardDisk,COMSETTER(Description)(comment.raw()));
290	}
291
292	ComPtr<IProgress> progress;
293	CHECK_ERROR(hardDisk, CreateBaseStorage(size, DiskVariant, progress.asOutParam()));
294	if (SUCCEEDED(rc) && progress)
295	{
296	rc = showProgress(progress);
297	if (FAILED(rc))
298	{
299	com::ProgressErrorInfo info(progress);
300	if (info.isBasicAvailable())
301	RTMsgError("Failed to create hard disk. Error message: %lS", info.getText().raw());
302	else
303	RTMsgError("Failed to create hard disk. No error message available!");
304	}
305	else
306	{
307	doClose = !fRemember;
308
309	Bstr uuid;
310	CHECK_ERROR(hardDisk, COMGETTER(Id)(uuid.asOutParam()));
311
312	if ( DiskType == MediumType_Writethrough
313	\|\| DiskType == MediumType_Shareable)
314	{
315	CHECK_ERROR(hardDisk, COMSETTER(Type)(DiskType));
316	}
317
318	RTPrintf("Disk image created. UUID: %s\n", Utf8Str(uuid).c_str());
319	}
320	}
321	if (doClose)
322	{
323	CHECK_ERROR(hardDisk, Close());
324	}
325	}
326	return SUCCEEDED(rc) ? 0 : 1;
327	}
328
329	static const RTGETOPTDEF g_aModifyHardDiskOptions[] =
330	{
331	{ "--type", 't', RTGETOPT_REQ_STRING },
332	{ "-type", 't', RTGETOPT_REQ_STRING }, // deprecated
333	{ "settype", 't', RTGETOPT_REQ_STRING }, // deprecated
334	{ "--autoreset", 'z', RTGETOPT_REQ_STRING },
335	{ "-autoreset", 'z', RTGETOPT_REQ_STRING }, // deprecated
336	{ "autoreset", 'z', RTGETOPT_REQ_STRING }, // deprecated
337	{ "--compact", 'c', RTGETOPT_REQ_NOTHING },
338	{ "-compact", 'c', RTGETOPT_REQ_NOTHING }, // deprecated
339	{ "compact", 'c', RTGETOPT_REQ_NOTHING }, // deprecated
340	{ "--resize", 'r', RTGETOPT_REQ_UINT64 }
341	};
342
343	int handleModifyHardDisk(HandlerArg *a)
344	{
345	HRESULT rc;
346	int vrc;
347	ComPtr<IMedium> hardDisk;
348	MediumType_T DiskType;
349	bool AutoReset = false;
350	bool fModifyDiskType = false, fModifyAutoReset = false, fModifyCompact = false;
351	bool fModifyResize = false;
352	uint64_t resizeMB = 0;
353	const char *FilenameOrUuid = NULL;
354
355	int c;
356	RTGETOPTUNION ValueUnion;
357	RTGETOPTSTATE GetState;
358	// start at 0 because main() has hacked both the argc and argv given to us
359	RTGetOptInit(&GetState, a->argc, a->argv, g_aModifyHardDiskOptions, RT_ELEMENTS(g_aModifyHardDiskOptions),
360	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
361	while ((c = RTGetOpt(&GetState, &ValueUnion)))
362	{
363	switch (c)
364	{
365	case 't': // --type
366	vrc = parseDiskType(ValueUnion.psz, &DiskType);
367	if (RT_FAILURE(vrc))
368	return errorArgument("Invalid hard disk type '%s'", ValueUnion.psz);
369	fModifyDiskType = true;
370	break;
371
372	case 'z': // --autoreset
373	vrc = parseBool(ValueUnion.psz, &AutoReset);
374	if (RT_FAILURE(vrc))
375	return errorArgument("Invalid autoreset parameter '%s'", ValueUnion.psz);
376	fModifyAutoReset = true;
377	break;
378
379	case 'c': // --compact
380	fModifyCompact = true;
381	break;
382
383	case 'r': // --resize
384	resizeMB = ValueUnion.u64;
385	fModifyResize = true;
386	break;
387
388	case VINF_GETOPT_NOT_OPTION:
389	if (!FilenameOrUuid)
390	FilenameOrUuid = ValueUnion.psz;
391	else
392	return errorSyntax(USAGE_CREATEHD, "Invalid parameter '%s'", ValueUnion.psz);
393	break;
394
395	default:
396	if (c > 0)
397	{
398	if (RT_C_IS_PRINT(c))
399	return errorSyntax(USAGE_MODIFYHD, "Invalid option -%c", c);
400	else
401	return errorSyntax(USAGE_MODIFYHD, "Invalid option case %i", c);
402	}
403	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
404	return errorSyntax(USAGE_MODIFYHD, "unknown option: %s\n", ValueUnion.psz);
405	else if (ValueUnion.pDef)
406	return errorSyntax(USAGE_MODIFYHD, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
407	else
408	return errorSyntax(USAGE_MODIFYHD, "error: %Rrs", c);
409	}
410	}
411
412	if (!FilenameOrUuid)
413	return errorSyntax(USAGE_MODIFYHD, "Disk name or UUID required");
414
415	if (!fModifyDiskType && !fModifyAutoReset && !fModifyCompact && !fModifyResize)
416	return errorSyntax(USAGE_MODIFYHD, "No operation specified");
417
418	/* first guess is that it's a UUID */
419	CHECK_ERROR(a->virtualBox, FindMedium(Bstr(FilenameOrUuid).raw(),
420	DeviceType_HardDisk,
421	hardDisk.asOutParam()));
422	if (FAILED(rc))
423	return 1;
424
425	if (fModifyDiskType)
426	{
427	/* hard disk must be registered */
428	if (SUCCEEDED(rc) && hardDisk)
429	{
430	MediumType_T hddType;
431	CHECK_ERROR(hardDisk, COMGETTER(Type)(&hddType));
432
433	if (hddType != DiskType)
434	CHECK_ERROR(hardDisk, COMSETTER(Type)(DiskType));
435	}
436	else
437	return errorArgument("Hard disk image not registered");
438	}
439
440	if (fModifyAutoReset)
441	{
442	CHECK_ERROR(hardDisk, COMSETTER(AutoReset)(AutoReset));
443	}
444
445	if (fModifyCompact)
446	{
447	bool unknown = false;
448	/* the hard disk image might not be registered */
449	if (!hardDisk)
450	{
451	unknown = true;
452	rc = a->virtualBox->OpenMedium(Bstr(FilenameOrUuid).raw(),
453	DeviceType_HardDisk,
454	AccessMode_ReadWrite,
455	hardDisk.asOutParam());
456	if (rc == VBOX_E_FILE_ERROR)
457	{
458	char szFilenameAbs[RTPATH_MAX] = "";
459	int irc = RTPathAbs(FilenameOrUuid, szFilenameAbs, sizeof(szFilenameAbs));
460	if (RT_FAILURE(irc))
461	{
462	RTMsgError("Cannot convert filename \"%s\" to absolute path", FilenameOrUuid);
463	return 1;
464	}
465	CHECK_ERROR(a->virtualBox, OpenMedium(Bstr(szFilenameAbs).raw(),
466	DeviceType_HardDisk,
467	AccessMode_ReadWrite,
468	hardDisk.asOutParam()));
469	}
470	}
471	if (SUCCEEDED(rc) && hardDisk)
472	{
473	ComPtr<IProgress> progress;
474	CHECK_ERROR(hardDisk, Compact(progress.asOutParam()));
475	if (SUCCEEDED(rc))
476	rc = showProgress(progress);
477	if (FAILED(rc))
478	{
479	if (rc == E_NOTIMPL)
480	RTMsgError("Compact hard disk operation is not implemented!");
481	else if (rc == VBOX_E_NOT_SUPPORTED)
482	RTMsgError("Compact hard disk operation for this format is not implemented yet!");
483	else
484	com::GluePrintRCMessage(rc);
485	}
486	if (unknown)
487	hardDisk->Close();
488	}
489	}
490
491	if (fModifyResize)
492	{
493	bool unknown = false;
494	/* the hard disk image might not be registered */
495	if (!hardDisk)
496	{
497	unknown = true;
498	rc = a->virtualBox->OpenMedium(Bstr(FilenameOrUuid).raw(),
499	DeviceType_HardDisk,
500	AccessMode_ReadWrite,
501	hardDisk.asOutParam());
502	if (rc == VBOX_E_FILE_ERROR)
503	{
504	char szFilenameAbs[RTPATH_MAX] = "";
505	int irc = RTPathAbs(FilenameOrUuid, szFilenameAbs, sizeof(szFilenameAbs));
506	if (RT_FAILURE(irc))
507	{
508	RTMsgError("Cannot convert filename \"%s\" to absolute path", FilenameOrUuid);
509	return 1;
510	}
511	CHECK_ERROR(a->virtualBox, OpenMedium(Bstr(szFilenameAbs).raw(),
512	DeviceType_HardDisk,
513	AccessMode_ReadWrite,
514	hardDisk.asOutParam()));
515	}
516	}
517	if (SUCCEEDED(rc) && hardDisk)
518	{
519	ComPtr<IProgress> progress;
520	CHECK_ERROR(hardDisk, Resize(resizeMB, progress.asOutParam()));
521	if (SUCCEEDED(rc))
522	rc = showProgress(progress);
523	if (FAILED(rc))
524	{
525	if (rc == E_NOTIMPL)
526	RTMsgError("Resize hard disk operation is not implemented!");
527	else if (rc == VBOX_E_NOT_SUPPORTED)
528	RTMsgError("Resize hard disk operation for this format is not implemented yet!");
529	else
530	com::GluePrintRCMessage(rc);
531	}
532	if (unknown)
533	hardDisk->Close();
534	}
535	}
536
537	return SUCCEEDED(rc) ? 0 : 1;
538	}
539
540	static const RTGETOPTDEF g_aCloneHardDiskOptions[] =
541	{
542	{ "--format", 'o', RTGETOPT_REQ_STRING },
543	{ "-format", 'o', RTGETOPT_REQ_STRING },
544	{ "--static", 'F', RTGETOPT_REQ_NOTHING },
545	{ "-static", 'F', RTGETOPT_REQ_NOTHING },
546	{ "--existing", 'E', RTGETOPT_REQ_NOTHING },
547	{ "--variant", 'm', RTGETOPT_REQ_STRING },
548	{ "-variant", 'm', RTGETOPT_REQ_STRING },
549	{ "--type", 't', RTGETOPT_REQ_STRING },
550	{ "-type", 't', RTGETOPT_REQ_STRING },
551	{ "--remember", 'r', RTGETOPT_REQ_NOTHING },
552	{ "-remember", 'r', RTGETOPT_REQ_NOTHING },
553	{ "--register", 'r', RTGETOPT_REQ_NOTHING },
554	{ "-register", 'r', RTGETOPT_REQ_NOTHING },
555	};
556
557	int handleCloneHardDisk(HandlerArg *a)
558	{
559	HRESULT rc;
560	int vrc;
561	Bstr src, dst;
562	Bstr format;
563	MediumVariant_T DiskVariant = MediumVariant_Standard;
564	bool fExisting = false;
565	bool fRemember = false;
566	bool fSetDiskType = false;
567	MediumType_T DiskType = MediumType_Normal;
568
569	int c;
570	RTGETOPTUNION ValueUnion;
571	RTGETOPTSTATE GetState;
572	// start at 0 because main() has hacked both the argc and argv given to us
573	RTGetOptInit(&GetState, a->argc, a->argv, g_aCloneHardDiskOptions, RT_ELEMENTS(g_aCloneHardDiskOptions),
574	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
575	while ((c = RTGetOpt(&GetState, &ValueUnion)))
576	{
577	switch (c)
578	{
579	case 'o': // --format
580	format = ValueUnion.psz;
581	break;
582
583	case 'F': // --static
584	{
585	unsigned uDiskVariant = (unsigned)DiskVariant;
586	uDiskVariant \|= MediumVariant_Fixed;
587	DiskVariant = (MediumVariant_T)uDiskVariant;
588	break;
589	}
590
591	case 'E': // --existing
592	fExisting = true;
593	break;
594
595	case 'm': // --variant
596	vrc = parseDiskVariant(ValueUnion.psz, &DiskVariant);
597	if (RT_FAILURE(vrc))
598	return errorArgument("Invalid hard disk variant '%s'", ValueUnion.psz);
599	break;
600
601	case 'r': // --remember
602	fRemember = true;
603	break;
604
605	case 't': // --type
606	vrc = parseDiskType(ValueUnion.psz, &DiskType);
607	if (RT_FAILURE(vrc))
608	return errorArgument("Invalid hard disk type '%s'", ValueUnion.psz);
609	fSetDiskType = true;
610	break;
611
612	case VINF_GETOPT_NOT_OPTION:
613	if (src.isEmpty())
614	src = ValueUnion.psz;
615	else if (dst.isEmpty())
616	dst = ValueUnion.psz;
617	else
618	return errorSyntax(USAGE_CLONEHD, "Invalid parameter '%s'", ValueUnion.psz);
619	break;
620
621	default:
622	if (c > 0)
623	{
624	if (RT_C_IS_GRAPH(c))
625	return errorSyntax(USAGE_CLONEHD, "unhandled option: -%c", c);
626	else
627	return errorSyntax(USAGE_CLONEHD, "unhandled option: %i", c);
628	}
629	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
630	return errorSyntax(USAGE_CLONEHD, "unknown option: %s", ValueUnion.psz);
631	else if (ValueUnion.pDef)
632	return errorSyntax(USAGE_CLONEHD, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
633	else
634	return errorSyntax(USAGE_CLONEHD, "error: %Rrs", c);
635	}
636	}
637
638	if (src.isEmpty())
639	return errorSyntax(USAGE_CLONEHD, "Mandatory UUID or input file parameter missing");
640	if (dst.isEmpty())
641	return errorSyntax(USAGE_CLONEHD, "Mandatory output file parameter missing");
642	if (fExisting && (!format.isEmpty() \|\| DiskVariant != MediumType_Normal))
643	return errorSyntax(USAGE_CLONEHD, "Specified options which cannot be used with --existing");
644
645	ComPtr<IMedium> srcDisk;
646	ComPtr<IMedium> dstDisk;
647	bool fSrcUnknown = false;
648	bool fDstUnknown = false;
649
650	rc = a->virtualBox->FindMedium(src.raw(), DeviceType_HardDisk,
651	srcDisk.asOutParam());
652	/* no? well, then it's an unknown image */
653	if (FAILED (rc))
654	{
655	rc = a->virtualBox->OpenMedium(src.raw(), DeviceType_HardDisk,
656	AccessMode_ReadWrite,
657	srcDisk.asOutParam());
658	if (rc == VBOX_E_FILE_ERROR)
659	{
660	char szFilenameAbs[RTPATH_MAX] = "";
661	int irc = RTPathAbs(Utf8Str(src).c_str(), szFilenameAbs, sizeof(szFilenameAbs));
662	if (RT_FAILURE(irc))
663	{
664	RTMsgError("Cannot convert filename \"%s\" to absolute path", Utf8Str(src).c_str());
665	return 1;
666	}
667	CHECK_ERROR(a->virtualBox, OpenMedium(Bstr(szFilenameAbs).raw(),
668	DeviceType_HardDisk,
669	AccessMode_ReadWrite,
670	srcDisk.asOutParam()));
671	}
672	if (SUCCEEDED(rc))
673	fSrcUnknown = true;
674	}
675
676	do
677	{
678	if (!SUCCEEDED(rc))
679	break;
680
681	/* open/create destination hard disk */
682	if (fExisting)
683	{
684	rc = a->virtualBox->FindMedium(dst.raw(), DeviceType_HardDisk,
685	dstDisk.asOutParam());
686	/* no? well, then it's an unknown image */
687	if (FAILED(rc))
688	{
689	rc = a->virtualBox->OpenMedium(dst.raw(), DeviceType_HardDisk,
690	AccessMode_ReadWrite,
691	dstDisk.asOutParam());
692	if (rc == VBOX_E_FILE_ERROR)
693	{
694	char szFilenameAbs[RTPATH_MAX] = "";
695	int irc = RTPathAbs(Utf8Str(dst).c_str(), szFilenameAbs, sizeof(szFilenameAbs));
696	if (RT_FAILURE(irc))
697	{
698	RTMsgError("Cannot convert filename \"%s\" to absolute path", Utf8Str(dst).c_str());
699	return 1;
700	}
701	CHECK_ERROR_BREAK(a->virtualBox, OpenMedium(Bstr(szFilenameAbs).raw(),
702	DeviceType_HardDisk,
703	AccessMode_ReadWrite,
704	dstDisk.asOutParam()));
705	}
706	if (SUCCEEDED(rc))
707	fDstUnknown = true;
708	}
709	else
710	fRemember = true;
711	if (SUCCEEDED(rc))
712	{
713	/* Perform accessibility check now. */
714	MediumState_T state;
715	CHECK_ERROR_BREAK(dstDisk, RefreshState(&state));
716	}
717	CHECK_ERROR_BREAK(dstDisk, COMGETTER(Format)(format.asOutParam()));
718	}
719	else
720	{
721	/* use the format of the source hard disk if unspecified */
722	if (format.isEmpty())
723	CHECK_ERROR_BREAK(srcDisk, COMGETTER(Format)(format.asOutParam()));
724	CHECK_ERROR_BREAK(a->virtualBox, CreateHardDisk(format.raw(),
725	dst.raw(),
726	dstDisk.asOutParam()));
727	}
728
729	ComPtr<IProgress> progress;
730	CHECK_ERROR_BREAK(srcDisk, CloneTo(dstDisk, DiskVariant, NULL, progress.asOutParam()));
731
732	rc = showProgress(progress);
733	if (FAILED(rc))
734	{
735	com::ProgressErrorInfo info(progress);
736	if (info.isBasicAvailable())
737	RTMsgError("Failed to clone hard disk. Error message: %lS", info.getText().raw());
738	else
739	RTMsgError("Failed to clone hard disk. No error message available!");
740	break;
741	}
742
743	Bstr uuid;
744	CHECK_ERROR_BREAK(dstDisk, COMGETTER(Id)(uuid.asOutParam()));
745
746	RTPrintf("Clone hard disk created in format '%ls'. UUID: %s\n",
747	format.raw(), Utf8Str(uuid).c_str());
748	}
749	while (0);
750
751	if (!fRemember && !dstDisk.isNull())
752	{
753	/* forget the created clone */
754	dstDisk->Close();
755	}
756	else if (fSetDiskType)
757	{
758	CHECK_ERROR(dstDisk, COMSETTER(Type)(DiskType));
759	}
760
761	if (fSrcUnknown)
762	{
763	/* close the unknown hard disk to forget it again */
764	srcDisk->Close();
765	}
766
767	return SUCCEEDED(rc) ? 0 : 1;
768	}
769
770	static const RTGETOPTDEF g_aConvertFromRawHardDiskOptions[] =
771	{
772	{ "--format", 'o', RTGETOPT_REQ_STRING },
773	{ "-format", 'o', RTGETOPT_REQ_STRING },
774	{ "--static", 'F', RTGETOPT_REQ_NOTHING },
775	{ "-static", 'F', RTGETOPT_REQ_NOTHING },
776	{ "--variant", 'm', RTGETOPT_REQ_STRING },
777	{ "-variant", 'm', RTGETOPT_REQ_STRING },
778	};
779
780	int handleConvertFromRaw(int argc, char *argv[])
781	{
782	int rc = VINF_SUCCESS;
783	bool fReadFromStdIn = false;
784	const char *format = "VDI";
785	const char *srcfilename = NULL;
786	const char *dstfilename = NULL;
787	const char *filesize = NULL;
788	unsigned uImageFlags = VD_IMAGE_FLAGS_NONE;
789	void *pvBuf = NULL;
790
791	int c;
792	RTGETOPTUNION ValueUnion;
793	RTGETOPTSTATE GetState;
794	// start at 0 because main() has hacked both the argc and argv given to us
795	RTGetOptInit(&GetState, argc, argv, g_aConvertFromRawHardDiskOptions, RT_ELEMENTS(g_aConvertFromRawHardDiskOptions),
796	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
797	while ((c = RTGetOpt(&GetState, &ValueUnion)))
798	{
799	switch (c)
800	{
801	case 'o': // --format
802	format = ValueUnion.psz;
803	break;
804
805	case 'm': // --variant
806	MediumVariant_T DiskVariant;
807	rc = parseDiskVariant(ValueUnion.psz, &DiskVariant);
808	if (RT_FAILURE(rc))
809	return errorArgument("Invalid hard disk variant '%s'", ValueUnion.psz);
810	/// @todo cleaner solution than assuming 1:1 mapping?
811	uImageFlags = (unsigned)DiskVariant;
812	break;
813
814	case VINF_GETOPT_NOT_OPTION:
815	if (!srcfilename)
816	{
817	srcfilename = ValueUnion.psz;
818	// If you change the OS list here don't forget to update VBoxManageHelp.cpp.
819	#ifndef RT_OS_WINDOWS
820	fReadFromStdIn = !strcmp(srcfilename, "stdin");
821	#endif
822	}
823	else if (!dstfilename)
824	dstfilename = ValueUnion.psz;
825	else if (fReadFromStdIn && !filesize)
826	filesize = ValueUnion.psz;
827	else
828	return errorSyntax(USAGE_CONVERTFROMRAW, "Invalid parameter '%s'", ValueUnion.psz);
829	break;
830
831	default:
832	return errorGetOpt(USAGE_CONVERTFROMRAW, c, &ValueUnion);
833	}
834	}
835
836	if (!srcfilename \|\| !dstfilename \|\| (fReadFromStdIn && !filesize))
837	return errorSyntax(USAGE_CONVERTFROMRAW, "Incorrect number of parameters");
838	RTStrmPrintf(g_pStdErr, "Converting from raw image file=\"%s\" to file=\"%s\"...\n",
839	srcfilename, dstfilename);
840
841	PVBOXHDD pDisk = NULL;
842
843	PVDINTERFACE pVDIfs = NULL;
844	VDINTERFACE vdInterfaceError;
845	VDINTERFACEERROR vdInterfaceErrorCallbacks;
846	vdInterfaceErrorCallbacks.cbSize = sizeof(VDINTERFACEERROR);
847	vdInterfaceErrorCallbacks.enmInterface = VDINTERFACETYPE_ERROR;
848	vdInterfaceErrorCallbacks.pfnError = handleVDError;
849	vdInterfaceErrorCallbacks.pfnMessage = NULL;
850
851	rc = VDInterfaceAdd(&vdInterfaceError, "VBoxManage_IError", VDINTERFACETYPE_ERROR,
852	&vdInterfaceErrorCallbacks, NULL, &pVDIfs);
853	AssertRC(rc);
854
855	/* open raw image file. */
856	RTFILE File;
857	if (fReadFromStdIn)
858	File = 0;
859	else
860	rc = RTFileOpen(&File, srcfilename, RTFILE_O_READ \| RTFILE_O_OPEN \| RTFILE_O_DENY_WRITE);
861	if (RT_FAILURE(rc))
862	{
863	RTMsgError("Cannot open file \"%s\": %Rrc", srcfilename, rc);
864	goto out;
865	}
866
867	uint64_t cbFile;
868	/* get image size. */
869	if (fReadFromStdIn)
870	cbFile = RTStrToUInt64(filesize);
871	else
872	rc = RTFileGetSize(File, &cbFile);
873	if (RT_FAILURE(rc))
874	{
875	RTMsgError("Cannot get image size for file \"%s\": %Rrc", srcfilename, rc);
876	goto out;
877	}
878
879	RTStrmPrintf(g_pStdErr, "Creating %s image with size %RU64 bytes (%RU64MB)...\n",
880	(uImageFlags & VD_IMAGE_FLAGS_FIXED) ? "fixed" : "dynamic", cbFile, (cbFile + _1M - 1) / _1M);
881	char pszComment[256];
882	RTStrPrintf(pszComment, sizeof(pszComment), "Converted image from %s", srcfilename);
883	rc = VDCreate(pVDIfs, &pDisk);
884	if (RT_FAILURE(rc))
885	{
886	RTMsgError("Cannot create the virtual disk container: %Rrc", rc);
887	goto out;
888	}
889
890	Assert(RT_MIN(cbFile / 512 / 16 / 63, 16383) -
891	(unsigned int)RT_MIN(cbFile / 512 / 16 / 63, 16383) == 0);
892	VDGEOMETRY PCHS, LCHS;
893	PCHS.cCylinders = (unsigned int)RT_MIN(cbFile / 512 / 16 / 63, 16383);
894	PCHS.cHeads = 16;
895	PCHS.cSectors = 63;
896	LCHS.cCylinders = 0;
897	LCHS.cHeads = 0;
898	LCHS.cSectors = 0;
899	rc = VDCreateBase(pDisk, format, dstfilename, cbFile,
900	uImageFlags, pszComment, &PCHS, &LCHS, NULL,
901	VD_OPEN_FLAGS_NORMAL, NULL, NULL);
902	if (RT_FAILURE(rc))
903	{
904	RTMsgError("Cannot create the disk image \"%s\": %Rrc", dstfilename, rc);
905	goto out;
906	}
907
908	size_t cbBuffer;
909	cbBuffer = _1M;
910	pvBuf = RTMemAlloc(cbBuffer);
911	if (!pvBuf)
912	{
913	rc = VERR_NO_MEMORY;
914	RTMsgError("Out of memory allocating buffers for image \"%s\": %Rrc", dstfilename, rc);
915	goto out;
916	}
917
918	uint64_t offFile;
919	offFile = 0;
920	while (offFile < cbFile)
921	{
922	size_t cbRead;
923	size_t cbToRead;
924	cbRead = 0;
925	cbToRead = cbFile - offFile >= (uint64_t)cbBuffer ?
926	cbBuffer : (size_t)(cbFile - offFile);
927	rc = RTFileRead(File, pvBuf, cbToRead, &cbRead);
928	if (RT_FAILURE(rc) \|\| !cbRead)
929	break;
930	rc = VDWrite(pDisk, offFile, pvBuf, cbRead);
931	if (RT_FAILURE(rc))
932	{
933	RTMsgError("Failed to write to disk image \"%s\": %Rrc", dstfilename, rc);
934	goto out;
935	}
936	offFile += cbRead;
937	}
938
939	out:
940	if (pvBuf)
941	RTMemFree(pvBuf);
942	if (pDisk)
943	VDClose(pDisk, RT_FAILURE(rc));
944	if (File != NIL_RTFILE)
945	RTFileClose(File);
946
947	return RT_FAILURE(rc);
948	}
949
950	static const RTGETOPTDEF g_aAddiSCSIDiskOptions[] =
951	{
952	{ "--server", 's', RTGETOPT_REQ_STRING },
953	{ "-server", 's', RTGETOPT_REQ_STRING }, // deprecated
954	{ "--target", 'T', RTGETOPT_REQ_STRING },
955	{ "-target", 'T', RTGETOPT_REQ_STRING }, // deprecated
956	{ "--port", 'p', RTGETOPT_REQ_STRING },
957	{ "-port", 'p', RTGETOPT_REQ_STRING }, // deprecated
958	{ "--lun", 'l', RTGETOPT_REQ_STRING },
959	{ "-lun", 'l', RTGETOPT_REQ_STRING }, // deprecated
960	{ "--encodedlun", 'L', RTGETOPT_REQ_STRING },
961	{ "-encodedlun", 'L', RTGETOPT_REQ_STRING }, // deprecated
962	{ "--username", 'u', RTGETOPT_REQ_STRING },
963	{ "-username", 'u', RTGETOPT_REQ_STRING }, // deprecated
964	{ "--password", 'P', RTGETOPT_REQ_STRING },
965	{ "-password", 'P', RTGETOPT_REQ_STRING }, // deprecated
966	{ "--type", 't', RTGETOPT_REQ_STRING },
967	{ "-type", 't', RTGETOPT_REQ_STRING }, // deprecated
968	{ "--intnet", 'I', RTGETOPT_REQ_NOTHING },
969	{ "-intnet", 'I', RTGETOPT_REQ_NOTHING }, // deprecated
970	};
971
972	int handleAddiSCSIDisk(HandlerArg *a)
973	{
974	HRESULT rc;
975	int vrc;
976	Bstr server;
977	Bstr target;
978	Bstr port;
979	Bstr lun;
980	Bstr username;
981	Bstr password;
982	Bstr comment;
983	bool fIntNet = false;
984	MediumType_T DiskType = MediumType_Normal;
985
986	int c;
987	RTGETOPTUNION ValueUnion;
988	RTGETOPTSTATE GetState;
989	// start at 0 because main() has hacked both the argc and argv given to us
990	RTGetOptInit(&GetState, a->argc, a->argv, g_aAddiSCSIDiskOptions, RT_ELEMENTS(g_aAddiSCSIDiskOptions),
991	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
992	while ((c = RTGetOpt(&GetState, &ValueUnion)))
993	{
994	switch (c)
995	{
996	case 's': // --server
997	server = ValueUnion.psz;
998	break;
999
1000	case 'T': // --target
1001	target = ValueUnion.psz;
1002	break;
1003
1004	case 'p': // --port
1005	port = ValueUnion.psz;
1006	break;
1007
1008	case 'l': // --lun
1009	lun = ValueUnion.psz;
1010	break;
1011
1012	case 'L': // --encodedlun
1013	lun = BstrFmt("enc%s", ValueUnion.psz);
1014	break;
1015
1016	case 'u': // --username
1017	username = ValueUnion.psz;
1018	break;
1019
1020	case 'P': // --password
1021	password = ValueUnion.psz;
1022	break;
1023
1024	case 't': // --type
1025	vrc = parseDiskType(ValueUnion.psz, &DiskType);
1026	if (RT_FAILURE(vrc))
1027	return errorArgument("Invalid hard disk type '%s'", ValueUnion.psz);
1028	break;
1029
1030	case 'I': // --intnet
1031	fIntNet = true;
1032	break;
1033
1034	case VINF_GETOPT_NOT_OPTION:
1035	return errorSyntax(USAGE_ADDISCSIDISK, "Invalid parameter '%s'", ValueUnion.psz);
1036
1037	default:
1038	if (c > 0)
1039	{
1040	if (RT_C_IS_PRINT(c))
1041	return errorSyntax(USAGE_ADDISCSIDISK, "Invalid option -%c", c);
1042	else
1043	return errorSyntax(USAGE_ADDISCSIDISK, "Invalid option case %i", c);
1044	}
1045	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
1046	return errorSyntax(USAGE_ADDISCSIDISK, "unknown option: %s\n", ValueUnion.psz);
1047	else if (ValueUnion.pDef)
1048	return errorSyntax(USAGE_ADDISCSIDISK, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
1049	else
1050	return errorSyntax(USAGE_ADDISCSIDISK, "error: %Rrs", c);
1051	}
1052	}
1053
1054	/* check for required options */
1055	if (server.isEmpty() \|\| target.isEmpty())
1056	return errorSyntax(USAGE_ADDISCSIDISK, "Parameters --server and --target are required");
1057
1058	do
1059	{
1060	ComPtr<IMedium> hardDisk;
1061	/** @todo move the location stuff to Main, which can use pfnComposeName
1062	* from the disk backends to construct the location properly. Also do
1063	* not use slashes to separate the parts, as otherwise only the last
1064	* element comtaining information will be shown. */
1065	if (lun.isEmpty() \|\| lun == "0" \|\| lun == "enc0")
1066	{
1067	CHECK_ERROR_BREAK(a->virtualBox, CreateHardDisk(Bstr("iSCSI").raw(),
1068	BstrFmt("%ls\|%ls",
1069	server.raw(),
1070	target.raw()).raw(),
1071	hardDisk.asOutParam()));
1072	}
1073	else
1074	{
1075	CHECK_ERROR_BREAK(a->virtualBox, CreateHardDisk(Bstr("iSCSI").raw(),
1076	BstrFmt("%ls\|%ls\|%ls",
1077	server.raw(),
1078	target.raw(),
1079	lun.raw()).raw(),
1080	hardDisk.asOutParam()));
1081	}
1082	if (FAILED(rc)) break;
1083
1084	if (!port.isEmpty())
1085	server = BstrFmt("%ls:%ls", server.raw(), port.raw());
1086
1087	com::SafeArray <BSTR> names;
1088	com::SafeArray <BSTR> values;
1089
1090	Bstr("TargetAddress").detachTo(names.appendedRaw());
1091	server.detachTo(values.appendedRaw());
1092	Bstr("TargetName").detachTo(names.appendedRaw());
1093	target.detachTo(values.appendedRaw());
1094
1095	if (!lun.isEmpty())
1096	{
1097	Bstr("LUN").detachTo(names.appendedRaw());
1098	lun.detachTo(values.appendedRaw());
1099	}
1100	if (!username.isEmpty())
1101	{
1102	Bstr("InitiatorUsername").detachTo(names.appendedRaw());
1103	username.detachTo(values.appendedRaw());
1104	}
1105	if (!password.isEmpty())
1106	{
1107	Bstr("InitiatorSecret").detachTo(names.appendedRaw());
1108	password.detachTo(values.appendedRaw());
1109	}
1110
1111	/// @todo add --initiator option - until that happens rely on the
1112	// defaults of the iSCSI initiator code. Setting it to a constant
1113	// value does more harm than good, as the initiator name is supposed
1114	// to identify a particular initiator uniquely.
1115	// Bstr("InitiatorName").detachTo(names.appendedRaw());
1116	// Bstr("iqn.2008-04.com.sun.virtualbox.initiator").detachTo(values.appendedRaw());
1117
1118	/// @todo add --targetName and --targetPassword options
1119
1120	if (fIntNet)
1121	{
1122	Bstr("HostIPStack").detachTo(names.appendedRaw());
1123	Bstr("0").detachTo(values.appendedRaw());
1124	}
1125
1126	CHECK_ERROR_BREAK(hardDisk, SetProperties(ComSafeArrayAsInParam(names),
1127	ComSafeArrayAsInParam(values)));
1128
1129	if (DiskType != MediumType_Normal)
1130	{
1131	CHECK_ERROR(hardDisk, COMSETTER(Type)(DiskType));
1132	}
1133
1134	Bstr guid;
1135	CHECK_ERROR(hardDisk, COMGETTER(Id)(guid.asOutParam()));
1136	RTPrintf("iSCSI disk created. UUID: %s\n", Utf8Str(guid).c_str());
1137	}
1138	while (0);
1139
1140	return SUCCEEDED(rc) ? 0 : 1;
1141	}
1142
1143	static const RTGETOPTDEF g_aShowHardDiskInfoOptions[] =
1144	{
1145	{ "--dummy", 256, RTGETOPT_REQ_NOTHING }, // placeholder for C++
1146	};
1147
1148	int handleShowHardDiskInfo(HandlerArg *a)
1149	{
1150	HRESULT rc;
1151	const char *FilenameOrUuid = NULL;
1152
1153	int c;
1154	RTGETOPTUNION ValueUnion;
1155	RTGETOPTSTATE GetState;
1156	// start at 0 because main() has hacked both the argc and argv given to us
1157	RTGetOptInit(&GetState, a->argc, a->argv, g_aShowHardDiskInfoOptions, RT_ELEMENTS(g_aShowHardDiskInfoOptions),
1158	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
1159	while ((c = RTGetOpt(&GetState, &ValueUnion)))
1160	{
1161	switch (c)
1162	{
1163	case VINF_GETOPT_NOT_OPTION:
1164	if (!FilenameOrUuid)
1165	FilenameOrUuid = ValueUnion.psz;
1166	else
1167	return errorSyntax(USAGE_SHOWHDINFO, "Invalid parameter '%s'", ValueUnion.psz);
1168	break;
1169
1170	default:
1171	if (c > 0)
1172	{
1173	if (RT_C_IS_PRINT(c))
1174	return errorSyntax(USAGE_SHOWHDINFO, "Invalid option -%c", c);
1175	else
1176	return errorSyntax(USAGE_SHOWHDINFO, "Invalid option case %i", c);
1177	}
1178	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
1179	return errorSyntax(USAGE_SHOWHDINFO, "unknown option: %s\n", ValueUnion.psz);
1180	else if (ValueUnion.pDef)
1181	return errorSyntax(USAGE_SHOWHDINFO, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
1182	else
1183	return errorSyntax(USAGE_SHOWHDINFO, "error: %Rrs", c);
1184	}
1185	}
1186
1187	/* check for required options */
1188	if (!FilenameOrUuid)
1189	return errorSyntax(USAGE_SHOWHDINFO, "Disk name or UUID required");
1190
1191	ComPtr<IMedium> hardDisk;
1192	bool unknown = false;
1193	/* first guess is that it's a UUID */
1194	rc = a->virtualBox->FindMedium(Bstr(FilenameOrUuid).raw(),
1195	DeviceType_HardDisk,
1196	hardDisk.asOutParam());
1197	/* no? well, then it's an unkwnown image */
1198	if (FAILED(rc))
1199	{
1200	rc = a->virtualBox->OpenMedium(Bstr(FilenameOrUuid).raw(),
1201	DeviceType_HardDisk,
1202	AccessMode_ReadWrite,
1203	hardDisk.asOutParam());
1204	if (rc == VBOX_E_FILE_ERROR)
1205	{
1206	char szFilenameAbs[RTPATH_MAX] = "";
1207	int vrc = RTPathAbs(FilenameOrUuid, szFilenameAbs, sizeof(szFilenameAbs));
1208	if (RT_FAILURE(vrc))
1209	{
1210	RTMsgError("Cannot convert filename \"%s\" to absolute path", FilenameOrUuid);
1211	return 1;
1212	}
1213	CHECK_ERROR(a->virtualBox, OpenMedium(Bstr(szFilenameAbs).raw(),
1214	DeviceType_HardDisk,
1215	AccessMode_ReadWrite,
1216	hardDisk.asOutParam()));
1217	}
1218	if (SUCCEEDED(rc))
1219	unknown = true;
1220	}
1221	do
1222	{
1223	if (!SUCCEEDED(rc))
1224	break;
1225
1226	Bstr uuid;
1227	hardDisk->COMGETTER(Id)(uuid.asOutParam());
1228	RTPrintf("UUID: %s\n", Utf8Str(uuid).c_str());
1229
1230	/* check for accessibility */
1231	/// @todo NEWMEDIA check accessibility of all parents
1232	/// @todo NEWMEDIA print the full state value
1233	MediumState_T state;
1234	CHECK_ERROR_BREAK(hardDisk, RefreshState(&state));
1235	RTPrintf("Accessible: %s\n", state != MediumState_Inaccessible ? "yes" : "no");
1236
1237	if (state == MediumState_Inaccessible)
1238	{
1239	Bstr err;
1240	CHECK_ERROR_BREAK(hardDisk, COMGETTER(LastAccessError)(err.asOutParam()));
1241	RTPrintf("Access Error: %lS\n", err.raw());
1242	}
1243
1244	Bstr description;
1245	hardDisk->COMGETTER(Description)(description.asOutParam());
1246	if (!description.isEmpty())
1247	{
1248	RTPrintf("Description: %lS\n", description.raw());
1249	}
1250
1251	LONG64 logicalSize;
1252	hardDisk->COMGETTER(LogicalSize)(&logicalSize);
1253	RTPrintf("Logical size: %lld MBytes\n", logicalSize);
1254	LONG64 actualSize;
1255	hardDisk->COMGETTER(Size)(&actualSize);
1256	RTPrintf("Current size on disk: %lld MBytes\n", actualSize >> 20);
1257
1258	ComPtr <IMedium> parent;
1259	hardDisk->COMGETTER(Parent)(parent.asOutParam());
1260
1261	MediumType_T type;
1262	hardDisk->COMGETTER(Type)(&type);
1263	const char *typeStr = "unknown";
1264	switch (type)
1265	{
1266	case MediumType_Normal:
1267	if (!parent.isNull())
1268	typeStr = "normal (differencing)";
1269	else
1270	typeStr = "normal (base)";
1271	break;
1272	case MediumType_Immutable:
1273	typeStr = "immutable";
1274	break;
1275	case MediumType_Writethrough:
1276	typeStr = "writethrough";
1277	break;
1278	case MediumType_Shareable:
1279	typeStr = "shareable";
1280	break;
1281	}
1282	RTPrintf("Type: %s\n", typeStr);
1283
1284	Bstr format;
1285	hardDisk->COMGETTER(Format)(format.asOutParam());
1286	RTPrintf("Storage format: %lS\n", format.raw());
1287
1288	/// @todo also dump config parameters (iSCSI)
1289
1290	if (!unknown)
1291	{
1292	com::SafeArray<BSTR> machineIds;
1293	hardDisk->COMGETTER(MachineIds)(ComSafeArrayAsOutParam(machineIds));
1294	for (size_t j = 0; j < machineIds.size(); ++ j)
1295	{
1296	ComPtr<IMachine> machine;
1297	CHECK_ERROR(a->virtualBox, GetMachine(machineIds[j], machine.asOutParam()));
1298	ASSERT(machine);
1299	Bstr name;
1300	machine->COMGETTER(Name)(name.asOutParam());
1301	machine->COMGETTER(Id)(uuid.asOutParam());
1302	RTPrintf("%s%lS (UUID: %lS)\n",
1303	j == 0 ? "In use by VMs: " : " ",
1304	name.raw(), machineIds[j]);
1305	}
1306	/// @todo NEWMEDIA check usage in snapshots too
1307	/// @todo NEWMEDIA also list children
1308	}
1309
1310	Bstr loc;
1311	hardDisk->COMGETTER(Location)(loc.asOutParam());
1312	RTPrintf("Location: %lS\n", loc.raw());
1313
1314	/* print out information specific for differencing hard disks */
1315	if (!parent.isNull())
1316	{
1317	BOOL autoReset = FALSE;
1318	hardDisk->COMGETTER(AutoReset)(&autoReset);
1319	RTPrintf("Auto-Reset: %s\n", autoReset ? "on" : "off");
1320	}
1321	}
1322	while (0);
1323
1324	if (unknown)
1325	{
1326	/* close the unknown hard disk to forget it again */
1327	hardDisk->Close();
1328	}
1329
1330	return SUCCEEDED(rc) ? 0 : 1;
1331	}
1332
1333	static const RTGETOPTDEF g_aOpenMediumOptions[] =
1334	{
1335	{ "disk", 'd', RTGETOPT_REQ_NOTHING },
1336	{ "dvd", 'D', RTGETOPT_REQ_NOTHING },
1337	{ "floppy", 'f', RTGETOPT_REQ_NOTHING },
1338	{ "--type", 't', RTGETOPT_REQ_STRING },
1339	{ "-type", 't', RTGETOPT_REQ_STRING }, // deprecated
1340	{ "--uuid", 'u', RTGETOPT_REQ_UUID },
1341	{ "--parentuuid", 'p', RTGETOPT_REQ_UUID },
1342	};
1343
1344	int handleOpenMedium(HandlerArg *a)
1345	{
1346	HRESULT rc = S_OK;
1347	int vrc;
1348	DeviceType_T devType = DeviceType_Null;
1349	const char *Filename = NULL;
1350	MediumType_T DiskType = MediumType_Normal;
1351	bool fDiskType = false;
1352	bool fSetImageId = false;
1353	bool fSetParentId = false;
1354	Guid ImageId;
1355	ImageId.clear();
1356	Guid ParentId;
1357	ParentId.clear();
1358
1359	int c;
1360	RTGETOPTUNION ValueUnion;
1361	RTGETOPTSTATE GetState;
1362	// start at 0 because main() has hacked both the argc and argv given to us
1363	RTGetOptInit(&GetState, a->argc, a->argv, g_aOpenMediumOptions, RT_ELEMENTS(g_aOpenMediumOptions),
1364	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
1365	while ((c = RTGetOpt(&GetState, &ValueUnion)))
1366	{
1367	switch (c)
1368	{
1369	case 'd': // disk
1370	if (devType != DeviceType_Null)
1371	return errorSyntax(USAGE_OPENMEDIUM, "Only one command can be specified: '%s'", ValueUnion.psz);
1372	devType = DeviceType_HardDisk;
1373	break;
1374
1375	case 'D': // DVD
1376	if (devType != DeviceType_Null)
1377	return errorSyntax(USAGE_OPENMEDIUM, "Only one command can be specified: '%s'", ValueUnion.psz);
1378	devType = DeviceType_DVD;
1379	break;
1380
1381	case 'f': // floppy
1382	if (devType != DeviceType_Null)
1383	return errorSyntax(USAGE_OPENMEDIUM, "Only one command can be specified: '%s'", ValueUnion.psz);
1384	devType = DeviceType_Floppy;
1385	break;
1386
1387	case 't': // --type
1388	vrc = parseDiskType(ValueUnion.psz, &DiskType);
1389	if (RT_FAILURE(vrc))
1390	return errorArgument("Invalid hard disk type '%s'", ValueUnion.psz);
1391	fDiskType = true;
1392	break;
1393
1394	case 'u': // --uuid
1395	ImageId = ValueUnion.Uuid;
1396	fSetImageId = true;
1397	break;
1398
1399	case 'p': // --parentuuid
1400	ParentId = ValueUnion.Uuid;
1401	fSetParentId = true;
1402	break;
1403
1404	case VINF_GETOPT_NOT_OPTION:
1405	if (!Filename)
1406	Filename = ValueUnion.psz;
1407	else
1408	return errorSyntax(USAGE_OPENMEDIUM, "Invalid parameter '%s'", ValueUnion.psz);
1409	break;
1410
1411	default:
1412	if (c > 0)
1413	{
1414	if (RT_C_IS_PRINT(c))
1415	return errorSyntax(USAGE_OPENMEDIUM, "Invalid option -%c", c);
1416	else
1417	return errorSyntax(USAGE_OPENMEDIUM, "Invalid option case %i", c);
1418	}
1419	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
1420	return errorSyntax(USAGE_OPENMEDIUM, "unknown option: %s\n", ValueUnion.psz);
1421	else if (ValueUnion.pDef)
1422	return errorSyntax(USAGE_OPENMEDIUM, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
1423	else
1424	return errorSyntax(USAGE_OPENMEDIUM, "error: %Rrs", c);
1425	}
1426	}
1427
1428	/* check for required options */
1429	if (devType == DeviceType_Null)
1430	return errorSyntax(USAGE_OPENMEDIUM, "Command variant disk/dvd/floppy required");
1431	if (!Filename)
1432	return errorSyntax(USAGE_OPENMEDIUM, "Disk name required");
1433
1434	/** @todo remove this hack!
1435	* First try opening the image as is (using the regular API semantics for
1436	* images with relative path or without path), and if that fails with a
1437	* file related error then try it again with what the client thinks the
1438	* relative path would mean. Requires doing the command twice in certain
1439	* cases. This is an ugly hack and needs to be removed whevever we have a
1440	* chance to clean up the API semantics. */
1441
1442	ComPtr<IMedium> pMedium;
1443	rc = a->virtualBox->OpenMedium(Bstr(Filename).raw(), devType,
1444	AccessMode_ReadWrite, pMedium.asOutParam());
1445	if (rc == VBOX_E_FILE_ERROR)
1446	{
1447	char szFilenameAbs[RTPATH_MAX] = "";
1448	int irc = RTPathAbs(Filename, szFilenameAbs, sizeof(szFilenameAbs));
1449	if (RT_FAILURE(irc))
1450	{
1451	RTMsgError("Cannot convert filename \"%s\" to absolute path", Filename);
1452	return 1;
1453	}
1454	CHECK_ERROR(a->virtualBox, OpenMedium(Bstr(szFilenameAbs).raw(),
1455	devType, AccessMode_ReadWrite,
1456	pMedium.asOutParam()));
1457	}
1458	if (SUCCEEDED(rc) && pMedium)
1459	{
1460	if (devType == DeviceType_HardDisk)
1461	{
1462	if (DiskType != MediumType_Normal)
1463	{
1464	CHECK_ERROR(pMedium, COMSETTER(Type)(DiskType));
1465	}
1466	}
1467	else
1468	{
1469	// DVD or floppy image
1470	if (fDiskType \|\| fSetParentId)
1471	return errorSyntax(USAGE_OPENMEDIUM, "Invalid option for DVD and floppy images");
1472	}
1473	if (fSetImageId \|\| fSetParentId)
1474	{
1475	Bstr ImageIdStr = BstrFmt("%RTuuid", &ImageId);
1476	Bstr ParentIdStr = BstrFmt("%RTuuid", &ParentId);
1477	CHECK_ERROR(pMedium, SetIDs(fSetImageId, ImageIdStr.raw(),
1478	fSetParentId, ParentIdStr.raw()));
1479	}
1480	}
1481
1482	return SUCCEEDED(rc) ? 0 : 1;
1483	}
1484
1485	static const RTGETOPTDEF g_aCloseMediumOptions[] =
1486	{
1487	{ "disk", 'd', RTGETOPT_REQ_NOTHING },
1488	{ "dvd", 'D', RTGETOPT_REQ_NOTHING },
1489	{ "floppy", 'f', RTGETOPT_REQ_NOTHING },
1490	{ "--delete", 'r', RTGETOPT_REQ_NOTHING },
1491	};
1492
1493	int handleCloseMedium(HandlerArg *a)
1494	{
1495	HRESULT rc = S_OK;
1496	enum {
1497	CMD_NONE,
1498	CMD_DISK,
1499	CMD_DVD,
1500	CMD_FLOPPY
1501	} cmd = CMD_NONE;
1502	const char *FilenameOrUuid = NULL;
1503	bool fDelete = false;
1504
1505	int c;
1506	RTGETOPTUNION ValueUnion;
1507	RTGETOPTSTATE GetState;
1508	// start at 0 because main() has hacked both the argc and argv given to us
1509	RTGetOptInit(&GetState, a->argc, a->argv, g_aCloseMediumOptions, RT_ELEMENTS(g_aCloseMediumOptions),
1510	0, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
1511	while ((c = RTGetOpt(&GetState, &ValueUnion)))
1512	{
1513	switch (c)
1514	{
1515	case 'd': // disk
1516	if (cmd != CMD_NONE)
1517	return errorSyntax(USAGE_CLOSEMEDIUM, "Only one command can be specified: '%s'", ValueUnion.psz);
1518	cmd = CMD_DISK;
1519	break;
1520
1521	case 'D': // DVD
1522	if (cmd != CMD_NONE)
1523	return errorSyntax(USAGE_CLOSEMEDIUM, "Only one command can be specified: '%s'", ValueUnion.psz);
1524	cmd = CMD_DVD;
1525	break;
1526
1527	case 'f': // floppy
1528	if (cmd != CMD_NONE)
1529	return errorSyntax(USAGE_CLOSEMEDIUM, "Only one command can be specified: '%s'", ValueUnion.psz);
1530	cmd = CMD_FLOPPY;
1531	break;
1532
1533	case 'r': // --delete
1534	fDelete = true;
1535	break;
1536
1537	case VINF_GETOPT_NOT_OPTION:
1538	if (!FilenameOrUuid)
1539	FilenameOrUuid = ValueUnion.psz;
1540	else
1541	return errorSyntax(USAGE_CLOSEMEDIUM, "Invalid parameter '%s'", ValueUnion.psz);
1542	break;
1543
1544	default:
1545	if (c > 0)
1546	{
1547	if (RT_C_IS_PRINT(c))
1548	return errorSyntax(USAGE_CLOSEMEDIUM, "Invalid option -%c", c);
1549	else
1550	return errorSyntax(USAGE_CLOSEMEDIUM, "Invalid option case %i", c);
1551	}
1552	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
1553	return errorSyntax(USAGE_CLOSEMEDIUM, "unknown option: %s\n", ValueUnion.psz);
1554	else if (ValueUnion.pDef)
1555	return errorSyntax(USAGE_CLOSEMEDIUM, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
1556	else
1557	return errorSyntax(USAGE_CLOSEMEDIUM, "error: %Rrs", c);
1558	}
1559	}
1560
1561	/* check for required options */
1562	if (cmd == CMD_NONE)
1563	return errorSyntax(USAGE_CLOSEMEDIUM, "Command variant disk/dvd/floppy required");
1564	if (!FilenameOrUuid)
1565	return errorSyntax(USAGE_CLOSEMEDIUM, "Disk name or UUID required");
1566
1567	ComPtr<IMedium> medium;
1568
1569	if (cmd == CMD_DISK)
1570	CHECK_ERROR(a->virtualBox, FindMedium(Bstr(FilenameOrUuid).raw(),
1571	DeviceType_HardDisk,
1572	medium.asOutParam()));
1573	else if (cmd == CMD_DVD)
1574	CHECK_ERROR(a->virtualBox, FindMedium(Bstr(FilenameOrUuid).raw(),
1575	DeviceType_DVD,
1576	medium.asOutParam()));
1577	else if (cmd == CMD_FLOPPY)
1578	CHECK_ERROR(a->virtualBox, FindMedium(Bstr(FilenameOrUuid).raw(),
1579	DeviceType_Floppy,
1580	medium.asOutParam()));
1581
1582	if (SUCCEEDED(rc) && medium)
1583	{
1584	if (fDelete)
1585	{
1586	ComPtr<IProgress> progress;
1587	CHECK_ERROR(medium, DeleteStorage(progress.asOutParam()));
1588	if (SUCCEEDED(rc))
1589	{
1590	rc = showProgress(progress);
1591	if (FAILED(rc))
1592	{
1593	com::ProgressErrorInfo info(progress);
1594	if (info.isBasicAvailable())
1595	RTMsgError("Failed to delete medium. Error message: %lS", info.getText().raw());
1596	else
1597	RTMsgError("Failed to delete medium. No error message available!");
1598	}
1599	}
1600	else
1601	RTMsgError("Failed to delete medium. Error code %Rrc", rc);
1602	}
1603	CHECK_ERROR(medium, Close());
1604	}
1605
1606	return SUCCEEDED(rc) ? 0 : 1;
1607	}
1608	#endif /* !VBOX_ONLY_DOCS */

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

source: vbox/trunk/src/VBox/Frontends/VBoxManage/VBoxManageDisk.cpp@ 32814

Download in other formats: