VirtualBox

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

Last change on this file since 7218 was 7207, checked in by vboxsync, 17 years ago

Main: Reworked enums to avoid 1) weird duplication of enum name when referring to enum values in cross-platform code; 2) possible clashes on Win32 due to putting identifiers like Paused or Disabled to the global namespace (via C enums). In the new style, enums are used like this: a) USBDeviceState_T v = USBDeviceState_Busy from cross-platform non-Qt code; b) KUSBDeviceState v = KUSBDeviceState_Busy from Qt code; c) USBDeviceState v = USBDeviceState_Busy from plain Win32 and d) PRUInt32 USBDeviceState v = USBDeviceState::Busy from plain XPCOM.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 273.8 KB
Line 
1/** @file
2 *
3 * VBox frontends: VBoxManage (command-line interface)
4 *
5 * VBoxManage is VirtualBox's command-line interface. This is its rather
6 * long source.
7 */
8
9/*
10 * Copyright (C) 2006-2007 innotek GmbH
11 *
12 * This file is part of VirtualBox Open Source Edition (OSE), as
13 * available from http://www.virtualbox.org. This file is free software;
14 * you can redistribute it and/or modify it under the terms of the GNU
15 * General Public License (GPL) as published by the Free Software
16 * Foundation, in version 2 as it comes in the "COPYING" file of the
17 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
18 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19 */
20
21
22/*******************************************************************************
23* Header Files *
24*******************************************************************************/
25
26#include <VBox/com/com.h>
27#include <VBox/com/string.h>
28#include <VBox/com/Guid.h>
29#include <VBox/com/ErrorInfo.h>
30#include <VBox/com/EventQueue.h>
31
32#include <VBox/com/VirtualBox.h>
33
34/// @todo later, when the settings file update funciton is reimplemented using
35/// libxslt (search for CFGLDR to find related parts of code below)
36// #include <VBox/settings.h>
37
38#include <stdlib.h>
39#include <stdarg.h>
40
41#include <vector>
42
43#include <iprt/runtime.h>
44#include <iprt/stream.h>
45#include <iprt/string.h>
46#include <iprt/asm.h>
47#include <iprt/uuid.h>
48#include <iprt/thread.h>
49#include <iprt/path.h>
50#include <iprt/param.h>
51#include <iprt/dir.h>
52#include <iprt/file.h>
53#include <iprt/env.h>
54#include <VBox/err.h>
55#include <VBox/version.h>
56#include <VBox/VBoxHDD.h>
57
58#include "VBoxManage.h"
59
60using namespace com;
61
62/* missing XPCOM <-> COM wrappers */
63#ifndef STDMETHOD_
64# define STDMETHOD_(ret, meth) NS_IMETHOD_(ret) meth
65#endif
66#ifndef NS_GET_IID
67# define NS_GET_IID(I) IID_##I
68#endif
69#ifndef RT_OS_WINDOWS
70#define IUnknown nsISupports
71#endif
72
73/** command handler type */
74typedef DECLCALLBACK(int) FNHANDLER(int argc, char *argv[], ComPtr<IVirtualBox> aVirtualBox, ComPtr<ISession> aSession);
75typedef FNHANDLER *PFNHANDLER;
76
77/**
78 * Quick IUSBDevice implementation for detaching / attaching
79 * devices to the USB Controller.
80 */
81class MyUSBDevice : public IUSBDevice
82{
83public:
84 // public initializer/uninitializer for internal purposes only
85 MyUSBDevice(uint16_t a_u16VendorId, uint16_t a_u16ProductId, uint16_t a_bcdRevision, uint64_t a_u64SerialHash, const char *a_pszComment)
86 : m_usVendorId(a_u16VendorId), m_usProductId(a_u16ProductId),
87 m_bcdRevision(a_bcdRevision), m_u64SerialHash(a_u64SerialHash),
88 m_bstrComment(a_pszComment),
89 m_cRefs(0)
90 {
91 }
92
93 STDMETHOD_(ULONG, AddRef)(void)
94 {
95 return ASMAtomicIncU32(&m_cRefs);
96 }
97 STDMETHOD_(ULONG, Release)(void)
98 {
99 ULONG cRefs = ASMAtomicDecU32(&m_cRefs);
100 if (!cRefs)
101 delete this;
102 return cRefs;
103 }
104 STDMETHOD(QueryInterface)(const IID &iid, void **ppvObject)
105 {
106 Guid guid(iid);
107 if (guid == Guid(NS_GET_IID(IUnknown)))
108 *ppvObject = (IUnknown *)this;
109 else if (guid == Guid(NS_GET_IID(IUSBDevice)))
110 *ppvObject = (IUSBDevice *)this;
111 else
112 return E_NOINTERFACE;
113 AddRef();
114 return S_OK;
115 }
116
117 STDMETHOD(COMGETTER(Id))(GUIDPARAMOUT a_pId) { return E_NOTIMPL; }
118 STDMETHOD(COMGETTER(VendorId))(USHORT *a_pusVendorId) { *a_pusVendorId = m_usVendorId; return S_OK; }
119 STDMETHOD(COMGETTER(ProductId))(USHORT *a_pusProductId) { *a_pusProductId = m_usProductId; return S_OK; }
120 STDMETHOD(COMGETTER(Revision))(USHORT *a_pusRevision) { *a_pusRevision = m_bcdRevision; return S_OK; }
121 STDMETHOD(COMGETTER(SerialHash))(ULONG64 *a_pullSerialHash) { *a_pullSerialHash = m_u64SerialHash; return S_OK; }
122 STDMETHOD(COMGETTER(Manufacturer))(BSTR *a_pManufacturer) { return E_NOTIMPL; }
123 STDMETHOD(COMGETTER(Product))(BSTR *a_pProduct) { return E_NOTIMPL; }
124 STDMETHOD(COMGETTER(SerialNumber))(BSTR *a_pSerialNumber) { return E_NOTIMPL; }
125 STDMETHOD(COMGETTER(Address))(BSTR *a_pAddress) { return E_NOTIMPL; }
126
127private:
128 /** The vendor id of this USB device. */
129 USHORT m_usVendorId;
130 /** The product id of this USB device. */
131 USHORT m_usProductId;
132 /** The product revision number of this USB device.
133 * (high byte = integer; low byte = decimal) */
134 USHORT m_bcdRevision;
135 /** The USB serial hash of the device. */
136 uint64_t m_u64SerialHash;
137 /** The user comment string. */
138 Bstr m_bstrComment;
139 /** Reference counter. */
140 uint32_t volatile m_cRefs;
141};
142
143
144// types
145///////////////////////////////////////////////////////////////////////////////
146
147template <typename T>
148class Nullable
149{
150public:
151
152 Nullable() : mIsNull (true) {}
153 Nullable (const T &aValue, bool aIsNull = false)
154 : mIsNull (aIsNull), mValue (aValue) {}
155
156 bool isNull() const { return mIsNull; };
157 void setNull (bool aIsNull = true) { mIsNull = aIsNull; }
158
159 operator const T&() const { return mValue; }
160
161 Nullable &operator= (const T &aValue)
162 {
163 mValue = aValue;
164 mIsNull = false;
165 return *this;
166 }
167
168private:
169
170 bool mIsNull;
171 T mValue;
172};
173
174/** helper structure to encapsulate USB filter manipulation commands */
175struct USBFilterCmd
176{
177 struct USBFilter
178 {
179 USBFilter ()
180 : mAction (USBDeviceFilterAction_Null)
181 {}
182
183 Bstr mName;
184 Nullable <bool> mActive;
185 Bstr mVendorId;
186 Bstr mProductId;
187 Bstr mRevision;
188 Bstr mManufacturer;
189 Bstr mProduct;
190 Bstr mRemote;
191 Bstr mSerialNumber;
192 Nullable <ULONG> mMaskedInterfaces;
193 USBDeviceFilterAction_T mAction;
194 };
195
196 enum Action { Invalid, Add, Modify, Remove };
197
198 USBFilterCmd() : mAction (Invalid), mIndex (0), mGlobal (false) {}
199
200 Action mAction;
201 ULONG mIndex;
202 /** flag whether the command target is a global filter */
203 bool mGlobal;
204 /** machine this command is targeted at (null for global filters) */
205 ComPtr<IMachine> mMachine;
206 USBFilter mFilter;
207};
208
209// funcs
210///////////////////////////////////////////////////////////////////////////////
211
212static void showLogo(void)
213{
214 static bool fShown; /* show only once */
215
216 if (!fShown)
217 {
218 RTPrintf("VirtualBox Command Line Management Interface Version "
219 VBOX_VERSION_STRING "\n"
220 "(C) 2005-2008 innotek GmbH\n"
221 "All rights reserved.\n"
222 "\n");
223 fShown = true;
224 }
225}
226
227static void printUsage(USAGECATEGORY u64Cmd)
228{
229#ifdef RT_OS_LINUX
230 bool fLinux = true;
231#else
232 bool fLinux = false;
233#endif
234#ifdef RT_OS_WINDOWS
235 bool fWin = true;
236#else
237 bool fWin = false;
238#endif
239#ifdef RT_OS_DARWIN
240 bool fDarwin = true;
241#else
242 bool fDarwin = false;
243#endif
244#ifdef VBOX_VRDP
245 bool fVRDP = true;
246#else
247 bool fVRDP = false;
248#endif
249
250 if (u64Cmd == USAGE_DUMPOPTS)
251 {
252 fLinux = true;
253 fWin = true;
254 fVRDP = true;
255 u64Cmd = USAGE_ALL;
256 }
257
258 RTPrintf("Usage:\n"
259 "\n");
260
261 if (u64Cmd == USAGE_ALL)
262 {
263 RTPrintf("VBoxManage [-v|-version] print version number and exit\n");
264 RTPrintf("VBoxManage -nologo ... suppress the logo\n"
265 "\n");
266 }
267
268 if (u64Cmd & USAGE_LIST)
269 {
270 RTPrintf("VBoxManage list vms|runningvms|ostypes|hostdvds|hostfloppies|\n");
271 if (fWin)
272 RTPrintf( "hostifs|");
273 RTPrintf(" hdds|dvds|floppies|usbhost|usbfilters|\n"
274 " systemproperties\n"
275 "\n");
276 }
277
278 if (u64Cmd & USAGE_SHOWVMINFO)
279 {
280 RTPrintf("VBoxManage showvminfo <uuid>|<name>\n"
281 " [-details]\n"
282 " [-statistics]\n"
283 " [-machinereadable]\n"
284 "\n");
285 }
286
287 if (u64Cmd & USAGE_REGISTERVM)
288 {
289 RTPrintf("VBoxManage registervm <filename>\n"
290 "\n");
291 }
292
293 if (u64Cmd & USAGE_UNREGISTERVM)
294 {
295 RTPrintf("VBoxManage unregistervm <uuid>|<name>\n"
296 " [-delete]\n"
297 "\n");
298 }
299
300 if (u64Cmd & USAGE_CREATEVM)
301 {
302 RTPrintf("VBoxManage createvm -name <name>\n"
303 " [-register]\n"
304 " [-basefolder <path> | -settingsfile <path>]\n"
305 " [-uuid <uuid>]\n"
306 " \n"
307 "\n");
308 }
309
310 if (u64Cmd & USAGE_MODIFYVM)
311 {
312 RTPrintf("VBoxManage modifyvm <uuid|name>\n"
313 " [-name <name>]\n"
314 " [-ostype <ostype>]\n"
315 " [-memory <memorysize>]\n"
316 " [-vram <vramsize>]\n"
317 " [-acpi on|off]\n"
318 " [-ioapic on|off]\n"
319 " [-hwvirtex on|off|default]\n"
320 " [-monitorcount <number>]\n"
321 " [-bioslogofadein on|off]\n"
322 " [-bioslogofadeout on|off]\n"
323 " [-bioslogodisplaytime <msec>]\n"
324 " [-bioslogoimagepath <imagepath>]\n"
325 " [-biosbootmenu disabled|menuonly|messageandmenu]\n"
326 " [-biossystemtimeoffset <msec>]\n"
327 " [-biospxedebug on|off]\n"
328 " [-boot<1-4> none|floppy|dvd|disk|net>]\n"
329 " [-hd<a|b|d> none|<uuid>|<filename>]\n"
330 " [-dvd none|<uuid>|<filename>|host:<drive>]\n"
331 " [-dvdpassthrough on|off]\n"
332 " [-floppy disabled|empty|<uuid>|\n"
333 " <filename>|host:<drive>]\n"
334 " [-nic<1-N> none|null|nat|hostif|intnet]\n"
335 " [-nictype<1-N> Am79C970A|Am79C973"
336#ifdef VBOX_WITH_E1000
337 "|82540EM"
338#endif
339 "]\n"
340 " [-cableconnected<1-N> on|off]\n"
341 " [-nictrace<1-N> on|off]\n"
342 " [-nictracefile<1-N> <filename>]\n"
343 " [-nicspeed<1-N> <kbps>]\n"
344 " [-hostifdev<1-N> none|<devicename>]\n"
345 " [-intnet<1-N> <network>]\n"
346 " [-macaddress<1-N> auto|<mac>]\n"
347 " [-uart<1-N> off|<I/O base> <IRQ>]\n"
348 " [-uartmode<1-N> disconnected|\n"
349 " server <pipe>|\n"
350 " client <pipe>|\n"
351 " <devicename>]\n"
352 " [-guestmemoryballoon <balloonsize>]\n"
353 " [-gueststatisticsinterval <seconds>]\n"
354 );
355 if (fLinux)
356 {
357 RTPrintf(" [-tapsetup<1-N> none|<application>]\n"
358 " [-tapterminate<1-N> none|<application>]\n");
359 }
360 RTPrintf(" [-audio none|null");
361 if (fWin)
362 {
363#ifdef VBOX_WITH_WINMM
364 RTPrintf( "|winmm|dsound");
365#else
366 RTPrintf( "|dsound");
367#endif
368 }
369 if (fLinux)
370 {
371 RTPrintf( "|oss"
372#ifdef VBOX_WITH_ALSA
373 "|alsa"
374#endif
375#ifdef VBOX_WITH_PULSE
376 "|pulse"
377#endif
378 );
379 }
380 if (fDarwin)
381 {
382 RTPrintf( "|coreaudio");
383 }
384 RTPrintf( "]\n");
385 RTPrintf(" [-audiocontroller ac97|sb16]\n"
386 " [-clipboard disabled|hosttoguest|guesttohost|\n"
387 " bidirectional]\n");
388 if (fVRDP)
389 {
390 RTPrintf(" [-vrdp on|off]\n"
391 " [-vrdpport default|<port>]\n"
392 " [-vrdpaddress <host>]\n"
393 " [-vrdpauthtype null|external|guest]\n"
394 " [-vrdpmulticon on|off]\n");
395 }
396 RTPrintf(" [-usb on|off]\n"
397 " [-usbehci on|off]\n"
398 " [-snapshotfolder default|<path>]\n"
399 "\n");
400 }
401
402 if (u64Cmd & USAGE_STARTVM)
403 {
404 RTPrintf("VBoxManage startvm <uuid>|<name>\n");
405 if (fVRDP)
406 RTPrintf(" [-type gui|vrdp]\n");
407 RTPrintf("\n");
408 }
409
410 if (u64Cmd & USAGE_CONTROLVM)
411 {
412 RTPrintf("VBoxManage controlvm <uuid>|<name>\n"
413 " pause|resume|reset|poweroff|savestate|\n"
414 " acpipowerbutton|acpisleepbutton|\n"
415 " setlinkstate<1-4> on|off |\n"
416 " usbattach <uuid>|<address> |\n"
417 " usbdetach <uuid>|<address> |\n"
418 " dvdattach none|<uuid>|<filename>|host:<drive> |\n"
419 " floppyattach none|<uuid>|<filename>|host:<drive> |\n"
420 " setvideomodehint <xres> <yres> <bpp> [display]|\n"
421 " setcredentials <username> <password> <domain>\n"
422 " [-allowlocallogon <yes|no>]\n"
423 "\n");
424 }
425
426 if (u64Cmd & USAGE_DISCARDSTATE)
427 {
428 RTPrintf("VBoxManage discardstate <uuid>|<name>\n"
429 "\n");
430 }
431
432 if (u64Cmd & USAGE_ADOPTSTATE)
433 {
434 RTPrintf("VBoxManage adoptstate <uuid>|<name> <state_file>\n"
435 "\n");
436 }
437
438 if (u64Cmd & USAGE_SNAPSHOT)
439 {
440 RTPrintf("VBoxManage snapshot <uuid>|<name>\n"
441 " take <name> [-desc <desc>] |\n"
442 " discard <uuid>|<name> |\n"
443 " discardcurrent -state|-all |\n"
444 " edit <uuid>|<name>|-current\n"
445 " [-newname <name>]\n"
446 " [-newdesc <desc>] |\n"
447 " showvminfo <uuid>|<name>\n"
448 "\n");
449 }
450
451 if (u64Cmd & USAGE_REGISTERIMAGE)
452 {
453 RTPrintf("VBoxManage registerimage disk|dvd|floppy <filename>\n"
454 " [-type normal|immutable|writethrough] (disk only)\n"
455 "\n");
456 }
457
458 if (u64Cmd & USAGE_UNREGISTERIMAGE)
459 {
460 RTPrintf("VBoxManage unregisterimage disk|dvd|floppy <uuid>|<filename>\n"
461 "\n");
462 }
463
464 if (u64Cmd & USAGE_SHOWVDIINFO)
465 {
466 RTPrintf("VBoxManage showvdiinfo <uuid>|<filename>\n"
467 "\n");
468 }
469
470 if (u64Cmd & USAGE_CREATEVDI)
471 {
472 RTPrintf("VBoxManage createvdi -filename <filename>\n"
473 " -size <megabytes>\n"
474 " [-static]\n"
475 " [-comment <comment>]\n"
476 " [-register]\n"
477 " [-type normal|writethrough] (default: normal)\n"
478 "\n");
479 }
480
481 if (u64Cmd & USAGE_MODIFYVDI)
482 {
483 RTPrintf("VBoxManage modifyvdi <uuid>|<filename>\n"
484#if 0 /* doesn't currently work */
485 " settype normal|writethrough|immutable |\n"
486#endif
487 " compact\n"
488 "\n");
489 }
490
491 if (u64Cmd & USAGE_CLONEVDI)
492 {
493 RTPrintf("VBoxManage clonevdi <uuid>|<filename> <outputfile>\n"
494 "\n");
495 }
496
497 if (u64Cmd & USAGE_CONVERTDD)
498 {
499 RTPrintf("VBoxManage convertdd <filename> <outputfile>\n"
500 "VBoxManage convertdd stdin <outputfile> <bytes>\n"
501 "\n");
502 }
503
504 if (u64Cmd & USAGE_ADDISCSIDISK)
505 {
506 RTPrintf("VBoxManage addiscsidisk -server <name>|<ip>\n"
507 " -target <target>\n"
508 " [-port <port>]\n"
509 " [-lun <lun>]\n"
510 " [-encodedlun <lun>]\n"
511 " [-username <username>]\n"
512 " [-password <password>]\n"
513 " [-comment <comment>]\n"
514 "\n");
515 }
516
517 if (u64Cmd & USAGE_CREATEHOSTIF && fWin)
518 {
519 RTPrintf("VBoxManage createhostif <name>\n"
520 "\n");
521 }
522
523 if (u64Cmd & USAGE_REMOVEHOSTIF && fWin)
524 {
525 RTPrintf("VBoxManage removehostif <uuid>|<name>\n"
526 "\n");
527 }
528
529 if (u64Cmd & USAGE_GETEXTRADATA)
530 {
531 RTPrintf("VBoxManage getextradata global|<uuid>|<name>\n"
532 " <key>|enumerate\n"
533 "\n");
534 }
535
536 if (u64Cmd & USAGE_SETEXTRADATA)
537 {
538 RTPrintf("VBoxManage setextradata global|<uuid>|<name>\n"
539 " <key>\n"
540 " [<value>] (no value deletes key)\n"
541 "\n");
542 }
543
544 if (u64Cmd & USAGE_SETPROPERTY)
545 {
546 RTPrintf("VBoxManage setproperty vdifolder default|<folder> |\n"
547 " machinefolder default|<folder> |\n"
548 " vrdpauthlibrary default|<library> |\n"
549 " websrvauthlibrary default|null|<library> |\n"
550 " hwvirtexenabled yes|no\n"
551 " loghistorycount <value>\n"
552 "\n");
553 }
554
555 if (u64Cmd & USAGE_USBFILTER_ADD)
556 {
557 RTPrintf("VBoxManage usbfilter add <index,0-N>\n"
558 " -target <uuid>|<name>|global\n"
559 " -name <string>\n"
560 " -action ignore|hold (global filters only)\n"
561 " [-active yes|no] (yes)\n"
562 " [-vendorid <XXXX>] (null)\n"
563 " [-productid <XXXX>] (null)\n"
564 " [-revision <IIFF>] (null)\n"
565 " [-manufacturer <string>] (null)\n"
566 " [-product <string>] (null)\n"
567 " [-remote yes|no] (null, VM filters only)\n"
568 " [-serialnumber <string>] (null)\n"
569 " [-maskedinterfaces <XXXXXXXX>]\n"
570 "\n");
571 }
572
573 if (u64Cmd & USAGE_USBFILTER_MODIFY)
574 {
575 RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"
576 " -target <uuid>|<name>|global\n"
577 " [-name <string>]\n"
578 " [-action ignore|hold] (global filters only)\n"
579 " [-active yes|no]\n"
580 " [-vendorid <XXXX>|\"\"]\n"
581 " [-productid <XXXX>|\"\"]\n"
582 " [-revision <IIFF>|\"\"]\n"
583 " [-manufacturer <string>|\"\"]\n"
584 " [-product <string>|\"\"]\n"
585 " [-remote yes|no] (null, VM filters only)\n"
586 " [-serialnumber <string>|\"\"]\n"
587 " [-maskedinterfaces <XXXXXXXX>]\n"
588 "\n");
589 }
590
591 if (u64Cmd & USAGE_USBFILTER_REMOVE)
592 {
593 RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"
594 " -target <uuid>|<name>|global\n"
595 "\n");
596 }
597
598 if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
599 {
600 RTPrintf("VBoxManage sharedfolder add <vmname>|<uuid>\n"
601 " -name <name> -hostpath <hostpath>\n"
602 " [-transient] [-readonly]\n"
603 "\n");
604 }
605
606 if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
607 {
608 RTPrintf("VBoxManage sharedfolder remove <vmname>|<uuid>\n"
609 " -name <name> [-transient]\n"
610 "\n");
611 }
612
613 if (u64Cmd & USAGE_UPDATESETTINGS)
614 {
615 RTPrintf("VBoxManage updatesettings [<dir>|<file>] [-apply]\n"
616 " [-nobackup] [-skipinvalid]\n"
617 "\n");
618 }
619
620 if (u64Cmd & USAGE_VM_STATISTICS)
621 {
622 RTPrintf("VBoxManage vmstatistics <vmname>|<uuid> [-reset]\n"
623 " [-pattern <pattern>] [-descriptions]\n"
624 "\n");
625 }
626}
627
628/**
629 * Print a usage synopsis and the syntax error message.
630 */
631int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
632{
633 va_list args;
634 showLogo(); // show logo even if suppressed
635 if (g_fInternalMode)
636 printUsageInternal(u64Cmd);
637 else
638 printUsage(u64Cmd);
639 va_start(args, pszFormat);
640 RTPrintf("\n"
641 "Syntax error: %N\n", pszFormat, &args);
642 va_end(args);
643 return 1;
644}
645
646/**
647 * Print an error message without the syntax stuff.
648 */
649int errorArgument(const char *pszFormat, ...)
650{
651 va_list args;
652 va_start(args, pszFormat);
653 RTPrintf("error: %N\n", pszFormat, &args);
654 va_end(args);
655 return 1;
656}
657
658/**
659 * Print out progress on the console
660 */
661static void showProgress(ComPtr<IProgress> progress)
662{
663 BOOL fCompleted;
664 LONG currentPercent;
665 LONG lastPercent = 0;
666
667 RTPrintf("0%%...");
668 RTStrmFlush(g_pStdOut);
669 while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted))))
670 {
671 progress->COMGETTER(Percent(&currentPercent));
672
673 /* did we cross a 10% mark? */
674 if (((currentPercent / 10) > (lastPercent / 10)))
675 {
676 /* make sure to also print out missed steps */
677 for (LONG curVal = (lastPercent / 10) * 10 + 10; curVal <= (currentPercent / 10) * 10; curVal += 10)
678 {
679 if (curVal < 100)
680 {
681 RTPrintf("%ld%%...", curVal);
682 RTStrmFlush(g_pStdOut);
683 }
684 }
685 lastPercent = (currentPercent / 10) * 10;
686 }
687 if (fCompleted)
688 break;
689
690 /* make sure the loop is not too tight */
691 progress->WaitForCompletion(100);
692 }
693
694 /* complete the line. */
695 HRESULT rc;
696 if (SUCCEEDED(progress->COMGETTER(ResultCode)(&rc)))
697 {
698 if (SUCCEEDED(rc))
699 RTPrintf("100%%\n");
700 else
701 RTPrintf("FAILED\n");
702 }
703 else
704 RTPrintf("\n");
705 RTStrmFlush(g_pStdOut);
706}
707
708static void showSnapshots(ComPtr<ISnapshot> rootSnapshot, VMINFO_DETAILS details, const Bstr &prefix = "", int level = 0)
709{
710 /* start with the root */
711 Bstr name;
712 Guid uuid;
713 rootSnapshot->COMGETTER(Name)(name.asOutParam());
714 rootSnapshot->COMGETTER(Id)(uuid.asOutParam());
715 if (details == VMINFO_MACHINEREADABLE)
716 {
717 /* print with hierarchical numbering */
718 RTPrintf("SnapshotName%lS=\"%lS\"\n", prefix.raw(), name.raw());
719 RTPrintf("SnapshotUUID%lS=\"%s\"\n", prefix.raw(), uuid.toString().raw());
720 }
721 else
722 {
723 /* print with indentation */
724 RTPrintf(" %lSName: %lS (UUID: %s)\n", prefix.raw(), name.raw(), uuid.toString().raw());
725 }
726
727 /* get the children */
728 ComPtr<ISnapshotCollection> coll;
729 rootSnapshot->COMGETTER(Children)(coll.asOutParam());
730 if (coll)
731 {
732 ComPtr<ISnapshotEnumerator> enumerator;
733 coll->Enumerate(enumerator.asOutParam());
734 ULONG index = 0;
735 BOOL hasMore = FALSE;
736 while (enumerator->HasMore(&hasMore), hasMore)
737 {
738 ComPtr<ISnapshot> snapshot;
739 enumerator->GetNext(snapshot.asOutParam());
740 if (snapshot)
741 {
742 Bstr newPrefix;
743 if (details == VMINFO_MACHINEREADABLE)
744 newPrefix = Utf8StrFmt("%lS-%d", prefix.raw(), index + 1);
745 else
746 newPrefix = Utf8StrFmt("%lS ", prefix.raw());
747 /* recursive call */
748 showSnapshots(snapshot, details, newPrefix, level + 1);
749 }
750 index++;
751 }
752 }
753}
754
755static void makeTimeStr (char *s, int cb, int64_t millies)
756{
757 RTTIME t;
758 RTTIMESPEC ts;
759
760 RTTimeSpecSetMilli(&ts, millies);
761
762 RTTimeExplode (&t, &ts);
763
764 RTStrPrintf(s, cb, "%04d/%02d/%02d %02d:%02d:%02d UTC",
765 t.i32Year, t.u8Month, t.u8MonthDay,
766 t.u8Hour, t.u8Minute, t.u8Second);
767}
768
769static HRESULT showVMInfo (ComPtr <IVirtualBox> virtualBox, ComPtr<IMachine> machine,
770 ComPtr <IConsole> console = ComPtr <IConsole> (),
771 VMINFO_DETAILS details = VMINFO_NONE)
772{
773 HRESULT rc;
774
775 /*
776 * The rules for output in -argdump format:
777 * 1) the key part (the [0-9a-zA-Z_]+ string before the '=' delimiter)
778 * is all lowercase for "VBoxManage modifyvm" parameters. Any
779 * other values printed are in CamelCase.
780 * 2) strings (anything non-decimal) are printed surrounded by
781 * double quotes '"'. If the strings themselves contain double
782 * quotes, these characters are escaped by '\'. Any '\' character
783 * in the original string is also escaped by '\'.
784 * 3) numbers (containing just [0-9\-]) are written out unchanged.
785 */
786
787 /** @todo the quoting is not yet implemented! */
788
789 BOOL accessible = FALSE;
790 CHECK_ERROR (machine, COMGETTER(Accessible) (&accessible));
791 CheckComRCReturnRC (rc);
792
793 if (!accessible)
794 {
795 if (details == VMINFO_MACHINEREADABLE)
796 RTPrintf("name=\"<inaccessible>\"\n");
797 else
798 RTPrintf ("Name: <inaccessible!>\n");
799 Guid uuid;
800 rc = machine->COMGETTER(Id) (uuid.asOutParam());
801 if (details == VMINFO_MACHINEREADABLE)
802 RTPrintf ("UUID=\"%s\"\n", uuid.toString().raw());
803 else
804 RTPrintf ("UUID: %s\n", uuid.toString().raw());
805 if (details != VMINFO_MACHINEREADABLE)
806 {
807 Bstr settingsFilePath;
808 rc = machine->COMGETTER(SettingsFilePath) (settingsFilePath.asOutParam());
809 RTPrintf ("Config file: %lS\n", settingsFilePath.raw());
810 ComPtr<IVirtualBoxErrorInfo> accessError;
811 rc = machine->COMGETTER(AccessError) (accessError.asOutParam());
812 RTPrintf ("Access error details:\n");
813 ErrorInfo ei (accessError);
814 ei.print ("[-] ");
815 RTPrintf ("\n");
816 }
817 return S_OK;
818 }
819
820 Bstr machineName;
821 rc = machine->COMGETTER(Name)(machineName.asOutParam());
822 if (details == VMINFO_MACHINEREADABLE)
823 RTPrintf("name=\"%lS\"\n", machineName.raw());
824 else
825 RTPrintf("Name: %lS\n", machineName.raw());
826
827 Bstr osTypeId;
828 rc = machine->COMGETTER(OSTypeId)(osTypeId.asOutParam());
829 ComPtr<IGuestOSType> osType;
830 rc = virtualBox->GetGuestOSType (osTypeId, osType.asOutParam());
831 Bstr osName;
832 rc = osType->COMGETTER(Description)(osName.asOutParam());
833 if (details == VMINFO_MACHINEREADABLE)
834 RTPrintf("ostype=\"%lS\"\n", osTypeId.raw());
835 else
836 RTPrintf("Guest OS: %lS\n", osName.raw());
837
838 Guid uuid;
839 rc = machine->COMGETTER(Id)(uuid.asOutParam());
840 if (details == VMINFO_MACHINEREADABLE)
841 RTPrintf("UUID=\"%s\"\n", uuid.toString().raw());
842 else
843 RTPrintf("UUID: %s\n", uuid.toString().raw());
844
845 Bstr settingsFilePath;
846 rc = machine->COMGETTER(SettingsFilePath)(settingsFilePath.asOutParam());
847 if (details == VMINFO_MACHINEREADABLE)
848 RTPrintf("CfgFile=\"%lS\"\n", settingsFilePath.raw());
849 else
850 RTPrintf("Config file: %lS\n", settingsFilePath.raw());
851
852 ULONG memorySize;
853 rc = machine->COMGETTER(MemorySize)(&memorySize);
854 if (details == VMINFO_MACHINEREADABLE)
855 RTPrintf("memory=%u\n", memorySize);
856 else
857 RTPrintf("Memory size: %uMB\n", memorySize);
858
859 ULONG vramSize;
860 rc = machine->COMGETTER(VRAMSize)(&vramSize);
861 if (details == VMINFO_MACHINEREADABLE)
862 RTPrintf("vram=%u\n", vramSize);
863 else
864 RTPrintf("VRAM size: %uMB\n", vramSize);
865
866 ComPtr <IBIOSSettings> biosSettings;
867 machine->COMGETTER(BIOSSettings)(biosSettings.asOutParam());
868
869 BIOSBootMenuMode_T bootMenuMode;
870 biosSettings->COMGETTER(BootMenuMode)(&bootMenuMode);
871 const char *pszBootMenu = NULL;
872 switch (bootMenuMode)
873 {
874 case BIOSBootMenuMode_Disabled:
875 pszBootMenu = "disabled";
876 break;
877 case BIOSBootMenuMode_MenuOnly:
878 if (details == VMINFO_MACHINEREADABLE)
879 pszBootMenu = "menuonly";
880 else
881 pszBootMenu = "menu only";
882 break;
883 default:
884 if (details == VMINFO_MACHINEREADABLE)
885 pszBootMenu = "messageandmenu";
886 else
887 pszBootMenu = "message and menu";
888 }
889 if (details == VMINFO_MACHINEREADABLE)
890 RTPrintf("bootmenu=\"%s\"\n", pszBootMenu);
891 else
892 RTPrintf("Boot menu mode: %s\n", pszBootMenu);
893
894 BOOL acpiEnabled;
895 biosSettings->COMGETTER(ACPIEnabled)(&acpiEnabled);
896 if (details == VMINFO_MACHINEREADABLE)
897 RTPrintf("acpi=\"%s\"\n", acpiEnabled ? "on" : "off");
898 else
899 RTPrintf("ACPI: %s\n", acpiEnabled ? "on" : "off");
900
901 BOOL ioapicEnabled;
902 biosSettings->COMGETTER(IOAPICEnabled)(&ioapicEnabled);
903 if (details == VMINFO_MACHINEREADABLE)
904 RTPrintf("ioapic=\"%s\"\n", ioapicEnabled ? "on" : "off");
905 else
906 RTPrintf("IOAPIC: %s\n", ioapicEnabled ? "on" : "off");
907
908 LONG64 timeOffset;
909 biosSettings->COMGETTER(TimeOffset)(&timeOffset);
910 if (details == VMINFO_MACHINEREADABLE)
911 RTPrintf("biossystemtimeoffset=%lld\n", timeOffset);
912 else
913 RTPrintf("Time offset: %lld ms\n", timeOffset);
914
915 TSBool_T hwVirtExEnabled;
916 machine->COMGETTER(HWVirtExEnabled)(&hwVirtExEnabled);
917 if (hwVirtExEnabled == TSBool_Default)
918 {
919 BOOL fHWVirtExEnabled;
920 ComPtr<ISystemProperties> systemProperties;
921 virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
922 systemProperties->COMGETTER(HWVirtExEnabled)(&fHWVirtExEnabled);
923 if (details == VMINFO_MACHINEREADABLE)
924 RTPrintf("hwvirtex=\"default\"\n");
925 else
926 RTPrintf("Hardw. virt.ext: Default (%s)\n", fHWVirtExEnabled ? "on" : "off");
927 }
928 else
929 {
930 if (details == VMINFO_MACHINEREADABLE)
931 RTPrintf("hwvirtex=\"%s\"\n", hwVirtExEnabled == TSBool_True ? "on" : "off");
932 else
933 RTPrintf("Hardw. virt.ext: %s\n", hwVirtExEnabled == TSBool_True ? "on" : "off");
934 }
935
936 MachineState_T machineState;
937 const char *pszState = NULL;
938 rc = machine->COMGETTER(State)(&machineState);
939 switch (machineState)
940 {
941 case MachineState_PoweredOff:
942 if (details == VMINFO_MACHINEREADABLE)
943 pszState = "poweroff";
944 else
945 pszState = "powered off";
946 break;
947 case MachineState_Saved:
948 pszState = "saved";
949 break;
950 case MachineState_Aborted:
951 pszState = "aborted";
952 break;
953 case MachineState_Running:
954 pszState = "running";
955 break;
956 case MachineState_Paused:
957 pszState = "paused";
958 break;
959 case MachineState_Starting:
960 pszState = "starting";
961 break;
962 case MachineState_Stopping:
963 pszState = "stopping";
964 break;
965 case MachineState_Saving:
966 pszState = "saving";
967 break;
968 case MachineState_Restoring:
969 pszState = "restoring";
970 break;
971 default:
972 pszState = "unknown";
973 break;
974 }
975 LONG64 stateSince;
976 machine->COMGETTER(LastStateChange)(&stateSince);
977 RTTIMESPEC timeSpec;
978 RTTimeSpecSetMilli(&timeSpec, stateSince);
979 char pszTime[30] = {0};
980 RTTimeSpecToString(&timeSpec, pszTime, 30);
981 if (details == VMINFO_MACHINEREADABLE)
982 {
983 RTPrintf("VMState=\"%s\"\n", pszState);
984 RTPrintf("VMStateChangeTime=\"%s\"\n", pszTime);
985 }
986 else
987 RTPrintf("State: %s (since %s)\n", pszState, pszTime);
988
989 ULONG numMonitors;
990 machine->COMGETTER(MonitorCount)(&numMonitors);
991 if (details == VMINFO_MACHINEREADABLE)
992 RTPrintf("monitorcount=%d\n", numMonitors);
993 else
994 RTPrintf("Monitor count: %d\n", numMonitors);
995
996 ComPtr<IFloppyDrive> floppyDrive;
997 rc = machine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());
998 if (SUCCEEDED(rc) && floppyDrive)
999 {
1000 BOOL fFloppyEnabled;
1001 floppyDrive->COMGETTER(Enabled)(&fFloppyEnabled);
1002 Utf8Str pszFloppy = "invalid";
1003 if (fFloppyEnabled)
1004 {
1005 DriveState_T floppyState;
1006 floppyDrive->COMGETTER(State)(&floppyState);
1007 switch (floppyState)
1008 {
1009 case DriveState_ImageMounted:
1010 {
1011 ComPtr<IFloppyImage> floppyImage;
1012 rc = floppyDrive->GetImage(floppyImage.asOutParam());
1013 if (SUCCEEDED(rc) && floppyImage)
1014 {
1015 Bstr imagePath;
1016 floppyImage->COMGETTER(FilePath)(imagePath.asOutParam());
1017 Guid imageGuid;
1018 floppyImage->COMGETTER(Id)(imageGuid.asOutParam());
1019 if (details == VMINFO_MACHINEREADABLE)
1020 {
1021 RTPrintf("FloppyImageUUID=\"%s\"\n", imageGuid.toString().raw());
1022 pszFloppy = Utf8StrFmt("%lS", imagePath.raw());
1023 }
1024 else
1025 pszFloppy = Utf8StrFmt("%lS (UUID: %s)", imagePath.raw(), imageGuid.toString().raw());
1026 }
1027 break;
1028 }
1029
1030 case DriveState_HostDriveCaptured:
1031 {
1032 ComPtr<IHostFloppyDrive> hostFloppyDrive;
1033 rc = floppyDrive->GetHostDrive(hostFloppyDrive.asOutParam());
1034 if (SUCCEEDED(rc) && floppyDrive)
1035 {
1036 Bstr driveName;
1037 hostFloppyDrive->COMGETTER(Name)(driveName.asOutParam());
1038 if (details == VMINFO_MACHINEREADABLE)
1039 pszFloppy = Utf8StrFmt("host:%lS", driveName.raw());
1040 else
1041 pszFloppy = Utf8StrFmt("Host drive %lS", driveName.raw());
1042 }
1043 break;
1044 }
1045
1046 case DriveState_NotMounted:
1047 {
1048 pszFloppy = "empty";
1049 break;
1050 }
1051 }
1052 }
1053 else
1054 {
1055 pszFloppy = "disabled";
1056 }
1057 if (details == VMINFO_MACHINEREADABLE)
1058 RTPrintf("floppy=\"%s\"\n", pszFloppy.raw());
1059 else
1060 RTPrintf("Floppy: %s\n", pszFloppy.raw());
1061 }
1062
1063 ComPtr<IHardDisk> hardDisk;
1064 Bstr filePath;
1065 rc = machine->GetHardDisk(DiskControllerType_IDE0, 0, hardDisk.asOutParam());
1066 if (SUCCEEDED(rc) && hardDisk)
1067 {
1068 /// @todo (dmik) we temporarily use the location property to
1069 // determine the image file name. This is subject to change
1070 // when iSCSI disks are here (we should either query a
1071 // storage-specific interface from IHardDisk, or "standardize"
1072 // the location property)
1073 hardDisk->COMGETTER(Location)(filePath.asOutParam());
1074 hardDisk->COMGETTER(Id)(uuid.asOutParam());
1075 if (details == VMINFO_MACHINEREADABLE)
1076 {
1077 RTPrintf("hda=\"%lS\"\n", filePath.raw());
1078 RTPrintf("HdaImageUUID=\"%s\"\n", uuid.toString().raw());
1079 }
1080 else
1081 RTPrintf("Primary master: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw());
1082 }
1083 else
1084 {
1085 if (details == VMINFO_MACHINEREADABLE)
1086 RTPrintf("hda=\"none\"\n");
1087 }
1088 rc = machine->GetHardDisk(DiskControllerType_IDE0, 1, hardDisk.asOutParam());
1089 if (SUCCEEDED(rc) && hardDisk)
1090 {
1091 /// @todo (dmik) we temporarily use the location property to
1092 // determine the image file name. This is subject to change
1093 // when iSCSI disks are here (we should either query a
1094 // storage-specific interface from IHardDisk, or "standardize"
1095 // the location property)
1096 hardDisk->COMGETTER(Location)(filePath.asOutParam());
1097 hardDisk->COMGETTER(Id)(uuid.asOutParam());
1098 if (details == VMINFO_MACHINEREADABLE)
1099 {
1100 RTPrintf("hdb=\"%lS\"\n", filePath.raw());
1101 RTPrintf("HdbImageUUID=\"%s\"\n", uuid.toString().raw());
1102 }
1103 else
1104 RTPrintf("Primary slave: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw());
1105 }
1106 else
1107 {
1108 if (details == VMINFO_MACHINEREADABLE)
1109 RTPrintf("hdb=\"none\"\n");
1110 }
1111 rc = machine->GetHardDisk(DiskControllerType_IDE1, 1, hardDisk.asOutParam());
1112 if (SUCCEEDED(rc) && hardDisk)
1113 {
1114 /// @todo (dmik) we temporarily use the location property to
1115 // determine the image file name. This is subject to change
1116 // when iSCSI disks are here (we should either query a
1117 // storage-specific interface from IHardDisk, or "standardize"
1118 // the location property)
1119 hardDisk->COMGETTER(Location)(filePath.asOutParam());
1120 hardDisk->COMGETTER(Id)(uuid.asOutParam());
1121 if (details == VMINFO_MACHINEREADABLE)
1122 {
1123 RTPrintf("hdd=\"%lS\"\n", filePath.raw());
1124 RTPrintf("HddImageUUID=\"%s\"\n", uuid.toString().raw());
1125 }
1126 else
1127 RTPrintf("Secondary slave: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw());
1128 }
1129 else
1130 {
1131 if (details == VMINFO_MACHINEREADABLE)
1132 RTPrintf("hdd=\"none\"\n");
1133 }
1134 ComPtr<IDVDDrive> dvdDrive;
1135 rc = machine->COMGETTER(DVDDrive)(dvdDrive.asOutParam());
1136 if (SUCCEEDED(rc) && dvdDrive)
1137 {
1138 ComPtr<IDVDImage> dvdImage;
1139 rc = dvdDrive->GetImage(dvdImage.asOutParam());
1140 if (SUCCEEDED(rc) && dvdImage)
1141 {
1142 rc = dvdImage->COMGETTER(FilePath)(filePath.asOutParam());
1143 if (SUCCEEDED(rc) && filePath)
1144 {
1145 rc = dvdImage->COMGETTER(Id)(uuid.asOutParam());
1146 if (details == VMINFO_MACHINEREADABLE)
1147 {
1148 RTPrintf("dvd=\"%lS\"\n", filePath.raw());
1149 RTPrintf("DvdImageUUID=\"%s\"\n", uuid.toString().raw());
1150 }
1151 else
1152 RTPrintf("DVD: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw());
1153 }
1154 }
1155 else
1156 {
1157 ComPtr<IHostDVDDrive> hostDVDDrive;
1158 rc = dvdDrive->GetHostDrive(hostDVDDrive.asOutParam());
1159 if (SUCCEEDED(rc) && hostDVDDrive)
1160 {
1161 Bstr name;
1162 hostDVDDrive->COMGETTER(Name)(name.asOutParam());
1163 if (details == VMINFO_MACHINEREADABLE)
1164 RTPrintf("dvd=\"host:%lS\"\n", name.raw());
1165 else
1166 RTPrintf("DVD: Host drive %lS", name.raw());
1167 }
1168 else
1169 {
1170 if (details == VMINFO_MACHINEREADABLE)
1171 RTPrintf("dvd=\"none\"\n");
1172 else
1173 RTPrintf("DVD: empty");
1174 }
1175 BOOL fPassthrough;
1176 dvdDrive->COMGETTER(Passthrough)(&fPassthrough);
1177 if (details == VMINFO_MACHINEREADABLE)
1178 {
1179 RTPrintf("dvdpassthrough=\"%s\"\n", fPassthrough ? "on" : "off");
1180 }
1181 else
1182 {
1183 if (fPassthrough)
1184 RTPrintf(" (passthrough enabled)");
1185 RTPrintf("\n");
1186 }
1187 }
1188 }
1189
1190 /* get the maximum amount of NICS */
1191 ComPtr<ISystemProperties> sysProps;
1192 virtualBox->COMGETTER(SystemProperties)(sysProps.asOutParam());
1193 ULONG maxNICs = 0;
1194 sysProps->COMGETTER(NetworkAdapterCount)(&maxNICs);
1195 for (ULONG currentNIC = 0; currentNIC < maxNICs; currentNIC++)
1196 {
1197 ComPtr<INetworkAdapter> nic;
1198 rc = machine->GetNetworkAdapter(currentNIC, nic.asOutParam());
1199 if (SUCCEEDED(rc) && nic)
1200 {
1201 BOOL fEnabled;
1202 nic->COMGETTER(Enabled)(&fEnabled);
1203 if (!fEnabled)
1204 {
1205 if (details == VMINFO_MACHINEREADABLE)
1206 RTPrintf("nic%d=\"none\"\n", currentNIC + 1);
1207 else
1208 RTPrintf("NIC %d: disabled\n", currentNIC + 1);
1209 }
1210 else
1211 {
1212 Bstr strMACAddress;
1213 nic->COMGETTER(MACAddress)(strMACAddress.asOutParam());
1214 Utf8Str strAttachment;
1215 NetworkAttachmentType_T attachment;
1216 nic->COMGETTER(AttachmentType)(&attachment);
1217 switch (attachment)
1218 {
1219 case NetworkAttachmentType_Null:
1220 if (details == VMINFO_MACHINEREADABLE)
1221 strAttachment = "null";
1222 else
1223 strAttachment = "none";
1224 break;
1225 case NetworkAttachmentType_NAT:
1226 if (details == VMINFO_MACHINEREADABLE)
1227 strAttachment = "nat";
1228 else
1229 strAttachment = "NAT";
1230 break;
1231 case NetworkAttachmentType_HostInterface:
1232 {
1233 Bstr strHostIfDev;
1234 nic->COMGETTER(HostInterface)(strHostIfDev.asOutParam());
1235 if (details == VMINFO_MACHINEREADABLE)
1236 {
1237 RTPrintf("hostifdev%d=\"%lS\"\n", currentNIC + 1, strHostIfDev.raw());
1238 strAttachment = "hostif";
1239 }
1240 else
1241 strAttachment = Utf8StrFmt("Host Interface '%lS'", strHostIfDev.raw());
1242 break;
1243 }
1244 case NetworkAttachmentType_Internal:
1245 {
1246 Bstr strNetwork;
1247 nic->COMGETTER(InternalNetwork)(strNetwork.asOutParam());
1248 if (details == VMINFO_MACHINEREADABLE)
1249 {
1250 RTPrintf("intnet%d=\"%lS\"\n", currentNIC + 1, strNetwork.raw());
1251 strAttachment = "intnet";
1252 }
1253 else
1254 strAttachment = Utf8StrFmt("Internal Network '%s'", Utf8Str(strNetwork).raw());
1255 break;
1256 }
1257 default:
1258 strAttachment = "unknown";
1259 break;
1260 }
1261
1262 /* cable connected */
1263 BOOL fConnected;
1264 nic->COMGETTER(CableConnected)(&fConnected);
1265
1266 /* trace stuff */
1267 BOOL fTraceEnabled;
1268 nic->COMGETTER(TraceEnabled)(&fTraceEnabled);
1269 Bstr traceFile;
1270 nic->COMGETTER(TraceFile)(traceFile.asOutParam());
1271
1272 /* NIC type */
1273 Utf8Str strNICType;
1274 NetworkAdapterType_T NICType;
1275 nic->COMGETTER(AdapterType)(&NICType);
1276 switch (NICType) {
1277 case NetworkAdapterType_Am79C970A:
1278 strNICType = "Am79C970A";
1279 break;
1280 case NetworkAdapterType_Am79C973:
1281 strNICType = "Am79C973";
1282 break;
1283#ifdef VBOX_WITH_E1000
1284 case NetworkAdapterType_I82540EM:
1285 strNICType = "82540EM";
1286 break;
1287#endif
1288 default:
1289 strNICType = "unknown";
1290 break;
1291 }
1292
1293 /* reported line speed */
1294 ULONG ulLineSpeed;
1295 nic->COMGETTER(LineSpeed)(&ulLineSpeed);
1296
1297 if (details == VMINFO_MACHINEREADABLE)
1298 {
1299 RTPrintf("macaddress%d=\"%lS\"\n", currentNIC + 1, strMACAddress.raw());
1300 RTPrintf("cableconnected%d=\"%s\"\n", currentNIC + 1, fConnected ? "on" : "off");
1301 RTPrintf("nic%d=\"%s\"\n", currentNIC + 1, strAttachment.raw());
1302 }
1303 else
1304 RTPrintf("NIC %d: MAC: %lS, Attachment: %s, Cable connected: %s, Trace: %s (file: %lS), Type: %s, Reported speed: %d Mbps\n",
1305 currentNIC + 1, strMACAddress.raw(), strAttachment.raw(),
1306 fConnected ? "on" : "off",
1307 fTraceEnabled ? "on" : "off", traceFile.raw(),
1308 strNICType.raw(),
1309 ulLineSpeed / 1000);
1310 }
1311 }
1312 }
1313
1314 /* get the maximum amount of UARTs */
1315 ULONG maxUARTs = 0;
1316 sysProps->COMGETTER(SerialPortCount)(&maxUARTs);
1317 for (ULONG currentUART = 0; currentUART < maxUARTs; currentUART++)
1318 {
1319 ComPtr<ISerialPort> uart;
1320 rc = machine->GetSerialPort(currentUART, uart.asOutParam());
1321 if (SUCCEEDED(rc) && uart)
1322 {
1323 BOOL fEnabled;
1324 uart->COMGETTER(Enabled)(&fEnabled);
1325 if (!fEnabled)
1326 {
1327 if (details == VMINFO_MACHINEREADABLE)
1328 RTPrintf("uart%d=\"off\"\n", currentUART + 1);
1329 else
1330 RTPrintf("UART %d: disabled\n", currentUART + 1);
1331 }
1332 else
1333 {
1334 ULONG ulIRQ, ulIOBase;
1335 PortMode_T HostMode;
1336 Bstr path;
1337 BOOL fServer;
1338 uart->COMGETTER(IRQ)(&ulIRQ);
1339 uart->COMGETTER(IOBase)(&ulIOBase);
1340 uart->COMGETTER(Path)(path.asOutParam());
1341 uart->COMGETTER(Server)(&fServer);
1342 uart->COMGETTER(HostMode)(&HostMode);
1343
1344 if (details == VMINFO_MACHINEREADABLE)
1345 RTPrintf("uart%d=\"%#06x,%d\"\n", currentUART + 1,
1346 ulIOBase, ulIRQ);
1347 else
1348 RTPrintf("UART %d: I/O base: 0x%04x, IRQ: %d",
1349 currentUART + 1, ulIOBase, ulIRQ);
1350 switch (HostMode)
1351 {
1352 default:
1353 case PortMode_Disconnected:
1354 if (details == VMINFO_MACHINEREADABLE)
1355 RTPrintf("uartmode%d=\"disconnected\"\n", currentUART + 1);
1356 else
1357 RTPrintf(", disconnected\n");
1358 break;
1359 case PortMode_HostPipe:
1360 if (details == VMINFO_MACHINEREADABLE)
1361 RTPrintf("uartmode%d=\"%s,%lS\"\n", currentUART + 1,
1362 fServer ? "server" : "client", path.raw());
1363 else
1364 RTPrintf(", attached to pipe (%s) '%lS'\n",
1365 fServer ? "server" : "client", path.raw());
1366 break;
1367 case PortMode_HostDevice:
1368 if (details == VMINFO_MACHINEREADABLE)
1369 RTPrintf("uartmode%d=\"%lS\"\n", currentUART + 1,
1370 path.raw());
1371 else
1372 RTPrintf(", attached to device '%lS'\n", path.raw());
1373 break;
1374 }
1375 }
1376 }
1377 }
1378
1379 ComPtr<IAudioAdapter> AudioAdapter;
1380 rc = machine->COMGETTER(AudioAdapter)(AudioAdapter.asOutParam());
1381 if (SUCCEEDED(rc))
1382 {
1383 const char *pszDrv = "Unknown";
1384 const char *pszCtrl = "Unknown";
1385 BOOL fEnabled;
1386 rc = AudioAdapter->COMGETTER(Enabled)(&fEnabled);
1387 if (SUCCEEDED(rc) && fEnabled)
1388 {
1389 AudioDriverType_T enmDrvType;
1390 rc = AudioAdapter->COMGETTER(AudioDriver)(&enmDrvType);
1391 switch (enmDrvType)
1392 {
1393 case AudioDriverType_Null:
1394 if (details == VMINFO_MACHINEREADABLE)
1395 pszDrv = "null";
1396 else
1397 pszDrv = "Null";
1398 break;
1399 case AudioDriverType_WINMM:
1400 if (details == VMINFO_MACHINEREADABLE)
1401 pszDrv = "winmm";
1402 else
1403 pszDrv = "WINMM";
1404 break;
1405 case AudioDriverType_DSOUND:
1406 if (details == VMINFO_MACHINEREADABLE)
1407 pszDrv = "dsound";
1408 else
1409 pszDrv = "DSOUND";
1410 break;
1411 case AudioDriverType_OSS:
1412 if (details == VMINFO_MACHINEREADABLE)
1413 pszDrv = "oss";
1414 else
1415 pszDrv = "OSS";
1416 break;
1417 case AudioDriverType_ALSA:
1418 if (details == VMINFO_MACHINEREADABLE)
1419 pszDrv = "alsa";
1420 else
1421 pszDrv = "ALSA";
1422 break;
1423 case AudioDriverType_Pulse:
1424 if (details == VMINFO_MACHINEREADABLE)
1425 pszDrv = "pulse";
1426 else
1427 pszDrv = "PulseAudio";
1428 break;
1429 case AudioDriverType_Core:
1430 if (details == VMINFO_MACHINEREADABLE)
1431 pszDrv = "coreaudio";
1432 else
1433 pszDrv = "CoreAudio";
1434 break;
1435 default:
1436 if (details == VMINFO_MACHINEREADABLE)
1437 pszDrv = "unknown";
1438 break;
1439 }
1440 AudioControllerType_T enmCtrlType;
1441 rc = AudioAdapter->COMGETTER(AudioController)(&enmCtrlType);
1442 switch (enmCtrlType)
1443 {
1444 case AudioControllerType_AC97:
1445 if (details == VMINFO_MACHINEREADABLE)
1446 pszCtrl = "ac97";
1447 else
1448 pszCtrl = "AC97";
1449 break;
1450 case AudioControllerType_SB16:
1451 if (details == VMINFO_MACHINEREADABLE)
1452 pszCtrl = "sb16";
1453 else
1454 pszCtrl = "SB16";
1455 break;
1456 }
1457 }
1458 else
1459 fEnabled = FALSE;
1460 if (details == VMINFO_MACHINEREADABLE)
1461 {
1462 if (fEnabled)
1463 RTPrintf("audio=\"%s\"\n", pszDrv);
1464 else
1465 RTPrintf("audio=\"none\"\n");
1466 }
1467 else
1468 RTPrintf("Audio: %s (Driver: %s, Controller: %s)\n",
1469 fEnabled ? "enabled" : "disabled", pszDrv, pszCtrl);
1470 }
1471
1472 /* Shared clipboard */
1473 {
1474 const char *psz = "Unknown";
1475 ClipboardMode_T enmMode;
1476 rc = machine->COMGETTER(ClipboardMode)(&enmMode);
1477 switch (enmMode)
1478 {
1479 case ClipboardMode_Disabled:
1480 if (details == VMINFO_MACHINEREADABLE)
1481 psz = "disabled";
1482 else
1483 psz = "disabled";
1484 break;
1485 case ClipboardMode_HostToGuest:
1486 if (details == VMINFO_MACHINEREADABLE)
1487 psz = "hosttoguest";
1488 else
1489 psz = "HostToGuest";
1490 break;
1491 case ClipboardMode_GuestToHost:
1492 if (details == VMINFO_MACHINEREADABLE)
1493 psz = "guesttohost";
1494 else
1495 psz = "GuestToHost";
1496 break;
1497 case ClipboardMode_Bidirectional:
1498 if (details == VMINFO_MACHINEREADABLE)
1499 psz = "bidirectional";
1500 else
1501 psz = "Bidirectional";
1502 break;
1503 default:
1504 if (details == VMINFO_MACHINEREADABLE)
1505 psz = "unknown";
1506 break;
1507 }
1508 if (details == VMINFO_MACHINEREADABLE)
1509 RTPrintf("clipboard=\"%s\"\n", psz);
1510 else
1511 RTPrintf("Clipboard Mode: %s\n", psz);
1512 }
1513
1514 if (console)
1515 {
1516 ComPtr<IDisplay> display;
1517 CHECK_ERROR_RET(console, COMGETTER(Display)(display.asOutParam()), rc);
1518 ULONG xRes, yRes, bpp;
1519 CHECK_ERROR_RET(display, COMGETTER(Width)(&xRes), rc);
1520 CHECK_ERROR_RET(display, COMGETTER(Height)(&yRes), rc);
1521 CHECK_ERROR_RET(display, COMGETTER(BitsPerPixel)(&bpp), rc);
1522 if (details == VMINFO_MACHINEREADABLE)
1523 RTPrintf("VideoMode=\"%d,%d,%d\"\n", xRes, yRes, bpp);
1524 else
1525 RTPrintf("Video mode: %dx%dx%d\n", xRes, yRes, bpp);
1526 }
1527
1528 /*
1529 * VRDP
1530 */
1531 ComPtr<IVRDPServer> vrdpServer;
1532 rc = machine->COMGETTER(VRDPServer)(vrdpServer.asOutParam());
1533 if (SUCCEEDED(rc) && vrdpServer)
1534 {
1535 BOOL fEnabled = false;
1536 vrdpServer->COMGETTER(Enabled)(&fEnabled);
1537 if (fEnabled)
1538 {
1539 ULONG port;
1540 vrdpServer->COMGETTER(Port)(&port);
1541 Bstr address;
1542 vrdpServer->COMGETTER(NetAddress)(address.asOutParam());
1543 BOOL fMultiCon;
1544 vrdpServer->COMGETTER(AllowMultiConnection)(&fMultiCon);
1545 VRDPAuthType_T vrdpAuthType;
1546 const char *strAuthType;
1547 vrdpServer->COMGETTER(AuthType)(&vrdpAuthType);
1548 switch (vrdpAuthType)
1549 {
1550 case VRDPAuthType_Null:
1551 strAuthType = "null";
1552 break;
1553 case VRDPAuthType_External:
1554 strAuthType = "external";
1555 break;
1556 case VRDPAuthType_Guest:
1557 strAuthType = "guest";
1558 break;
1559 default:
1560 strAuthType = "unknown";
1561 break;
1562 }
1563 if (details == VMINFO_MACHINEREADABLE)
1564 {
1565 RTPrintf("vrdp=\"on\"\n");
1566 RTPrintf("vrdpport=%d\n", port);
1567 RTPrintf("vrdpaddress=\"%lS\"\n", address.raw());
1568 RTPrintf("vrdpauthtype=\"%s\"\n", strAuthType);
1569 RTPrintf("vrdpmulticon=\"%s\"\n", fMultiCon ? "on" : "off");
1570 }
1571 else
1572 {
1573 if (address.isEmpty())
1574 address = "0.0.0.0";
1575 RTPrintf("VRDP: enabled (Address %lS, Port %d, MultiConn: %s, Authentication type: %s)\n", address.raw(), port, fMultiCon ? "on" : "off", strAuthType);
1576 }
1577 }
1578 else
1579 {
1580 if (details == VMINFO_MACHINEREADABLE)
1581 RTPrintf("vrdp=\"off\"\n");
1582 else
1583 RTPrintf("VRDP: disabled\n");
1584 }
1585 }
1586
1587 /*
1588 * USB.
1589 */
1590 ComPtr<IUSBController> USBCtl;
1591 rc = machine->COMGETTER(USBController)(USBCtl.asOutParam());
1592 if (SUCCEEDED(rc))
1593 {
1594 BOOL fEnabled;
1595 rc = USBCtl->COMGETTER(Enabled)(&fEnabled);
1596 if (FAILED(rc))
1597 fEnabled = false;
1598 if (details == VMINFO_MACHINEREADABLE)
1599 RTPrintf("usb=\"%s\"\n", fEnabled ? "on" : "off");
1600 else
1601 RTPrintf("USB: %s\n", fEnabled ? "enabled" : "disabled");
1602
1603 if (details != VMINFO_MACHINEREADABLE)
1604 RTPrintf("\nUSB Device Filters:\n\n");
1605
1606 ComPtr<IUSBDeviceFilterCollection> Coll;
1607 CHECK_ERROR_RET (USBCtl, COMGETTER(DeviceFilters)(Coll.asOutParam()), rc);
1608
1609 ComPtr<IUSBDeviceFilterEnumerator> Enum;
1610 CHECK_ERROR_RET (Coll, Enumerate(Enum.asOutParam()), rc);
1611
1612 ULONG index = 0;
1613 BOOL fMore = FALSE;
1614 rc = Enum->HasMore (&fMore);
1615 ASSERT_RET (SUCCEEDED (rc), rc);
1616
1617 if (!fMore)
1618 {
1619 if (details != VMINFO_MACHINEREADABLE)
1620 RTPrintf("<none>\n\n");
1621 }
1622 else
1623 while (fMore)
1624 {
1625 ComPtr<IUSBDeviceFilter> DevPtr;
1626 rc = Enum->GetNext(DevPtr.asOutParam());
1627 ASSERT_RET (SUCCEEDED (rc), rc);
1628
1629 /* Query info. */
1630
1631 if (details != VMINFO_MACHINEREADABLE)
1632 RTPrintf("Index: %lu\n", index);
1633
1634 BOOL bActive = FALSE;
1635 CHECK_ERROR_RET (DevPtr, COMGETTER (Active) (&bActive), rc);
1636 if (details == VMINFO_MACHINEREADABLE)
1637 RTPrintf("USBFilterActive%d=\"%s\"\n", index + 1, bActive ? "on" : "off");
1638 else
1639 RTPrintf("Active: %s\n", bActive ? "yes" : "no");
1640
1641 Bstr bstr;
1642 CHECK_ERROR_RET (DevPtr, COMGETTER (Name) (bstr.asOutParam()), rc);
1643 if (details == VMINFO_MACHINEREADABLE)
1644 RTPrintf("USBFilterName%d=\"%lS\"\n", index + 1, bstr.raw());
1645 else
1646 RTPrintf("Name: %lS\n", bstr.raw());
1647 CHECK_ERROR_RET (DevPtr, COMGETTER (VendorId) (bstr.asOutParam()), rc);
1648 if (details == VMINFO_MACHINEREADABLE)
1649 RTPrintf("USBFilterVendorId%d=\"%lS\"\n", index + 1, bstr.raw());
1650 else
1651 RTPrintf("VendorId: %lS\n", bstr.raw());
1652 CHECK_ERROR_RET (DevPtr, COMGETTER (ProductId) (bstr.asOutParam()), rc);
1653 if (details == VMINFO_MACHINEREADABLE)
1654 RTPrintf("USBFilterProductId%d=\"%lS\"\n", index + 1, bstr.raw());
1655 else
1656 RTPrintf("ProductId: %lS\n", bstr.raw());
1657 CHECK_ERROR_RET (DevPtr, COMGETTER (Revision) (bstr.asOutParam()), rc);
1658 if (details == VMINFO_MACHINEREADABLE)
1659 RTPrintf("USBFilterRevision%d=\"%lS\"\n", index + 1, bstr.raw());
1660 else
1661 RTPrintf("Revision: %lS\n", bstr.raw());
1662 CHECK_ERROR_RET (DevPtr, COMGETTER (Manufacturer) (bstr.asOutParam()), rc);
1663 if (details == VMINFO_MACHINEREADABLE)
1664 RTPrintf("USBFilterManufacturer%d=\"%lS\"\n", index + 1, bstr.raw());
1665 else
1666 RTPrintf("Manufacturer: %lS\n", bstr.raw());
1667 CHECK_ERROR_RET (DevPtr, COMGETTER (Product) (bstr.asOutParam()), rc);
1668 if (details == VMINFO_MACHINEREADABLE)
1669 RTPrintf("USBFilterProduct%d=\"%lS\"\n", index + 1, bstr.raw());
1670 else
1671 RTPrintf("Product: %lS\n", bstr.raw());
1672 CHECK_ERROR_RET (DevPtr, COMGETTER (Remote) (bstr.asOutParam()), rc);
1673 if (details == VMINFO_MACHINEREADABLE)
1674 RTPrintf("USBFilterRemote%d=\"%lS\"\n", index + 1, bstr.raw());
1675 else
1676 RTPrintf("Remote: %lS\n", bstr.raw());
1677 CHECK_ERROR_RET (DevPtr, COMGETTER (SerialNumber) (bstr.asOutParam()), rc);
1678 if (details == VMINFO_MACHINEREADABLE)
1679 RTPrintf("USBFilterSerialNumber%d=\"%lS\"\n", index + 1, bstr.raw());
1680 else
1681 RTPrintf("Serial Number: %lS\n", bstr.raw());
1682 if (details != VMINFO_MACHINEREADABLE)
1683 {
1684 ULONG fMaskedIfs;
1685 CHECK_ERROR_RET (DevPtr, COMGETTER (MaskedInterfaces) (&fMaskedIfs), rc);
1686 if (fMaskedIfs)
1687 RTPrintf("Masked Interfaces: 0x%08x\n", fMaskedIfs);
1688 RTPrintf("\n");
1689 }
1690
1691 rc = Enum->HasMore (&fMore);
1692 ASSERT_RET (SUCCEEDED (rc), rc);
1693
1694 index ++;
1695 }
1696
1697 if (console)
1698 {
1699 index = 0;
1700 /* scope */
1701 {
1702 if (details != VMINFO_MACHINEREADABLE)
1703 RTPrintf("Available remote USB devices:\n\n");
1704
1705 ComPtr<IHostUSBDeviceCollection> coll;
1706 CHECK_ERROR_RET (console, COMGETTER(RemoteUSBDevices) (coll.asOutParam()), rc);
1707
1708 ComPtr <IHostUSBDeviceEnumerator> en;
1709 CHECK_ERROR_RET (coll, Enumerate (en.asOutParam()), rc);
1710
1711 BOOL more = FALSE;
1712 rc = en->HasMore (&more);
1713 ASSERT_RET (SUCCEEDED (rc), rc);
1714
1715 if (!more)
1716 {
1717 if (details != VMINFO_MACHINEREADABLE)
1718 RTPrintf("<none>\n\n");
1719 }
1720 else
1721 while (more)
1722 {
1723 ComPtr <IHostUSBDevice> dev;
1724 rc = en->GetNext (dev.asOutParam());
1725 ASSERT_RET (SUCCEEDED (rc), rc);
1726
1727 /* Query info. */
1728 Guid id;
1729 CHECK_ERROR_RET (dev, COMGETTER(Id)(id.asOutParam()), rc);
1730 USHORT usVendorId;
1731 CHECK_ERROR_RET (dev, COMGETTER(VendorId)(&usVendorId), rc);
1732 USHORT usProductId;
1733 CHECK_ERROR_RET (dev, COMGETTER(ProductId)(&usProductId), rc);
1734 USHORT bcdRevision;
1735 CHECK_ERROR_RET (dev, COMGETTER(Revision)(&bcdRevision), rc);
1736
1737 if (details == VMINFO_MACHINEREADABLE)
1738 RTPrintf("USBRemoteUUID%d=\"%S\"\n"
1739 "USBRemoteVendorId%d=\"%#06x\"\n"
1740 "USBRemoteProductId%d=\"%#06x\"\n"
1741 "USBRemoteRevision%d=\"%#04x%02x\"\n",
1742 index + 1, id.toString().raw(),
1743 index + 1, usVendorId,
1744 index + 1, usProductId,
1745 index + 1, bcdRevision >> 8, bcdRevision & 0xff);
1746 else
1747 RTPrintf("UUID: %S\n"
1748 "VendorId: 0x%04x (%04X)\n"
1749 "ProductId: 0x%04x (%04X)\n"
1750 "Revision: %u.%u (%02u%02u)\n",
1751 id.toString().raw(),
1752 usVendorId, usVendorId, usProductId, usProductId,
1753 bcdRevision >> 8, bcdRevision & 0xff,
1754 bcdRevision >> 8, bcdRevision & 0xff);
1755
1756 /* optional stuff. */
1757 Bstr bstr;
1758 CHECK_ERROR_RET (dev, COMGETTER(Manufacturer)(bstr.asOutParam()), rc);
1759 if (!bstr.isEmpty())
1760 {
1761 if (details == VMINFO_MACHINEREADABLE)
1762 RTPrintf("USBRemoteManufacturer%d=\"%lS\"\n", index + 1, bstr.raw());
1763 else
1764 RTPrintf("Manufacturer: %lS\n", bstr.raw());
1765 }
1766 CHECK_ERROR_RET (dev, COMGETTER(Product)(bstr.asOutParam()), rc);
1767 if (!bstr.isEmpty())
1768 {
1769 if (details == VMINFO_MACHINEREADABLE)
1770 RTPrintf("USBRemoteProduct%d=\"%lS\"\n", index + 1, bstr.raw());
1771 else
1772 RTPrintf("Product: %lS\n", bstr.raw());
1773 }
1774 CHECK_ERROR_RET (dev, COMGETTER(SerialNumber)(bstr.asOutParam()), rc);
1775 if (!bstr.isEmpty())
1776 {
1777 if (details == VMINFO_MACHINEREADABLE)
1778 RTPrintf("USBRemoteSerialNumber%d=\"%lS\"\n", index + 1, bstr.raw());
1779 else
1780 RTPrintf("SerialNumber: %lS\n", bstr.raw());
1781 }
1782 CHECK_ERROR_RET (dev, COMGETTER(Address)(bstr.asOutParam()), rc);
1783 if (!bstr.isEmpty())
1784 {
1785 if (details == VMINFO_MACHINEREADABLE)
1786 RTPrintf("USBRemoteAddress%d=\"%lS\"\n", index + 1, bstr.raw());
1787 else
1788 RTPrintf("Address: %lS\n", bstr.raw());
1789 }
1790
1791 if (details != VMINFO_MACHINEREADABLE)
1792 RTPrintf("\n");
1793
1794 rc = en->HasMore (&more);
1795 ASSERT_RET (SUCCEEDED (rc), rc);
1796
1797 index ++;
1798 }
1799 }
1800
1801 index = 0;
1802 /* scope */
1803 {
1804 if (details != VMINFO_MACHINEREADABLE)
1805 RTPrintf ("Currently Attached USB Devices:\n\n");
1806
1807 ComPtr <IUSBDeviceCollection> coll;
1808 CHECK_ERROR_RET (console, COMGETTER(USBDevices) (coll.asOutParam()), rc);
1809
1810 ComPtr <IUSBDeviceEnumerator> en;
1811 CHECK_ERROR_RET (coll, Enumerate (en.asOutParam()), rc);
1812
1813 BOOL more = FALSE;
1814 rc = en->HasMore (&more);
1815 ASSERT_RET (SUCCEEDED (rc), rc);
1816
1817 if (!more)
1818 {
1819 if (details != VMINFO_MACHINEREADABLE)
1820 RTPrintf("<none>\n\n");
1821 }
1822 else
1823 while (more)
1824 {
1825 ComPtr <IUSBDevice> dev;
1826 rc = en->GetNext (dev.asOutParam());
1827 ASSERT_RET (SUCCEEDED (rc), rc);
1828
1829 /* Query info. */
1830 Guid id;
1831 CHECK_ERROR_RET (dev, COMGETTER(Id)(id.asOutParam()), rc);
1832 USHORT usVendorId;
1833 CHECK_ERROR_RET (dev, COMGETTER(VendorId)(&usVendorId), rc);
1834 USHORT usProductId;
1835 CHECK_ERROR_RET (dev, COMGETTER(ProductId)(&usProductId), rc);
1836 USHORT bcdRevision;
1837 CHECK_ERROR_RET (dev, COMGETTER(Revision)(&bcdRevision), rc);
1838
1839 if (details == VMINFO_MACHINEREADABLE)
1840 RTPrintf("USBAttachedUUID%d=\"%S\"\n"
1841 "USBAttachedVendorId%d=\"%#06x\"\n"
1842 "USBAttachedProductId%d=\"%#06x\"\n"
1843 "USBAttachedRevision%d=\"%#04x%02x\"\n",
1844 index + 1, id.toString().raw(),
1845 index + 1, usVendorId,
1846 index + 1, usProductId,
1847 index + 1, bcdRevision >> 8, bcdRevision & 0xff);
1848 else
1849 RTPrintf("UUID: %S\n"
1850 "VendorId: 0x%04x (%04X)\n"
1851 "ProductId: 0x%04x (%04X)\n"
1852 "Revision: %u.%u (%02u%02u)\n",
1853 id.toString().raw(),
1854 usVendorId, usVendorId, usProductId, usProductId,
1855 bcdRevision >> 8, bcdRevision & 0xff,
1856 bcdRevision >> 8, bcdRevision & 0xff);
1857
1858 /* optional stuff. */
1859 Bstr bstr;
1860 CHECK_ERROR_RET (dev, COMGETTER(Manufacturer)(bstr.asOutParam()), rc);
1861 if (!bstr.isEmpty())
1862 {
1863 if (details == VMINFO_MACHINEREADABLE)
1864 RTPrintf("USBAttachedManufacturer%d=\"%lS\"\n", index + 1, bstr.raw());
1865 else
1866 RTPrintf("Manufacturer: %lS\n", bstr.raw());
1867 }
1868 CHECK_ERROR_RET (dev, COMGETTER(Product)(bstr.asOutParam()), rc);
1869 if (!bstr.isEmpty())
1870 {
1871 if (details == VMINFO_MACHINEREADABLE)
1872 RTPrintf("USBAttachedProduct%d=\"%lS\"\n", index + 1, bstr.raw());
1873 else
1874 RTPrintf("Product: %lS\n", bstr.raw());
1875 }
1876 CHECK_ERROR_RET (dev, COMGETTER(SerialNumber)(bstr.asOutParam()), rc);
1877 if (!bstr.isEmpty())
1878 {
1879 if (details == VMINFO_MACHINEREADABLE)
1880 RTPrintf("USBAttachedSerialNumber%d=\"%lS\"\n", index + 1, bstr.raw());
1881 else
1882 RTPrintf("SerialNumber: %lS\n", bstr.raw());
1883 }
1884 CHECK_ERROR_RET (dev, COMGETTER(Address)(bstr.asOutParam()), rc);
1885 if (!bstr.isEmpty())
1886 {
1887 if (details == VMINFO_MACHINEREADABLE)
1888 RTPrintf("USBAttachedAddress%d=\"%lS\"\n", index + 1, bstr.raw());
1889 else
1890 RTPrintf("Address: %lS\n", bstr.raw());
1891 }
1892
1893 if (details != VMINFO_MACHINEREADABLE)
1894 RTPrintf("\n");
1895
1896 rc = en->HasMore (&more);
1897 ASSERT_RET (SUCCEEDED (rc), rc);
1898
1899 index ++;
1900 }
1901 }
1902 }
1903 } /* USB */
1904
1905 /*
1906 * Shared folders
1907 */
1908 if (details != VMINFO_MACHINEREADABLE)
1909 RTPrintf("Shared folders: ");
1910 uint32_t numSharedFolders = 0;
1911#if 0 // not yet implemented
1912 /* globally shared folders first */
1913 {
1914 ComPtr<ISharedFolderCollection> sfColl;
1915 ComPtr<ISharedFolderEnumerator> sfEnum;
1916 CHECK_ERROR_RET(virtualBox, COMGETTER(SharedFolders)(sfColl.asOutParam()), rc);
1917 CHECK_ERROR_RET(sfColl, Enumerate(sfEnum.asOutParam()), rc);
1918 BOOL fMore;
1919 sfEnum->HasMore(&fMore);
1920 while (fMore)
1921 {
1922 ComPtr<ISharedFolder> sf;
1923 CHECK_ERROR_RET(sfEnum, GetNext(sf.asOutParam()), rc);
1924 Bstr name, hostPath;
1925 sf->COMGETTER(Name)(name.asOutParam());
1926 sf->COMGETTER(HostPath)(hostPath.asOutParam());
1927 RTPrintf("Name: '%lS', Host path: '%lS' (global mapping)\n", name.raw(), hostPath.raw());
1928 ++numSharedFolders;
1929 CHECK_ERROR_RET(sfEnum, HasMore(&fMore), rc);
1930 }
1931 }
1932#endif
1933 /* now VM mappings */
1934 {
1935 ComPtr<ISharedFolderCollection> sfColl;
1936 ComPtr<ISharedFolderEnumerator> sfEnum;
1937 CHECK_ERROR_RET(machine, COMGETTER(SharedFolders)(sfColl.asOutParam()), rc);
1938 CHECK_ERROR_RET(sfColl, Enumerate(sfEnum.asOutParam()), rc);
1939 ULONG index = 0;
1940 BOOL fMore;
1941 sfEnum->HasMore(&fMore);
1942 while (fMore)
1943 {
1944 ComPtr<ISharedFolder> sf;
1945 CHECK_ERROR_RET(sfEnum, GetNext(sf.asOutParam()), rc);
1946 Bstr name, hostPath;
1947 BOOL writable;
1948 sf->COMGETTER(Name)(name.asOutParam());
1949 sf->COMGETTER(HostPath)(hostPath.asOutParam());
1950 sf->COMGETTER(Writable)(&writable);
1951 if (!numSharedFolders && details != VMINFO_MACHINEREADABLE)
1952 RTPrintf("\n\n");
1953 if (details == VMINFO_MACHINEREADABLE)
1954 {
1955 RTPrintf("SharedFolderNameMachineMapping%d=\"%lS\"\n", index + 1,
1956 name.raw());
1957 RTPrintf("SharedFolderPathMachineMapping%d=\"%lS\"\n", index + 1,
1958 hostPath.raw());
1959 }
1960 else
1961 RTPrintf("Name: '%lS', Host path: '%lS' (machine mapping), %s\n",
1962 name.raw(), hostPath.raw(), writable ? "writable" : "readonly");
1963 ++numSharedFolders;
1964 CHECK_ERROR_RET(sfEnum, HasMore(&fMore), rc);
1965 }
1966 }
1967 /* transient mappings */
1968 if (console)
1969 {
1970 ComPtr<ISharedFolderCollection> sfColl;
1971 ComPtr<ISharedFolderEnumerator> sfEnum;
1972 CHECK_ERROR_RET(console, COMGETTER(SharedFolders)(sfColl.asOutParam()), rc);
1973 CHECK_ERROR_RET(sfColl, Enumerate(sfEnum.asOutParam()), rc);
1974 ULONG index = 0;
1975 BOOL fMore;
1976 sfEnum->HasMore(&fMore);
1977 while (fMore)
1978 {
1979 ComPtr<ISharedFolder> sf;
1980 CHECK_ERROR_RET(sfEnum, GetNext(sf.asOutParam()), rc);
1981 Bstr name, hostPath;
1982 sf->COMGETTER(Name)(name.asOutParam());
1983 sf->COMGETTER(HostPath)(hostPath.asOutParam());
1984 if (!numSharedFolders && details != VMINFO_MACHINEREADABLE)
1985 RTPrintf("\n\n");
1986 if (details == VMINFO_MACHINEREADABLE)
1987 {
1988 RTPrintf("SharedFolderNameTransientMapping%d=\"%lS\"\n", index + 1,
1989 name.raw());
1990 RTPrintf("SharedFolderPathTransientMapping%d=\"%lS\"\n", index + 1,
1991 hostPath.raw());
1992 }
1993 else
1994 RTPrintf("Name: '%lS', Host path: '%lS' (transient mapping)\n", name.raw(), hostPath.raw());
1995 ++numSharedFolders;
1996 CHECK_ERROR_RET(sfEnum, HasMore(&fMore), rc);
1997 }
1998 }
1999 if (!numSharedFolders && details != VMINFO_MACHINEREADABLE)
2000 RTPrintf("<none>\n");
2001 if (details != VMINFO_MACHINEREADABLE)
2002 RTPrintf("\n");
2003
2004 if (console)
2005 {
2006 /*
2007 * Live VRDP info.
2008 */
2009 ComPtr<IRemoteDisplayInfo> remoteDisplayInfo;
2010 CHECK_ERROR_RET(console, COMGETTER(RemoteDisplayInfo)(remoteDisplayInfo.asOutParam()), rc);
2011 BOOL Active;
2012 ULONG NumberOfClients;
2013 LONG64 BeginTime;
2014 LONG64 EndTime;
2015 ULONG64 BytesSent;
2016 ULONG64 BytesSentTotal;
2017 ULONG64 BytesReceived;
2018 ULONG64 BytesReceivedTotal;
2019 Bstr User;
2020 Bstr Domain;
2021 Bstr ClientName;
2022 Bstr ClientIP;
2023 ULONG ClientVersion;
2024 ULONG EncryptionStyle;
2025
2026 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(Active) (&Active), rc);
2027 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(NumberOfClients) (&NumberOfClients), rc);
2028 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BeginTime) (&BeginTime), rc);
2029 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(EndTime) (&EndTime), rc);
2030 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesSent) (&BytesSent), rc);
2031 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesSentTotal) (&BytesSentTotal), rc);
2032 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesReceived) (&BytesReceived), rc);
2033 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesReceivedTotal) (&BytesReceivedTotal), rc);
2034 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(User) (User.asOutParam ()), rc);
2035 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(Domain) (Domain.asOutParam ()), rc);
2036 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(ClientName) (ClientName.asOutParam ()), rc);
2037 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(ClientIP) (ClientIP.asOutParam ()), rc);
2038 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(ClientVersion) (&ClientVersion), rc);
2039 CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(EncryptionStyle) (&EncryptionStyle), rc);
2040
2041 if (details == VMINFO_MACHINEREADABLE)
2042 RTPrintf("VRDPActiveConnection=\"%s\"\n", Active ? "on": "off");
2043 else
2044 RTPrintf("VRDP Connection: %s\n", Active? "active": "not active");
2045
2046 if (details == VMINFO_MACHINEREADABLE)
2047 RTPrintf("VRDPClients=%d\n", NumberOfClients);
2048 else
2049 RTPrintf("Clients so far: %d\n", NumberOfClients);
2050
2051 if (NumberOfClients > 0)
2052 {
2053 char timestr[128];
2054
2055 if (Active)
2056 {
2057 makeTimeStr (timestr, sizeof (timestr), BeginTime);
2058 if (details == VMINFO_MACHINEREADABLE)
2059 RTPrintf("VRDPStartTime=\"%s\"\n", timestr);
2060 else
2061 RTPrintf("Start time: %s\n", timestr);
2062 }
2063 else
2064 {
2065 makeTimeStr (timestr, sizeof (timestr), BeginTime);
2066 if (details == VMINFO_MACHINEREADABLE)
2067 RTPrintf("VRDPLastStartTime=\"%s\"\n", timestr);
2068 else
2069 RTPrintf("Last started: %s\n", timestr);
2070 makeTimeStr (timestr, sizeof (timestr), EndTime);
2071 if (details == VMINFO_MACHINEREADABLE)
2072 RTPrintf("VRDPLastEndTime=\"%s\"\n", timestr);
2073 else
2074 RTPrintf("Last ended: %s\n", timestr);
2075 }
2076
2077 if (details == VMINFO_MACHINEREADABLE)
2078 {
2079 RTPrintf("VRDPBytesSent=%llu\n", BytesSent);
2080 RTPrintf("VRDPThroughputSend=%llu\n", (BytesSent * 1000) / (EndTime - BeginTime) );
2081 RTPrintf("VRDPBytesSentTotal=%llu\n", BytesSentTotal);
2082
2083 RTPrintf("VRDPBytesReceived=%llu\n", BytesReceived);
2084 RTPrintf("VRDPThroughputReceive=%llu\n", (BytesReceived * 1000) / (EndTime - BeginTime) );
2085 RTPrintf("VRDPBytesReceivedTotal=%llu\n", BytesReceivedTotal);
2086 }
2087 else
2088 {
2089 RTPrintf("Sent: %llu Bytes\n", BytesSent);
2090 RTPrintf("Average speed: %llu B/s\n", (BytesSent * 1000) / (EndTime - BeginTime) );
2091 RTPrintf("Sent total: %llu Bytes\n", BytesSentTotal);
2092
2093 RTPrintf("Received: %llu Bytes\n", BytesReceived);
2094 RTPrintf("Speed: %llu B/s\n", (BytesReceived * 1000) / (EndTime - BeginTime) );
2095 RTPrintf("Received total: %llu Bytes\n", BytesReceivedTotal);
2096 }
2097
2098 if (Active)
2099 {
2100 if (details == VMINFO_MACHINEREADABLE)
2101 {
2102 RTPrintf("VRDPUserName=\"%lS\"\n", User.raw());
2103 RTPrintf("VRDPDomain=\"%lS\"\n", Domain.raw());
2104 RTPrintf("VRDPClientName=\"%lS\"\n", ClientName.raw());
2105 RTPrintf("VRDPClientIP=\"%lS\"\n", ClientIP.raw());
2106 RTPrintf("VRDPClientVersion=%d\n", ClientVersion);
2107 RTPrintf("VRDPEncryption=\"%s\"\n", EncryptionStyle == 0? "RDP4": "RDP5 (X.509)");
2108 }
2109 else
2110 {
2111 RTPrintf("User name: %lS\n", User.raw());
2112 RTPrintf("Domain: %lS\n", Domain.raw());
2113 RTPrintf("Client name: %lS\n", ClientName.raw());
2114 RTPrintf("Client IP: %lS\n", ClientIP.raw());
2115 RTPrintf("Client version: %d\n", ClientVersion);
2116 RTPrintf("Encryption: %s\n", EncryptionStyle == 0? "RDP4": "RDP5 (X.509)");
2117 }
2118 }
2119 }
2120
2121 if (details != VMINFO_MACHINEREADABLE)
2122 RTPrintf("\n");
2123 }
2124
2125 if ( details == VMINFO_STANDARD
2126 || details == VMINFO_FULL
2127 || details == VMINFO_MACHINEREADABLE)
2128 {
2129 Bstr description;
2130 machine->COMGETTER(Description)(description.asOutParam());
2131 if (!description.isEmpty())
2132 {
2133 if (details == VMINFO_MACHINEREADABLE)
2134 RTPrintf("description=\"%lS\"\n", description.raw());
2135 else
2136 RTPrintf("Description:\n%lS\n", description.raw());
2137 }
2138 }
2139
2140 ULONG guestVal;
2141 if (details != VMINFO_MACHINEREADABLE)
2142 RTPrintf("Guest:\n\n");
2143
2144 rc = machine->COMGETTER(MemoryBalloonSize)(&guestVal);
2145 if (SUCCEEDED(rc))
2146 {
2147 if (details == VMINFO_MACHINEREADABLE)
2148 RTPrintf("GuestMemoryBalloon=%d\n", guestVal);
2149 else
2150 RTPrintf("Configured memory balloon size: %d MB\n", guestVal);
2151 }
2152
2153 rc = machine->COMGETTER(StatisticsUpdateInterval)(&guestVal);
2154 if (SUCCEEDED(rc))
2155 {
2156 if (details == VMINFO_MACHINEREADABLE)
2157 RTPrintf("GuestStatisticsUpdateInterval=%d\n", guestVal);
2158 else
2159 {
2160 if (guestVal == 0)
2161 RTPrintf("Statistics update: disabled\n");
2162 else
2163 RTPrintf("Statistics update interval: %d seconds\n", guestVal);
2164 }
2165 }
2166 if (details != VMINFO_MACHINEREADABLE)
2167 RTPrintf("\n");
2168
2169 if ( console
2170 && ( details == VMINFO_STATISTICS
2171 || details == VMINFO_FULL
2172 || details == VMINFO_MACHINEREADABLE))
2173 {
2174 ComPtr <IGuest> guest;
2175
2176 rc = console->COMGETTER(Guest)(guest.asOutParam());
2177 if (SUCCEEDED(rc))
2178 {
2179 ULONG statVal;
2180
2181 rc = guest->GetStatistic(0, GuestStatisticType_SampleNumber, &statVal);
2182 if (details == VMINFO_MACHINEREADABLE)
2183 RTPrintf("StatGuestSample=%d\n", statVal);
2184 else
2185 RTPrintf("Guest statistics for sample %d:\n\n", statVal);
2186
2187 rc = guest->GetStatistic(0, GuestStatisticType_CPULoad_Idle, &statVal);
2188 if (SUCCEEDED(rc))
2189 {
2190 if (details == VMINFO_MACHINEREADABLE)
2191 RTPrintf("StatGuestLoadIdleCPU%d=%d\n", 0, statVal);
2192 else
2193 RTPrintf("CPU%d: CPU Load Idle %-3d%%\n", 0, statVal);
2194 }
2195
2196 rc = guest->GetStatistic(0, GuestStatisticType_CPULoad_Kernel, &statVal);
2197 if (SUCCEEDED(rc))
2198 {
2199 if (details == VMINFO_MACHINEREADABLE)
2200 RTPrintf("StatGuestLoadKernelCPU%d=%d\n", 0, statVal);
2201 else
2202 RTPrintf("CPU%d: CPU Load Kernel %-3d%%\n", 0, statVal);
2203 }
2204
2205 rc = guest->GetStatistic(0, GuestStatisticType_CPULoad_User, &statVal);
2206 if (SUCCEEDED(rc))
2207 {
2208 if (details == VMINFO_MACHINEREADABLE)
2209 RTPrintf("StatGuestLoadUserCPU%d=%d\n", 0, statVal);
2210 else
2211 RTPrintf("CPU%d: CPU Load User %-3d%%\n", 0, statVal);
2212 }
2213
2214 rc = guest->GetStatistic(0, GuestStatisticType_Threads, &statVal);
2215 if (SUCCEEDED(rc))
2216 {
2217 if (details == VMINFO_MACHINEREADABLE)
2218 RTPrintf("StatGuestThreadsCPU%d=%d\n", 0, statVal);
2219 else
2220 RTPrintf("CPU%d: Threads %d\n", 0, statVal);
2221 }
2222
2223 rc = guest->GetStatistic(0, GuestStatisticType_Processes, &statVal);
2224 if (SUCCEEDED(rc))
2225 {
2226 if (details == VMINFO_MACHINEREADABLE)
2227 RTPrintf("StatGuestProcessesCPU%d=%d\n", 0, statVal);
2228 else
2229 RTPrintf("CPU%d: Processes %d\n", 0, statVal);
2230 }
2231
2232 rc = guest->GetStatistic(0, GuestStatisticType_Handles, &statVal);
2233 if (SUCCEEDED(rc))
2234 {
2235 if (details == VMINFO_MACHINEREADABLE)
2236 RTPrintf("StatGuestHandlesCPU%d=%d\n", 0, statVal);
2237 else
2238 RTPrintf("CPU%d: Handles %d\n", 0, statVal);
2239 }
2240
2241 rc = guest->GetStatistic(0, GuestStatisticType_MemoryLoad, &statVal);
2242 if (SUCCEEDED(rc))
2243 {
2244 if (details == VMINFO_MACHINEREADABLE)
2245 RTPrintf("StatGuestMemoryLoadCPU%d=%d\n", 0, statVal);
2246 else
2247 RTPrintf("CPU%d: Memory Load %d%%\n", 0, statVal);
2248 }
2249
2250 rc = guest->GetStatistic(0, GuestStatisticType_PhysMemTotal, &statVal);
2251 if (SUCCEEDED(rc))
2252 {
2253 if (details == VMINFO_MACHINEREADABLE)
2254 RTPrintf("StatGuestMemoryTotalPhysCPU%d=%d\n", 0, statVal);
2255 else
2256 RTPrintf("CPU%d: Total physical memory %-4d MB\n", 0, statVal);
2257 }
2258
2259 rc = guest->GetStatistic(0, GuestStatisticType_PhysMemAvailable, &statVal);
2260 if (SUCCEEDED(rc))
2261 {
2262 if (details == VMINFO_MACHINEREADABLE)
2263 RTPrintf("StatGuestMemoryFreePhysCPU%d=%d\n", 0, statVal);
2264 else
2265 RTPrintf("CPU%d: Free physical memory %-4d MB\n", 0, statVal);
2266 }
2267
2268 rc = guest->GetStatistic(0, GuestStatisticType_PhysMemBalloon, &statVal);
2269 if (SUCCEEDED(rc))
2270 {
2271 if (details == VMINFO_MACHINEREADABLE)
2272 RTPrintf("StatGuestMemoryBalloonCPU%d=%d\n", 0, statVal);
2273 else
2274 RTPrintf("CPU%d: Memory balloon size %-4d MB\n", 0, statVal);
2275 }
2276
2277 rc = guest->GetStatistic(0, GuestStatisticType_MemCommitTotal, &statVal);
2278 if (SUCCEEDED(rc))
2279 {
2280 if (details == VMINFO_MACHINEREADABLE)
2281 RTPrintf("StatGuestMemoryCommittedCPU%d=%d\n", 0, statVal);
2282 else
2283 RTPrintf("CPU%d: Committed memory %-4d MB\n", 0, statVal);
2284 }
2285
2286 rc = guest->GetStatistic(0, GuestStatisticType_MemKernelTotal, &statVal);
2287 if (SUCCEEDED(rc))
2288 {
2289 if (details == VMINFO_MACHINEREADABLE)
2290 RTPrintf("StatGuestMemoryTotalKernelCPU%d=%d\n", 0, statVal);
2291 else
2292 RTPrintf("CPU%d: Total kernel memory %-4d MB\n", 0, statVal);
2293 }
2294
2295 rc = guest->GetStatistic(0, GuestStatisticType_MemKernelPaged, &statVal);
2296 if (SUCCEEDED(rc))
2297 {
2298 if (details == VMINFO_MACHINEREADABLE)
2299 RTPrintf("StatGuestMemoryPagedKernelCPU%d=%d\n", 0, statVal);
2300 else
2301 RTPrintf("CPU%d: Paged kernel memory %-4d MB\n", 0, statVal);
2302 }
2303
2304 rc = guest->GetStatistic(0, GuestStatisticType_MemKernelNonpaged, &statVal);
2305 if (SUCCEEDED(rc))
2306 {
2307 if (details == VMINFO_MACHINEREADABLE)
2308 RTPrintf("StatGuestMemoryNonpagedKernelCPU%d=%d\n", 0, statVal);
2309 else
2310 RTPrintf("CPU%d: Nonpaged kernel memory %-4d MB\n", 0, statVal);
2311 }
2312
2313 rc = guest->GetStatistic(0, GuestStatisticType_MemSystemCache, &statVal);
2314 if (SUCCEEDED(rc))
2315 {
2316 if (details == VMINFO_MACHINEREADABLE)
2317 RTPrintf("StatGuestSystemCacheSizeCPU%d=%d\n", 0, statVal);
2318 else
2319 RTPrintf("CPU%d: System cache size %-4d MB\n", 0, statVal);
2320 }
2321
2322 rc = guest->GetStatistic(0, GuestStatisticType_PageFileSize, &statVal);
2323 if (SUCCEEDED(rc))
2324 {
2325 if (details == VMINFO_MACHINEREADABLE)
2326 RTPrintf("StatGuestPageFileSizeCPU%d=%d\n", 0, statVal);
2327 else
2328 RTPrintf("CPU%d: Page file size %-4d MB\n", 0, statVal);
2329 }
2330
2331 RTPrintf("\n");
2332 }
2333 else
2334 {
2335 if (details != VMINFO_MACHINEREADABLE)
2336 {
2337 RTPrintf("[!] FAILED calling console->getGuest at line %d!\n", __LINE__);
2338 PRINT_RC_MESSAGE(rc);
2339 }
2340 }
2341 }
2342
2343 /*
2344 * snapshots
2345 */
2346 ComPtr<ISnapshot> snapshot;
2347 rc = machine->GetSnapshot(Guid(), snapshot.asOutParam());
2348 if (SUCCEEDED(rc) && snapshot)
2349 {
2350 if (details != VMINFO_MACHINEREADABLE)
2351 RTPrintf("Snapshots:\n\n");
2352 showSnapshots(snapshot, details);
2353 }
2354
2355 if (details != VMINFO_MACHINEREADABLE)
2356 RTPrintf("\n");
2357 return S_OK;
2358}
2359
2360static int handleShowVMInfo(int argc, char *argv[],
2361 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
2362{
2363 HRESULT rc;
2364
2365 /* at least one option: the UUID or name of the VM */
2366 if (argc < 1)
2367 {
2368 return errorSyntax(USAGE_SHOWVMINFO, "Incorrect number of parameters");
2369 }
2370
2371 /* try to find the given machine */
2372 ComPtr <IMachine> machine;
2373 Guid uuid (argv[0]);
2374 if (!uuid.isEmpty())
2375 {
2376 CHECK_ERROR (virtualBox, GetMachine (uuid, machine.asOutParam()));
2377 }
2378 else
2379 {
2380 CHECK_ERROR (virtualBox, FindMachine (Bstr(argv[0]), machine.asOutParam()));
2381 if (SUCCEEDED (rc))
2382 machine->COMGETTER(Id) (uuid.asOutParam());
2383 }
2384 if (FAILED (rc))
2385 return 1;
2386
2387 /* 2nd option can be -details, -statistics or -argdump */
2388 VMINFO_DETAILS details = VMINFO_NONE;
2389 bool fDetails = false;
2390 bool fStatistics = false;
2391 bool fMachinereadable = false;
2392 for (int i=1;i<argc;i++)
2393 {
2394 if (!strcmp(argv[i], "-details"))
2395 fDetails = true;
2396 else
2397 if (!strcmp(argv[i], "-statistics"))
2398 fStatistics = true;
2399 if (!strcmp(argv[1], "-machinereadable"))
2400 fMachinereadable = true;
2401 }
2402 if (fMachinereadable)
2403 details = VMINFO_MACHINEREADABLE;
2404 else
2405 if (fDetails && fStatistics)
2406 details = VMINFO_FULL;
2407 else
2408 if (fDetails)
2409 details = VMINFO_STANDARD;
2410 else
2411 if (fStatistics)
2412 details = VMINFO_STATISTICS;
2413
2414 ComPtr <IConsole> console;
2415
2416 /* open an existing session for the VM */
2417 rc = virtualBox->OpenExistingSession (session, uuid);
2418 if (SUCCEEDED(rc))
2419 /* get the session machine */
2420 rc = session->COMGETTER(Machine)(machine.asOutParam());
2421 if (SUCCEEDED(rc))
2422 /* get the session console */
2423 rc = session->COMGETTER(Console)(console.asOutParam());
2424
2425 rc = showVMInfo (virtualBox, machine, console, details);
2426
2427 if (console)
2428 session->Close();
2429
2430 return SUCCEEDED (rc) ? 0 : 1;
2431}
2432
2433
2434static int handleList(int argc, char *argv[],
2435 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
2436{
2437 HRESULT rc = S_OK;
2438
2439 /* exactly one option: the object */
2440 if (argc != 1)
2441 {
2442 return errorSyntax(USAGE_LIST, "Incorrect number of parameters");
2443 }
2444
2445 /* which object? */
2446 if (strcmp(argv[0], "vms") == 0)
2447 {
2448 /*
2449 * Get the list of all registered VMs
2450 */
2451 ComPtr<IMachineCollection> collection;
2452 rc = virtualBox->COMGETTER(Machines)(collection.asOutParam());
2453 ComPtr<IMachineEnumerator> enumerator;
2454 if (SUCCEEDED(rc))
2455 rc = collection->Enumerate(enumerator.asOutParam());
2456 if (SUCCEEDED(rc))
2457 {
2458 /*
2459 * Iterate through the collection
2460 */
2461 BOOL hasMore = FALSE;
2462 while (enumerator->HasMore(&hasMore), hasMore)
2463 {
2464 ComPtr<IMachine> machine;
2465 rc = enumerator->GetNext(machine.asOutParam());
2466 if ((SUCCEEDED(rc)) && machine)
2467 {
2468 rc = showVMInfo(virtualBox, machine);
2469 }
2470 }
2471 }
2472 }
2473 else
2474 if (strcmp(argv[0], "runningvms") == 0)
2475 {
2476 /*
2477 * Get the list of all _running_ VMs
2478 */
2479 ComPtr<IMachineCollection> collection;
2480 rc = virtualBox->COMGETTER(Machines)(collection.asOutParam());
2481 ComPtr<IMachineEnumerator> enumerator;
2482 if (SUCCEEDED(rc))
2483 rc = collection->Enumerate(enumerator.asOutParam());
2484 if (SUCCEEDED(rc))
2485 {
2486 /*
2487 * Iterate through the collection
2488 */
2489 BOOL hasMore = FALSE;
2490 while (enumerator->HasMore(&hasMore), hasMore)
2491 {
2492 ComPtr<IMachine> machine;
2493 rc = enumerator->GetNext(machine.asOutParam());
2494 if ((SUCCEEDED(rc)) && machine)
2495 {
2496 MachineState_T machineState;
2497 rc = machine->COMGETTER(State)(&machineState);
2498 if (SUCCEEDED(rc))
2499 {
2500 switch (machineState)
2501 {
2502 case MachineState_Running:
2503 case MachineState_Paused:
2504 {
2505 Guid uuid;
2506 rc = machine->COMGETTER(Id) (uuid.asOutParam());
2507 if (SUCCEEDED(rc))
2508 RTPrintf ("%s\n", uuid.toString().raw());
2509 break;
2510 }
2511 }
2512 }
2513 }
2514 }
2515 }
2516 }
2517 else
2518 if (strcmp(argv[0], "ostypes") == 0)
2519 {
2520 ComPtr<IGuestOSTypeCollection> coll;
2521 ComPtr<IGuestOSTypeEnumerator> enumerator;
2522 CHECK_ERROR(virtualBox, COMGETTER(GuestOSTypes)(coll.asOutParam()));
2523 if (SUCCEEDED(rc) && coll)
2524 {
2525 CHECK_ERROR(coll, Enumerate(enumerator.asOutParam()));
2526 BOOL hasMore;
2527 while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore)
2528 {
2529 ComPtr<IGuestOSType> guestOS;
2530 CHECK_RC_BREAK(enumerator->GetNext(guestOS.asOutParam()));
2531 Bstr guestId;
2532 guestOS->COMGETTER(Id)(guestId.asOutParam());
2533 RTPrintf("ID: %lS\n", guestId.raw());
2534 Bstr guestDescription;
2535 guestOS->COMGETTER(Description)(guestDescription.asOutParam());
2536 RTPrintf("Description: %lS\n\n", guestDescription.raw());
2537 }
2538 }
2539 }
2540 else
2541 if (strcmp(argv[0], "hostdvds") == 0)
2542 {
2543 ComPtr<IHost> host;
2544 CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam()));
2545 ComPtr<IHostDVDDriveCollection> coll;
2546 ComPtr<IHostDVDDriveEnumerator> enumerator;
2547 CHECK_ERROR(host, COMGETTER(DVDDrives)(coll.asOutParam()));
2548 if (SUCCEEDED(rc) && coll)
2549 {
2550 CHECK_ERROR(coll, Enumerate(enumerator.asOutParam()));
2551 BOOL hasMore;
2552 while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore)
2553 {
2554 ComPtr<IHostDVDDrive> dvdDrive;
2555 CHECK_RC_BREAK(enumerator->GetNext(dvdDrive.asOutParam()));
2556 Bstr name;
2557 dvdDrive->COMGETTER(Name)(name.asOutParam());
2558 RTPrintf("Name: %lS\n\n", name.raw());
2559 }
2560 }
2561 }
2562 else
2563 if (strcmp(argv[0], "hostfloppies") == 0)
2564 {
2565 ComPtr<IHost> host;
2566 CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam()));
2567 ComPtr<IHostFloppyDriveCollection> coll;
2568 ComPtr<IHostFloppyDriveEnumerator> enumerator;
2569 CHECK_ERROR(host, COMGETTER(FloppyDrives)(coll.asOutParam()));
2570 if (SUCCEEDED(rc) && coll)
2571 {
2572 CHECK_ERROR(coll, Enumerate(enumerator.asOutParam()));
2573 BOOL hasMore;
2574 while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore)
2575 {
2576 ComPtr<IHostFloppyDrive> floppyDrive;
2577 CHECK_RC_BREAK(enumerator->GetNext(floppyDrive.asOutParam()));
2578 Bstr name;
2579 floppyDrive->COMGETTER(Name)(name.asOutParam());
2580 RTPrintf("Name: %lS\n\n", name.raw());
2581 }
2582 }
2583 }
2584#ifdef RT_OS_WINDOWS
2585 else
2586 if (strcmp(argv[0], "hostifs") == 0)
2587 {
2588 ComPtr<IHost> host;
2589 CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam()));
2590 ComPtr<IHostNetworkInterfaceCollection> coll;
2591 ComPtr<IHostNetworkInterfaceEnumerator> enumerator;
2592 CHECK_ERROR(host, COMGETTER(NetworkInterfaces)(coll.asOutParam()));
2593 if (SUCCEEDED(rc) && coll)
2594 {
2595 CHECK_ERROR(coll, Enumerate(enumerator.asOutParam()));
2596 BOOL hasMore;
2597 while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore)
2598 {
2599 ComPtr<IHostNetworkInterface> networkInterface;
2600 CHECK_RC_BREAK(enumerator->GetNext(networkInterface.asOutParam()));
2601 Bstr interfaceName;
2602 networkInterface->COMGETTER(Name)(interfaceName.asOutParam());
2603 RTPrintf("Name: %lS\n", interfaceName.raw());
2604 Guid interfaceGuid;
2605 networkInterface->COMGETTER(Id)(interfaceGuid.asOutParam());
2606 RTPrintf("GUID: %lS\n\n", Bstr(interfaceGuid.toString()));
2607 }
2608 }
2609 }
2610#endif /* RT_OS_WINDOWS */
2611 else
2612 if (strcmp(argv[0], "hdds") == 0)
2613 {
2614 ComPtr<IHardDiskCollection> hddColl;
2615 CHECK_ERROR(virtualBox, COMGETTER(HardDisks)(hddColl.asOutParam()));
2616 ComPtr<IHardDiskEnumerator> enumerator;
2617 CHECK_ERROR(hddColl, Enumerate(enumerator.asOutParam()));
2618 BOOL hasMore;
2619 while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore)
2620 {
2621 ComPtr<IHardDisk> hdd;
2622 CHECK_RC_BREAK(enumerator->GetNext(hdd.asOutParam()));
2623 Guid uuid;
2624 hdd->COMGETTER(Id)(uuid.asOutParam());
2625 RTPrintf("UUID: %s\n", uuid.toString().raw());
2626 HardDiskStorageType_T storageType;
2627 hdd->COMGETTER(StorageType)(&storageType);
2628 const char *storageTypeString = "unknown";
2629 switch (storageType)
2630 {
2631 case HardDiskStorageType_VirtualDiskImage:
2632 storageTypeString = "Virtual Disk Image";
2633 break;
2634 case HardDiskStorageType_ISCSIHardDisk:
2635 storageTypeString = "iSCSI hard disk";
2636 break;
2637 }
2638 RTPrintf("Storage type: %s\n", storageTypeString);
2639 Bstr filepath;
2640 /// @todo (dmik) we temporarily use the location property to
2641 // determine the image file name. This is subject to change
2642 // when iSCSI disks are here (we should either query a
2643 // storage-specific interface from IHardDisk, or "standardize"
2644 // the location property)
2645 hdd->COMGETTER(Location)(filepath.asOutParam());
2646 RTPrintf("Path: %lS\n", filepath.raw());
2647 BOOL fAccessible;
2648 hdd->COMGETTER(AllAccessible)(&fAccessible);
2649 RTPrintf("Accessible: %s\n", fAccessible ? "yes" : "no");
2650 Guid machineUUID;
2651 hdd->COMGETTER(MachineId)(machineUUID.asOutParam());
2652 if (!machineUUID.isEmpty())
2653 {
2654 ComPtr<IMachine> machine;
2655 CHECK_ERROR(virtualBox, GetMachine(machineUUID, machine.asOutParam()));
2656 ASSERT(machine);
2657 Bstr name;
2658 machine->COMGETTER(Name)(name.asOutParam());
2659 machine->COMGETTER(Id)(uuid.asOutParam());
2660 RTPrintf("Usage: %lS (UUID: %s)\n", name.raw(), uuid.toString().raw());
2661 }
2662 RTPrintf("\n");
2663 }
2664 }
2665 else
2666 if (strcmp(argv[0], "dvds") == 0)
2667 {
2668 ComPtr<IDVDImageCollection> dvdColl;
2669 CHECK_ERROR(virtualBox, COMGETTER(DVDImages)(dvdColl.asOutParam()));
2670 ComPtr<IDVDImageEnumerator> enumerator;
2671 CHECK_ERROR(dvdColl, Enumerate(enumerator.asOutParam()));
2672 BOOL hasMore;
2673 while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore)
2674 {
2675 ComPtr<IDVDImage> dvdImage;
2676 CHECK_RC_BREAK(enumerator->GetNext(dvdImage.asOutParam()));
2677 Guid uuid;
2678 dvdImage->COMGETTER(Id)(uuid.asOutParam());
2679 RTPrintf("UUID: %s\n", uuid.toString().raw());
2680 Bstr filePath;
2681 dvdImage->COMGETTER(FilePath)(filePath.asOutParam());
2682 RTPrintf("Path: %lS\n", filePath.raw());
2683 BOOL fAccessible;
2684 dvdImage->COMGETTER(Accessible)(&fAccessible);
2685 RTPrintf("Accessible: %s\n", fAccessible ? "yes" : "no");
2686 Bstr machineUUIDs;
2687 CHECK_ERROR(virtualBox, GetDVDImageUsage(uuid, ResourceUsage_All, machineUUIDs.asOutParam()));
2688 /** @todo usage */
2689 RTPrintf("\n");
2690 }
2691 }
2692 else
2693 if (strcmp(argv[0], "floppies") == 0)
2694 {
2695 ComPtr<IFloppyImageCollection> floppyColl;
2696 CHECK_ERROR(virtualBox, COMGETTER(FloppyImages)(floppyColl.asOutParam()));
2697 ComPtr<IFloppyImageEnumerator> enumerator;
2698 CHECK_ERROR(floppyColl, Enumerate(enumerator.asOutParam()));
2699 BOOL hasMore;
2700 while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore)
2701 {
2702 ComPtr<IFloppyImage> floppyImage;
2703 CHECK_RC_BREAK(enumerator->GetNext(floppyImage.asOutParam()));
2704 Guid uuid;
2705 floppyImage->COMGETTER(Id)(uuid.asOutParam());
2706 RTPrintf("UUID: %s\n", uuid.toString().raw());
2707 Bstr filePath;
2708 floppyImage->COMGETTER(FilePath)(filePath.asOutParam());
2709 RTPrintf("Path: %lS\n", filePath.raw());
2710 BOOL fAccessible;
2711 floppyImage->COMGETTER(Accessible)(&fAccessible);
2712 RTPrintf("Accessible: %s\n", fAccessible ? "yes" : "no");
2713 Bstr machineUUIDs;
2714 CHECK_ERROR(virtualBox, GetFloppyImageUsage(uuid, ResourceUsage_All, machineUUIDs.asOutParam()));
2715 /** @todo usage */
2716 RTPrintf("\n");
2717 }
2718 }
2719 else
2720 if (strcmp(argv[0], "usbhost") == 0)
2721 {
2722 ComPtr<IHost> Host;
2723 CHECK_ERROR_RET (virtualBox, COMGETTER(Host)(Host.asOutParam()), 1);
2724
2725 ComPtr<IHostUSBDeviceCollection> CollPtr;
2726 CHECK_ERROR_RET (Host, COMGETTER(USBDevices)(CollPtr.asOutParam()), 1);
2727
2728 ComPtr<IHostUSBDeviceEnumerator> EnumPtr;
2729 CHECK_ERROR_RET (CollPtr, Enumerate(EnumPtr.asOutParam()), 1);
2730
2731 RTPrintf("Host USB Devices:\n\n");
2732
2733 BOOL fMore = FALSE;
2734 rc = EnumPtr->HasMore (&fMore);
2735 ASSERT_RET (SUCCEEDED (rc), 1);
2736
2737 if (!fMore)
2738 {
2739 RTPrintf("<none>\n\n");
2740 }
2741 else
2742 while (fMore)
2743 {
2744 ComPtr <IHostUSBDevice> dev;
2745 rc = EnumPtr->GetNext (dev.asOutParam());
2746 ASSERT_RET (SUCCEEDED (rc), 1);
2747
2748 /* Query info. */
2749 Guid id;
2750 CHECK_ERROR_RET (dev, COMGETTER(Id)(id.asOutParam()), 1);
2751 USHORT usVendorId;
2752 CHECK_ERROR_RET (dev, COMGETTER(VendorId)(&usVendorId), 1);
2753 USHORT usProductId;
2754 CHECK_ERROR_RET (dev, COMGETTER(ProductId)(&usProductId), 1);
2755 USHORT bcdRevision;
2756 CHECK_ERROR_RET (dev, COMGETTER(Revision)(&bcdRevision), 1);
2757
2758 RTPrintf("UUID: %S\n"
2759 "VendorId: 0x%04x (%04X)\n"
2760 "ProductId: 0x%04x (%04X)\n"
2761 "Revision: %u.%u (%02u%02u)\n",
2762 id.toString().raw(),
2763 usVendorId, usVendorId, usProductId, usProductId,
2764 bcdRevision >> 8, bcdRevision & 0xff,
2765 bcdRevision >> 8, bcdRevision & 0xff);
2766
2767 /* optional stuff. */
2768 Bstr bstr;
2769 CHECK_ERROR_RET (dev, COMGETTER(Manufacturer)(bstr.asOutParam()), 1);
2770 if (!bstr.isEmpty())
2771 RTPrintf("Manufacturer: %lS\n", bstr.raw());
2772 CHECK_ERROR_RET (dev, COMGETTER(Product)(bstr.asOutParam()), 1);
2773 if (!bstr.isEmpty())
2774 RTPrintf("Product: %lS\n", bstr.raw());
2775 CHECK_ERROR_RET (dev, COMGETTER(SerialNumber)(bstr.asOutParam()), 1);
2776 if (!bstr.isEmpty())
2777 RTPrintf("SerialNumber: %lS\n", bstr.raw());
2778 CHECK_ERROR_RET (dev, COMGETTER(Address)(bstr.asOutParam()), 1);
2779 if (!bstr.isEmpty())
2780 RTPrintf("Address: %lS\n", bstr.raw());
2781
2782 /* current state */
2783 USBDeviceState_T state;
2784 CHECK_ERROR_RET (dev, COMGETTER(State)(&state), 1);
2785 const char *pszState = "?";
2786 switch (state)
2787 {
2788 case USBDeviceState_NotSupported:
2789 pszState = "Not supported"; break;
2790 case USBDeviceState_Unavailable:
2791 pszState = "Unavailable"; break;
2792 case USBDeviceState_Busy:
2793 pszState = "Busy"; break;
2794 case USBDeviceState_Available:
2795 pszState = "Available"; break;
2796 case USBDeviceState_Held:
2797 pszState = "Held"; break;
2798 case USBDeviceState_Captured:
2799 pszState = "Captured"; break;
2800 default:
2801 ASSERT (false);
2802 break;
2803 }
2804 RTPrintf("Current State: %s\n\n", pszState);
2805
2806 rc = EnumPtr->HasMore (&fMore);
2807 ASSERT_RET (SUCCEEDED (rc), rc);
2808 }
2809 }
2810 else
2811 if (strcmp(argv[0], "usbfilters") == 0)
2812 {
2813 RTPrintf("Global USB Device Filters:\n\n");
2814
2815 ComPtr <IHost> host;
2816 CHECK_ERROR_RET (virtualBox, COMGETTER(Host) (host.asOutParam()), 1);
2817
2818 ComPtr<IHostUSBDeviceFilterCollection> coll;
2819 CHECK_ERROR_RET (host, COMGETTER (USBDeviceFilters)(coll.asOutParam()), 1);
2820
2821 ComPtr<IHostUSBDeviceFilterEnumerator> en;
2822 CHECK_ERROR_RET (coll, Enumerate(en.asOutParam()), 1);
2823
2824 ULONG index = 0;
2825 BOOL more = FALSE;
2826 rc = en->HasMore (&more);
2827 ASSERT_RET (SUCCEEDED (rc), 1);
2828
2829 if (!more)
2830 {
2831 RTPrintf("<none>\n\n");
2832 }
2833 else
2834 while (more)
2835 {
2836 ComPtr<IHostUSBDeviceFilter> flt;
2837 rc = en->GetNext (flt.asOutParam());
2838 ASSERT_RET (SUCCEEDED (rc), 1);
2839
2840 /* Query info. */
2841
2842 RTPrintf("Index: %lu\n", index);
2843
2844 BOOL active = FALSE;
2845 CHECK_ERROR_RET (flt, COMGETTER (Active) (&active), 1);
2846 RTPrintf("Active: %s\n", active ? "yes" : "no");
2847
2848 USBDeviceFilterAction_T action;
2849 CHECK_ERROR_RET (flt, COMGETTER (Action) (&action), 1);
2850 const char *pszAction = "<invalid>";
2851 switch (action)
2852 {
2853 case USBDeviceFilterAction_Ignore:
2854 pszAction = "Ignore";
2855 break;
2856 case USBDeviceFilterAction_Hold:
2857 pszAction = "Hold";
2858 break;
2859 default:
2860 break;
2861 }
2862 RTPrintf("Action: %s\n", pszAction);
2863
2864 Bstr bstr;
2865 CHECK_ERROR_RET (flt, COMGETTER (Name) (bstr.asOutParam()), 1);
2866 RTPrintf("Name: %lS\n", bstr.raw());
2867 CHECK_ERROR_RET (flt, COMGETTER (VendorId) (bstr.asOutParam()), 1);
2868 RTPrintf("VendorId: %lS\n", bstr.raw());
2869 CHECK_ERROR_RET (flt, COMGETTER (ProductId) (bstr.asOutParam()), 1);
2870 RTPrintf("ProductId: %lS\n", bstr.raw());
2871 CHECK_ERROR_RET (flt, COMGETTER (Revision) (bstr.asOutParam()), 1);
2872 RTPrintf("Revision: %lS\n", bstr.raw());
2873 CHECK_ERROR_RET (flt, COMGETTER (Manufacturer) (bstr.asOutParam()), 1);
2874 RTPrintf("Manufacturer: %lS\n", bstr.raw());
2875 CHECK_ERROR_RET (flt, COMGETTER (Product) (bstr.asOutParam()), 1);
2876 RTPrintf("Product: %lS\n", bstr.raw());
2877 CHECK_ERROR_RET (flt, COMGETTER (SerialNumber) (bstr.asOutParam()), 1);
2878 RTPrintf("Serial Number: %lS\n\n", bstr.raw());
2879
2880 rc = en->HasMore (&more);
2881 ASSERT_RET (SUCCEEDED (rc), 1);
2882
2883 index ++;
2884 }
2885 }
2886 else if (strcmp(argv[0], "systemproperties") == 0)
2887 {
2888 ComPtr<ISystemProperties> systemProperties;
2889 virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
2890
2891 Bstr str;
2892 ULONG ulValue;
2893 ULONG64 ul64Value;
2894 BOOL flag;
2895
2896 systemProperties->COMGETTER(MinGuestRAM)(&ulValue);
2897 RTPrintf("Minimum guest RAM size: %u Megabytes\n", ulValue);
2898 systemProperties->COMGETTER(MaxGuestRAM)(&ulValue);
2899 RTPrintf("Maximum guest RAM size: %u Megabytes\n", ulValue);
2900 systemProperties->COMGETTER(MaxGuestVRAM)(&ulValue);
2901 RTPrintf("Maximum video RAM size: %u Megabytes\n", ulValue);
2902 systemProperties->COMGETTER(MaxVDISize)(&ul64Value);
2903 RTPrintf("Maximum VDI size: %lu Megabytes\n", ul64Value);
2904 systemProperties->COMGETTER(DefaultVDIFolder)(str.asOutParam());
2905 RTPrintf("Default VDI filder: %lS\n", str.raw());
2906 systemProperties->COMGETTER(DefaultMachineFolder)(str.asOutParam());
2907 RTPrintf("Default machine folder: %lS\n", str.raw());
2908 systemProperties->COMGETTER(RemoteDisplayAuthLibrary)(str.asOutParam());
2909 RTPrintf("VRDP authentication library: %lS\n", str.raw());
2910 systemProperties->COMGETTER(WebServiceAuthLibrary)(str.asOutParam());
2911 RTPrintf("Webservice auth. library: %lS\n", str.raw());
2912 systemProperties->COMGETTER(HWVirtExEnabled)(&flag);
2913 RTPrintf("Hardware virt. extensions: %s\n", flag ? "yes" : "no");
2914 systemProperties->COMGETTER(LogHistoryCount)(&ulValue);
2915 RTPrintf("Log history count: %u\n", ulValue);
2916
2917 }
2918 else
2919 {
2920 return errorSyntax(USAGE_LIST, "Invalid parameter '%s'", Utf8Str(argv[0]).raw());
2921 }
2922 return SUCCEEDED(rc) ? 0 : 1;
2923}
2924
2925static int handleRegisterVM(int argc, char *argv[],
2926 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
2927{
2928 HRESULT rc;
2929
2930 if (argc != 1)
2931 {
2932 return errorSyntax(USAGE_REGISTERVM, "Incorrect number of parameters");
2933 }
2934
2935 ComPtr<IMachine> machine;
2936 CHECK_ERROR(virtualBox, OpenMachine(Bstr(argv[0]), machine.asOutParam()));
2937 if (SUCCEEDED(rc))
2938 {
2939 ASSERT(machine);
2940 CHECK_ERROR(virtualBox, RegisterMachine(machine));
2941 }
2942 return SUCCEEDED(rc) ? 0 : 1;
2943}
2944
2945static int handleUnregisterVM(int argc, char *argv[],
2946 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
2947{
2948 HRESULT rc;
2949
2950 if ((argc != 1) && (argc != 2))
2951 {
2952 return errorSyntax(USAGE_UNREGISTERVM, "Incorrect number of parameters");
2953 }
2954
2955 ComPtr<IMachine> machine;
2956 /* assume it's a UUID */
2957 rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam());
2958 if (FAILED(rc) || !machine)
2959 {
2960 /* must be a name */
2961 CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
2962 }
2963 if (machine)
2964 {
2965 Guid uuid;
2966 machine->COMGETTER(Id)(uuid.asOutParam());
2967 machine = NULL;
2968 CHECK_ERROR(virtualBox, UnregisterMachine(uuid, machine.asOutParam()));
2969 if (SUCCEEDED(rc) && machine)
2970 {
2971 /* are we supposed to delete the config file? */
2972 if ((argc == 2) && (strcmp(argv[1], "-delete") == 0))
2973 {
2974 CHECK_ERROR(machine, DeleteSettings());
2975 }
2976 }
2977 }
2978 return SUCCEEDED(rc) ? 0 : 1;
2979}
2980
2981static int handleCreateVDI(int argc, char *argv[],
2982 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
2983{
2984 HRESULT rc;
2985 Bstr filename;
2986 uint64_t sizeMB = 0;
2987 bool fStatic = false;
2988 Bstr comment;
2989 bool fRegister = false;
2990 const char *type = "normal";
2991
2992 /* let's have a closer look at the arguments */
2993 for (int i = 0; i < argc; i++)
2994 {
2995 if (strcmp(argv[i], "-filename") == 0)
2996 {
2997 if (argc <= i + 1)
2998 {
2999 return errorArgument("Missing argument to '%s'", argv[i]);
3000 }
3001 i++;
3002 filename = argv[i];
3003 }
3004 else if (strcmp(argv[i], "-size") == 0)
3005 {
3006 if (argc <= i + 1)
3007 {
3008 return errorArgument("Missing argument to '%s'", argv[i]);
3009 }
3010 i++;
3011 sizeMB = RTStrToUInt64(argv[i]);
3012 }
3013 else if (strcmp(argv[i], "-static") == 0)
3014 {
3015 fStatic = true;
3016 }
3017 else if (strcmp(argv[i], "-comment") == 0)
3018 {
3019 if (argc <= i + 1)
3020 {
3021 return errorArgument("Missing argument to '%s'", argv[i]);
3022 }
3023 i++;
3024 comment = argv[i];
3025 }
3026 else if (strcmp(argv[i], "-register") == 0)
3027 {
3028 fRegister = true;
3029 }
3030 else if (strcmp(argv[i], "-type") == 0)
3031 {
3032 if (argc <= i + 1)
3033 {
3034 return errorArgument("Missing argument to '%s'", argv[i]);
3035 }
3036 i++;
3037 type = argv[i];
3038 }
3039 else
3040 {
3041 return errorSyntax(USAGE_CREATEVDI, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
3042 }
3043 }
3044 /* check the outcome */
3045 if (!filename || (sizeMB == 0))
3046 {
3047 return errorSyntax(USAGE_CREATEVDI, "Parameters -filename and -size are required");
3048 }
3049 if (strcmp(type, "normal") && strcmp(type, "writethrough"))
3050 {
3051 return errorArgument("Invalid VDI type '%s' specified", Utf8Str(type).raw());
3052 }
3053
3054 ComPtr<IHardDisk> hardDisk;
3055 CHECK_ERROR(virtualBox, CreateHardDisk(HardDiskStorageType_VirtualDiskImage, hardDisk.asOutParam()));
3056 if (SUCCEEDED(rc) && hardDisk)
3057 {
3058 CHECK_ERROR(hardDisk,COMSETTER(Description)(comment));
3059 ComPtr<IVirtualDiskImage> vdi = hardDisk;
3060 CHECK_ERROR(vdi, COMSETTER(FilePath)(filename));
3061 ComPtr<IProgress> progress;
3062 if (fStatic)
3063 {
3064 CHECK_ERROR(vdi, CreateFixedImage(sizeMB, progress.asOutParam()));
3065 }
3066 else
3067 {
3068 CHECK_ERROR(vdi, CreateDynamicImage(sizeMB, progress.asOutParam()));
3069 }
3070 if (SUCCEEDED(rc) && progress)
3071 {
3072 if (fStatic)
3073 showProgress(progress);
3074 else
3075 CHECK_ERROR(progress, WaitForCompletion(-1));
3076 if (SUCCEEDED(rc))
3077 {
3078 progress->COMGETTER(ResultCode)(&rc);
3079 if (FAILED(rc))
3080 {
3081 com::ProgressErrorInfo info(progress);
3082 if (info.isBasicAvailable())
3083 {
3084 RTPrintf("Error: failed to create disk image. Error message: %lS\n", info.getText().raw());
3085 }
3086 else
3087 {
3088 RTPrintf("Error: failed to create disk image. No error message available!\n");
3089 }
3090 }
3091 else
3092 {
3093 Guid uuid;
3094 CHECK_ERROR(hardDisk, COMGETTER(Id)(uuid.asOutParam()));
3095
3096 if (strcmp(type, "normal") == 0)
3097 {
3098 /* nothing required, default */
3099 }
3100 else if (strcmp(type, "writethrough") == 0)
3101 {
3102 CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Writethrough));
3103 }
3104
3105 RTPrintf("Disk image created. UUID: %s\n", uuid.toString().raw());
3106 }
3107 }
3108 }
3109 if (SUCCEEDED(rc) && fRegister)
3110 {
3111 CHECK_ERROR(virtualBox, RegisterHardDisk(hardDisk));
3112 }
3113 }
3114 return SUCCEEDED(rc) ? 0 : 1;
3115}
3116
3117static DECLCALLBACK(int) vdiProgressCallback(PVM pVM, unsigned uPercent, void *pvUser)
3118{
3119 unsigned *pPercent = (unsigned *)pvUser;
3120
3121 if (*pPercent != uPercent)
3122 {
3123 *pPercent = uPercent;
3124 RTPrintf(".");
3125 if ((uPercent % 10) == 0 && uPercent)
3126 RTPrintf("%d%%", uPercent);
3127 RTStrmFlush(g_pStdOut);
3128 }
3129
3130 return VINF_SUCCESS;
3131}
3132
3133
3134static int handleModifyVDI(int argc, char *argv[],
3135 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
3136{
3137 HRESULT rc;
3138
3139 /* The uuid/filename and a command */
3140 if (argc < 2)
3141 {
3142 return errorSyntax(USAGE_MODIFYVDI, "Incorrect number of parameters");
3143 }
3144
3145 ComPtr<IHardDisk> hardDisk;
3146 ComPtr<IVirtualDiskImage> vdi;
3147 Bstr filepath;
3148
3149 /* first guess is that it's a UUID */
3150 Guid uuid(argv[0]);
3151 rc = virtualBox->GetHardDisk(uuid, hardDisk.asOutParam());
3152 /* no? then it must be a filename */
3153 if (!hardDisk)
3154 {
3155 filepath = argv[0];
3156 CHECK_ERROR(virtualBox, FindVirtualDiskImage(filepath, vdi.asOutParam()));
3157 hardDisk = vdi;
3158 }
3159 else
3160 {
3161 vdi = hardDisk;
3162 }
3163
3164 /* let's find out which command */
3165// doesn't currently work if (strcmp(argv[1], "settype") == 0)
3166 if (0)
3167 {
3168 /* hard disk must be registered */
3169 if (SUCCEEDED(rc) && hardDisk && vdi)
3170 {
3171 char *type = NULL;
3172
3173 if (argc <= 2)
3174 {
3175 return errorArgument("Missing argument to for settype");
3176 }
3177 type = argv[2];
3178
3179 HardDiskType_T hddType;
3180 CHECK_ERROR(hardDisk, COMGETTER(Type)(&hddType));
3181
3182 if (strcmp(type, "normal") == 0)
3183 {
3184 if (hddType != HardDiskType_Normal)
3185 CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Normal));
3186 }
3187 else if (strcmp(type, "writethrough") == 0)
3188 {
3189 if (hddType != HardDiskType_Writethrough)
3190 CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Writethrough));
3191
3192 }
3193 else if (strcmp(type, "immutable") == 0)
3194 {
3195 if (hddType != HardDiskType_Immutable)
3196 CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Immutable));
3197 }
3198 else
3199 {
3200 return errorArgument("Invalid VDI type '%s' specified", Utf8Str(type).raw());
3201 }
3202 }
3203 else
3204 {
3205 return errorArgument("Hard disk image not registered");
3206 }
3207 }
3208 else if (strcmp(argv[1], "compact") == 0)
3209 {
3210 ComPtr<IVirtualDiskImage> vdi;
3211
3212 /* the hard disk image might not be registered */
3213 if (!hardDisk)
3214 {
3215 virtualBox->OpenVirtualDiskImage(Bstr(argv[0]), vdi.asOutParam());
3216 if (!vdi)
3217 {
3218 return errorArgument("Hard disk image not found");
3219 }
3220 }
3221 else
3222 vdi = hardDisk;
3223
3224 if (!vdi)
3225 return errorArgument("Invalid hard disk type. The command only works on VDI files\n");
3226
3227 Bstr fileName;
3228 vdi->COMGETTER(FilePath)(fileName.asOutParam());
3229
3230 /* close the file */
3231 hardDisk = NULL;
3232 vdi = NULL;
3233
3234 unsigned uProcent;
3235
3236 RTPrintf("Shrinking '%lS': 0%%", fileName.raw());
3237 int vrc = VDIShrinkImage(Utf8Str(fileName).raw(), vdiProgressCallback, &uProcent);
3238 if (VBOX_FAILURE(vrc))
3239 {
3240 RTPrintf("Error while shrinking hard disk image: %Vrc\n", vrc);
3241 rc = E_FAIL;
3242 }
3243 }
3244 else
3245 {
3246 return errorSyntax(USAGE_MODIFYVDI, "Invalid parameter '%s'", Utf8Str(argv[1]).raw());
3247 }
3248 return SUCCEEDED(rc) ? 0 : 1;
3249}
3250
3251static int handleCloneVDI(int argc, char *argv[],
3252 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
3253{
3254 HRESULT rc;
3255
3256 /* source VDI and target path */
3257 if (argc != 2)
3258 {
3259 return errorSyntax(USAGE_CLONEVDI, "Incorrect number of parameters");
3260 }
3261
3262 /* first guess is that it's a UUID */
3263 Guid uuid(argv[0]);
3264 ComPtr<IHardDisk> hardDisk;
3265 rc = virtualBox->GetHardDisk(uuid, hardDisk.asOutParam());
3266 if (!hardDisk)
3267 {
3268 /* not successful? Then it must be a filename */
3269 ComPtr<IVirtualDiskImage> vdi;
3270 CHECK_ERROR(virtualBox, OpenVirtualDiskImage(Bstr(argv[0]), vdi.asOutParam()));
3271 hardDisk = vdi;
3272 }
3273 if (hardDisk)
3274 {
3275 ComPtr<IVirtualDiskImage> vdiOut;
3276 ComPtr<IProgress> progress;
3277 CHECK_ERROR(hardDisk, CloneToImage(Bstr(argv[1]), vdiOut.asOutParam(), progress.asOutParam()));
3278 if (SUCCEEDED(rc))
3279 {
3280 showProgress(progress);
3281 progress->COMGETTER(ResultCode)(&rc);
3282 if (FAILED(rc))
3283 {
3284 com::ProgressErrorInfo info(progress);
3285 if (info.isBasicAvailable())
3286 {
3287 RTPrintf("Error: failed to clone disk image. Error message: %lS\n", info.getText().raw());
3288 }
3289 else
3290 {
3291 RTPrintf("Error: failed to clone disk image. No error message available!\n");
3292 }
3293 }
3294 }
3295 }
3296 return SUCCEEDED(rc) ? 0 : 1;
3297}
3298
3299static int handleConvertDDImage(int argc, char *argv[])
3300{
3301#ifdef RT_OS_LINUX
3302 const bool fReadFromStdIn = (argc >= 1) && !strcmp(argv[0], "stdin");
3303#else
3304 const bool fReadFromStdIn = false;
3305#endif
3306
3307 if ((!fReadFromStdIn && argc != 2) || (fReadFromStdIn && argc != 3))
3308 return errorSyntax(USAGE_CONVERTDD, "Incorrect number of parameters");
3309
3310 RTPrintf("Converting VDI: from DD image file=\"%s\" to file=\"%s\"...\n",
3311 argv[0], argv[1]);
3312
3313 /* open raw image file. */
3314 RTFILE File;
3315 int rc = VINF_SUCCESS;
3316 if (fReadFromStdIn)
3317 File = 0;
3318 else
3319 rc = RTFileOpen(&File, argv[0], RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_WRITE);
3320 if (VBOX_FAILURE(rc))
3321 {
3322 RTPrintf("File=\"%s\" open error: %Rrf\n", argv[0], rc);
3323 return rc;
3324 }
3325
3326 uint64_t cbFile;
3327 /* get image size. */
3328 if (fReadFromStdIn)
3329 cbFile = RTStrToUInt64(argv[2]);
3330 else
3331 rc = RTFileGetSize(File, &cbFile);
3332 if (VBOX_SUCCESS(rc))
3333 {
3334 RTPrintf("Creating fixed image with size %RU64 bytes (%RU64MB)...\n", cbFile, (cbFile + _1M - 1) / _1M);
3335 char pszComment[256];
3336 RTStrPrintf(pszComment, sizeof(pszComment), "Converted image from %s", argv[0]);
3337 rc = VDICreateBaseImage(argv[1],
3338 VDI_IMAGE_TYPE_FIXED,
3339 cbFile,
3340 pszComment, NULL, NULL);
3341 if (VBOX_SUCCESS(rc))
3342 {
3343 PVDIDISK pVdi = VDIDiskCreate();
3344 rc = VDIDiskOpenImage(pVdi, argv[1], VDI_OPEN_FLAGS_NORMAL);
3345 if (VBOX_SUCCESS(rc))
3346 {
3347 /* alloc work buffer. */
3348 size_t cbBuffer = VDIDiskGetBufferSize(pVdi);
3349 void *pvBuf = RTMemAlloc(cbBuffer);
3350 if (pvBuf)
3351 {
3352 uint64_t offFile = 0;
3353 while (offFile < cbFile)
3354 {
3355 size_t cbRead = 0;
3356 size_t cbToRead = cbFile - offFile >= (uint64_t) cbBuffer ?
3357 cbBuffer : (size_t) (cbFile - offFile);
3358 rc = RTFileRead(File, pvBuf, cbToRead, &cbRead);
3359 if (VBOX_FAILURE(rc) || !cbRead)
3360 break;
3361 rc = VDIDiskWrite(pVdi, offFile, pvBuf, cbRead);
3362 if (VBOX_FAILURE(rc))
3363 break;
3364 offFile += cbRead;
3365 }
3366
3367 RTMemFree(pvBuf);
3368 }
3369 else
3370 rc = VERR_NO_MEMORY;
3371
3372 VDIDiskCloseImage(pVdi);
3373 }
3374
3375 if (VBOX_FAILURE(rc))
3376 {
3377 /* delete image on error */
3378 RTPrintf("Failed (%Vrc)!\n", rc);
3379 VDIDeleteImage(argv[1]);
3380 }
3381 }
3382 else
3383 RTPrintf("Failed to create output file (%Vrc)!\n", rc);
3384 }
3385 RTFileClose(File);
3386
3387 return rc;
3388}
3389
3390static int handleAddiSCSIDisk(int argc, char *argv[],
3391 ComPtr <IVirtualBox> aVirtualBox, ComPtr<ISession> aSession)
3392{
3393 HRESULT rc;
3394 Bstr server;
3395 Bstr target;
3396 uint16_t port = UINT16_MAX;
3397 uint64_t lun = UINT64_MAX;
3398 Bstr username;
3399 Bstr password;
3400 Bstr comment;
3401
3402 /* at least server and target */
3403 if (argc < 4)
3404 {
3405 return errorSyntax(USAGE_ADDISCSIDISK, "Not enough parameters");
3406 }
3407
3408 /* let's have a closer look at the arguments */
3409 for (int i = 0; i < argc; i++)
3410 {
3411 if (strcmp(argv[i], "-server") == 0)
3412 {
3413 if (argc <= i + 1)
3414 {
3415 return errorArgument("Missing argument to '%s'", argv[i]);
3416 }
3417 i++;
3418 server = argv[i];
3419 }
3420 else if (strcmp(argv[i], "-target") == 0)
3421 {
3422 if (argc <= i + 1)
3423 {
3424 return errorArgument("Missing argument to '%s'", argv[i]);
3425 }
3426 i++;
3427 target = argv[i];
3428 }
3429 else if (strcmp(argv[i], "-port") == 0)
3430 {
3431 if (argc <= i + 1)
3432 {
3433 return errorArgument("Missing argument to '%s'", argv[i]);
3434 }
3435 i++;
3436 port = atoi(argv[i]);
3437 }
3438 else if (strcmp(argv[i], "-lun") == 0)
3439 {
3440 /** @todo move the LUN encoding algorithm into IISCSIHardDisk, add decoding */
3441 if (argc <= i + 1)
3442 {
3443 return errorArgument("Missing argument to '%s'", argv[i]);
3444 }
3445 i++;
3446 char *pszNext;
3447 int rc = RTStrToUInt64Ex(argv[i], &pszNext, 0, &lun);
3448 if (VBOX_FAILURE(rc) || *pszNext != '\0' || lun >= 16384)
3449 return errorArgument("Invalid LUN number '%s'", argv[i]);
3450 if (lun <= 255)
3451 {
3452 /* Assume bus identifier = 0. */
3453 lun = (lun << 48); /* uses peripheral device addressing method */
3454 }
3455 else
3456 {
3457 /* Check above already limited the LUN to 14 bits. */
3458 lun = (lun << 48) | RT_BIT_64(62); /* uses flat space addressing method */
3459 }
3460 }
3461 else if (strcmp(argv[i], "-encodedlun") == 0)
3462 {
3463 if (argc <= i + 1)
3464 {
3465 return errorArgument("Missing argument to '%s'", argv[i]);
3466 }
3467 i++;
3468 char *pszNext;
3469 int rc = RTStrToUInt64Ex(argv[i], &pszNext, 0, &lun);
3470 if (VBOX_FAILURE(rc) || *pszNext != '\0')
3471 return errorArgument("Invalid encoded LUN number '%s'", argv[i]);
3472 }
3473 else if (strcmp(argv[i], "-username") == 0)
3474 {
3475 if (argc <= i + 1)
3476 {
3477 return errorArgument("Missing argument to '%s'", argv[i]);
3478 }
3479 i++;
3480 username = argv[i];
3481 }
3482 else if (strcmp(argv[i], "-password") == 0)
3483 {
3484 if (argc <= i + 1)
3485 {
3486 return errorArgument("Missing argument to '%s'", argv[i]);
3487 }
3488 i++;
3489 password = argv[i];
3490 }
3491 else if (strcmp(argv[i], "-comment") == 0)
3492 {
3493 if (argc <= i + 1)
3494 {
3495 return errorArgument("Missing argument to '%s'", argv[i]);
3496 }
3497 i++;
3498 comment = argv[i];
3499 }
3500 else
3501 {
3502 return errorSyntax(USAGE_ADDISCSIDISK, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
3503 }
3504 }
3505
3506 /* check for required options */
3507 if (!server || !target)
3508 {
3509 return errorSyntax(USAGE_ADDISCSIDISK, "Parameters -server and -target are required");
3510 }
3511
3512 ComPtr<IHardDisk> hardDisk;
3513 CHECK_ERROR(aVirtualBox, CreateHardDisk(HardDiskStorageType_ISCSIHardDisk, hardDisk.asOutParam()));
3514 if (SUCCEEDED(rc) && hardDisk)
3515 {
3516 CHECK_ERROR(hardDisk, COMSETTER(Description)(comment));
3517 ComPtr<IISCSIHardDisk> iSCSIDisk = hardDisk;
3518 CHECK_ERROR(iSCSIDisk, COMSETTER(Server)(server));
3519 if (port != UINT16_MAX)
3520 CHECK_ERROR(iSCSIDisk, COMSETTER(Port)(port));
3521 CHECK_ERROR(iSCSIDisk, COMSETTER(Target)(target));
3522 if (lun != UINT64_MAX)
3523 CHECK_ERROR(iSCSIDisk, COMSETTER(Lun)(lun));
3524 CHECK_ERROR(iSCSIDisk, COMSETTER(UserName)(username));
3525 CHECK_ERROR(iSCSIDisk, COMSETTER(Password)(password));
3526
3527 if (SUCCEEDED(rc))
3528 {
3529 CHECK_ERROR(aVirtualBox, RegisterHardDisk(hardDisk));
3530 }
3531
3532 if (SUCCEEDED(rc))
3533 {
3534 Guid guid;
3535 CHECK_ERROR(hardDisk, COMGETTER(Id)(guid.asOutParam()));
3536 RTPrintf("iSCSI disk created. UUID: %s\n", guid.toString().raw());
3537 }
3538 }
3539
3540 return SUCCEEDED(rc) ? 0 : 1;
3541}
3542
3543static int handleCreateVM(int argc, char *argv[],
3544 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
3545{
3546 HRESULT rc;
3547 Bstr baseFolder;
3548 Bstr settingsFile;
3549 Bstr name;
3550 RTUUID id;
3551 bool fRegister = false;
3552
3553 RTUuidClear(&id);
3554 for (int i = 0; i < argc; i++)
3555 {
3556 if (strcmp(argv[i], "-basefolder") == 0)
3557 {
3558 if (argc <= i + 1)
3559 {
3560 return errorArgument("Missing argument to '%s'", argv[i]);
3561 }
3562 i++;
3563 baseFolder = argv[i];
3564 }
3565 else if (strcmp(argv[i], "-settingsfile") == 0)
3566 {
3567 if (argc <= i + 1)
3568 {
3569 return errorArgument("Missing argument to '%s'", argv[i]);
3570 }
3571 i++;
3572 settingsFile = argv[i];
3573 }
3574 else if (strcmp(argv[i], "-name") == 0)
3575 {
3576 if (argc <= i + 1)
3577 {
3578 return errorArgument("Missing argument to '%s'", argv[i]);
3579 }
3580 i++;
3581 name = argv[i];
3582 }
3583 else if (strcmp(argv[i], "-uuid") == 0)
3584 {
3585 if (argc <= i + 1)
3586 {
3587 return errorArgument("Missing argument to '%s'", argv[i]);
3588 }
3589 i++;
3590 if (VBOX_FAILURE(RTUuidFromStr(&id, argv[i])))
3591 {
3592 return errorArgument("Invalid UUID format %s\n", argv[i]);
3593 }
3594 }
3595 else if (strcmp(argv[i], "-register") == 0)
3596 {
3597 fRegister = true;
3598 }
3599 else
3600 {
3601 return errorSyntax(USAGE_CREATEVM, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
3602 }
3603 }
3604 if (!name)
3605 {
3606 return errorSyntax(USAGE_CREATEVM, "Parameter -name is required");
3607 }
3608 if (!!baseFolder && !!settingsFile)
3609 {
3610 return errorSyntax(USAGE_CREATEVM, "Either -basefolder or -settingsfile must be specified");
3611 }
3612
3613 do
3614 {
3615 ComPtr<IMachine> machine;
3616
3617 if (!settingsFile)
3618 CHECK_ERROR_BREAK(virtualBox,
3619 CreateMachine(baseFolder, name, Guid(id), machine.asOutParam()));
3620 else
3621 CHECK_ERROR_BREAK(virtualBox,
3622 CreateLegacyMachine(settingsFile, name, Guid(id), machine.asOutParam()));
3623
3624 CHECK_ERROR_BREAK(machine, SaveSettings());
3625 if (fRegister)
3626 {
3627 CHECK_ERROR_BREAK(virtualBox, RegisterMachine(machine));
3628 }
3629 Guid uuid;
3630 CHECK_ERROR_BREAK(machine, COMGETTER(Id)(uuid.asOutParam()));
3631 CHECK_ERROR_BREAK(machine, COMGETTER(SettingsFilePath)(settingsFile.asOutParam()));
3632 RTPrintf("Virtual machine '%ls' is created%s.\n"
3633 "UUID: %s\n"
3634 "Settings file: '%ls'\n",
3635 name.raw(), fRegister ? " and registered" : "",
3636 uuid.toString().raw(), settingsFile.raw());
3637 }
3638 while (0);
3639
3640 return SUCCEEDED(rc) ? 0 : 1;
3641}
3642
3643/**
3644 * Parses a number.
3645 *
3646 * @returns Valid number on success.
3647 * @returns 0 if invalid number. All necesary bitching has been done.
3648 * @param psz Pointer to the nic number.
3649 */
3650static unsigned parseNum(const char *psz, unsigned cMaxNum, const char *name)
3651{
3652 uint32_t u32;
3653 char *pszNext;
3654 int rc = RTStrToUInt32Ex(psz, &pszNext, 10, &u32);
3655 if ( VBOX_SUCCESS(rc)
3656 && *pszNext == '\0'
3657 && u32 >= 1
3658 && u32 <= cMaxNum)
3659 return (unsigned)u32;
3660 errorArgument("Invalid %s number '%s'", name, psz);
3661 return 0;
3662}
3663
3664static int handleModifyVM(int argc, char *argv[],
3665 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
3666{
3667 HRESULT rc;
3668 Bstr name;
3669 Bstr ostype;
3670 ULONG memorySize = 0;
3671 ULONG vramSize = 0;
3672 char *acpi = NULL;
3673 char *hwvirtex = NULL;
3674 char *ioapic = NULL;
3675 int monitorcount = -1;
3676 char *bioslogofadein = NULL;
3677 char *bioslogofadeout = NULL;
3678 uint32_t bioslogodisplaytime = ~0;
3679 char *bioslogoimagepath = NULL;
3680 char *biosbootmenumode = NULL;
3681 char *biossystemtimeoffset = NULL;
3682 char *biospxedebug = NULL;
3683 DeviceType_T bootDevice[4];
3684 int bootDeviceChanged[4] = { false };
3685 char *hdds[4] = {0};
3686 char *dvd = NULL;
3687 char *dvdpassthrough = NULL;
3688 char *floppy = NULL;
3689 char *audio = NULL;
3690 char *audiocontroller = NULL;
3691 char *clipboard = NULL;
3692#ifdef VBOX_VRDP
3693 char *vrdp = NULL;
3694 uint16_t vrdpport = UINT16_MAX;
3695 char *vrdpaddress = NULL;
3696 char *vrdpauthtype = NULL;
3697 char *vrdpmulticon = NULL;
3698#endif
3699 int fUsbEnabled = -1;
3700 int fUsbEhciEnabled = -1;
3701 char *snapshotFolder = NULL;
3702 ULONG guestMemBalloonSize = (ULONG)-1;
3703 ULONG guestStatInterval = (ULONG)-1;
3704
3705 /* VM ID + at least one parameter. Parameter arguments are checked
3706 * individually. */
3707 if (argc < 2)
3708 return errorSyntax(USAGE_MODIFYVM, "Not enough parameters");
3709
3710 /* Get the number of network adapters */
3711 ULONG NetworkAdapterCount = 0;
3712 {
3713 ComPtr <ISystemProperties> info;
3714 CHECK_ERROR_RET (virtualBox, COMGETTER(SystemProperties) (info.asOutParam()), 1);
3715 CHECK_ERROR_RET (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount), 1);
3716 }
3717 ULONG SerialPortCount = 0;
3718 {
3719 ComPtr <ISystemProperties> info;
3720 CHECK_ERROR_RET (virtualBox, COMGETTER(SystemProperties) (info.asOutParam()), 1);
3721 CHECK_ERROR_RET (info, COMGETTER(SerialPortCount) (&SerialPortCount), 1);
3722 }
3723
3724 std::vector <char *> nics (NetworkAdapterCount, 0);
3725 std::vector <char *> nictype (NetworkAdapterCount, 0);
3726 std::vector <char *> cableconnected (NetworkAdapterCount, 0);
3727 std::vector <char *> nictrace (NetworkAdapterCount, 0);
3728 std::vector <char *> nictracefile (NetworkAdapterCount, 0);
3729 std::vector <char *> nicspeed (NetworkAdapterCount, 0);
3730 std::vector <char *> hostifdev (NetworkAdapterCount, 0);
3731 std::vector <const char *> intnet (NetworkAdapterCount, 0);
3732#ifdef RT_OS_LINUX
3733 std::vector <char *> tapsetup (NetworkAdapterCount, 0);
3734 std::vector <char *> tapterm (NetworkAdapterCount, 0);
3735#endif
3736 std::vector <char *> macs (NetworkAdapterCount, 0);
3737 std::vector <char *> uarts_mode (SerialPortCount, 0);
3738 std::vector <ULONG> uarts_base (SerialPortCount, 0);
3739 std::vector <ULONG> uarts_irq (SerialPortCount, 0);
3740 std::vector <char *> uarts_path (SerialPortCount, 0);
3741
3742 for (int i = 1; i < argc; i++)
3743 {
3744 if (strcmp(argv[i], "-name") == 0)
3745 {
3746 if (argc <= i + 1)
3747 {
3748 return errorArgument("Missing argument to '%s'", argv[i]);
3749 }
3750 i++;
3751 name = argv[i];
3752 }
3753 else if (strcmp(argv[i], "-ostype") == 0)
3754 {
3755 if (argc <= i + 1)
3756 {
3757 return errorArgument("Missing argument to '%s'", argv[i]);
3758 }
3759 i++;
3760 ostype = argv[i];
3761 }
3762 else if (strcmp(argv[i], "-memory") == 0)
3763 {
3764 if (argc <= i + 1)
3765 {
3766 return errorArgument("Missing argument to '%s'", argv[i]);
3767 }
3768 i++;
3769 memorySize = atoi(argv[i]);
3770 }
3771 else if (strcmp(argv[i], "-vram") == 0)
3772 {
3773 if (argc <= i + 1)
3774 {
3775 return errorArgument("Missing argument to '%s'", argv[i]);
3776 }
3777 i++;
3778 vramSize = atoi(argv[i]);
3779 }
3780 else if (strcmp(argv[i], "-acpi") == 0)
3781 {
3782 if (argc <= i + 1)
3783 {
3784 return errorArgument("Missing argument to '%s'", argv[i]);
3785 }
3786 i++;
3787 acpi = argv[i];
3788 }
3789 else if (strcmp(argv[i], "-ioapic") == 0)
3790 {
3791 if (argc <= i + 1)
3792 {
3793 return errorArgument("Missing argument to '%s'", argv[i]);
3794 }
3795 i++;
3796 ioapic = argv[i];
3797 }
3798 else if (strcmp(argv[i], "-hwvirtex") == 0)
3799 {
3800 if (argc <= i + 1)
3801 {
3802 return errorArgument("Missing argument to '%s'", argv[i]);
3803 }
3804 i++;
3805 hwvirtex = argv[i];
3806 }
3807 else if (strcmp(argv[i], "-monitorcount") == 0)
3808 {
3809 if (argc <= i + 1)
3810 {
3811 return errorArgument("Missing argument to '%s'", argv[i]);
3812 }
3813 i++;
3814 monitorcount = atoi(argv[i]);
3815 }
3816 else if (strcmp(argv[i], "-bioslogofadein") == 0)
3817 {
3818 if (argc <= i + 1)
3819 {
3820 return errorArgument("Missing argument to '%s'", argv[i]);
3821 }
3822 i++;
3823 bioslogofadein = argv[i];
3824 }
3825 else if (strcmp(argv[i], "-bioslogofadeout") == 0)
3826 {
3827 if (argc <= i + 1)
3828 {
3829 return errorArgument("Missing argument to '%s'", argv[i]);
3830 }
3831 i++;
3832 bioslogofadeout = argv[i];
3833 }
3834 else if (strcmp(argv[i], "-bioslogodisplaytime") == 0)
3835 {
3836 if (argc <= i + 1)
3837 {
3838 return errorArgument("Missing argument to '%s'", argv[i]);
3839 }
3840 i++;
3841 bioslogodisplaytime = atoi(argv[i]);
3842 }
3843 else if (strcmp(argv[i], "-bioslogoimagepath") == 0)
3844 {
3845 if (argc <= i + 1)
3846 {
3847 return errorArgument("Missing argument to '%s'", argv[i]);
3848 }
3849 i++;
3850 bioslogoimagepath = argv[i];
3851 }
3852 else if (strcmp(argv[i], "-biosbootmenu") == 0)
3853 {
3854 if (argc <= i + 1)
3855 {
3856 return errorArgument("Missing argument to '%s'", argv[i]);
3857 }
3858 i++;
3859 biosbootmenumode = argv[i];
3860 }
3861 else if (strcmp(argv[i], "-biossystemtimeoffset") == 0)
3862 {
3863 if (argc <= i + 1)
3864 {
3865 return errorArgument("Missing argument to '%s'", argv[i]);
3866 }
3867 i++;
3868 biossystemtimeoffset = argv[i];
3869 }
3870 else if (strcmp(argv[i], "-biospxedebug") == 0)
3871 {
3872 if (argc <= i + 1)
3873 {
3874 return errorArgument("Missing argument to '%s'", argv[i]);
3875 }
3876 i++;
3877 biospxedebug = argv[i];
3878 }
3879 else if (strncmp(argv[i], "-boot", 5) == 0)
3880 {
3881 ULONG n = 0;
3882 if (!argv[i][5])
3883 {
3884 return errorSyntax(USAGE_MODIFYVM, "Missing boot slot number in '%s'", argv[i]);
3885 }
3886 if ((n = strtoul(&argv[i][5], NULL, 10)) < 1)
3887 {
3888 return errorSyntax(USAGE_MODIFYVM, "Invalid boot slot number in '%s'", argv[i]);
3889 }
3890 if (argc <= i + 1)
3891 {
3892 return errorArgument("Missing argument to '%s'", argv[i]);
3893 }
3894 i++;
3895 if (strcmp(argv[i], "none") == 0)
3896 {
3897 bootDevice[n - 1] = DeviceType_Null;
3898 }
3899 else if (strcmp(argv[i], "floppy") == 0)
3900 {
3901 bootDevice[n - 1] = DeviceType_Floppy;
3902 }
3903 else if (strcmp(argv[i], "dvd") == 0)
3904 {
3905 bootDevice[n - 1] = DeviceType_DVD;
3906 }
3907 else if (strcmp(argv[i], "disk") == 0)
3908 {
3909 bootDevice[n - 1] = DeviceType_HardDisk;
3910 }
3911 else if (strcmp(argv[i], "net") == 0)
3912 {
3913 bootDevice[n - 1] = DeviceType_Network;
3914 }
3915 else
3916 {
3917 return errorArgument("Invalid boot device '%s'", argv[i]);
3918 }
3919 bootDeviceChanged[n - 1] = true;
3920 }
3921 else if (strcmp(argv[i], "-hda") == 0)
3922 {
3923 if (argc <= i + 1)
3924 {
3925 return errorArgument("Missing argument to '%s'", argv[i]);
3926 }
3927 i++;
3928 hdds[0] = argv[i];
3929 }
3930 else if (strcmp(argv[i], "-hdb") == 0)
3931 {
3932 if (argc <= i + 1)
3933 {
3934 return errorArgument("Missing argument to '%s'", argv[i]);
3935 }
3936 i++;
3937 hdds[1] = argv[i];
3938 }
3939 else if (strcmp(argv[i], "-hdd") == 0)
3940 {
3941 if (argc <= i + 1)
3942 {
3943 return errorArgument("Missing argument to '%s'", argv[i]);
3944 }
3945 i++;
3946 hdds[2] = argv[i];
3947 }
3948 else if (strcmp(argv[i], "-dvd") == 0)
3949 {
3950 if (argc <= i + 1)
3951 {
3952 return errorArgument("Missing argument to '%s'", argv[i]);
3953 }
3954 i++;
3955 dvd = argv[i];
3956 }
3957 else if (strcmp(argv[i], "-dvdpassthrough") == 0)
3958 {
3959 if (argc <= i + 1)
3960 {
3961 return errorArgument("Missing argument to '%s'", argv[i]);
3962 }
3963 i++;
3964 dvdpassthrough = argv[i];
3965 }
3966 else if (strcmp(argv[i], "-floppy") == 0)
3967 {
3968 if (argc <= i + 1)
3969 {
3970 return errorArgument("Missing argument to '%s'", argv[i]);
3971 }
3972 i++;
3973 floppy = argv[i];
3974 }
3975 else if (strcmp(argv[i], "-audio") == 0)
3976 {
3977 if (argc <= i + 1)
3978 {
3979 return errorArgument("Missing argument to '%s'", argv[i]);
3980 }
3981 i++;
3982 audio = argv[i];
3983 }
3984 else if (strcmp(argv[i], "-audiocontroller") == 0)
3985 {
3986 if (argc <= i + 1)
3987 {
3988 return errorArgument("Missing argument to '%s'", argv[i]);
3989 }
3990 i++;
3991 audiocontroller = argv[i];
3992 }
3993 else if (strcmp(argv[i], "-clipboard") == 0)
3994 {
3995 if (argc <= i + 1)
3996 {
3997 return errorArgument("Missing argument to '%s'", argv[i]);
3998 }
3999 i++;
4000 clipboard = argv[i];
4001 }
4002 else if (strncmp(argv[i], "-cableconnected", 15) == 0)
4003 {
4004 unsigned n = parseNum(&argv[i][15], NetworkAdapterCount, "NIC");
4005 if (!n)
4006 return 1;
4007 if (argc <= i + 1)
4008 {
4009 return errorArgument("Missing argument to '%s'", argv[i]);
4010 }
4011 cableconnected[n - 1] = argv[i + 1];
4012 i++;
4013 }
4014 /* watch for the right order of these -nic* comparisons! */
4015 else if (strncmp(argv[i], "-nictracefile", 13) == 0)
4016 {
4017 unsigned n = parseNum(&argv[i][13], NetworkAdapterCount, "NIC");
4018 if (!n)
4019 return 1;
4020 if (argc <= i + 1)
4021 {
4022 return errorArgument("Missing argument to '%s'", argv[i]);
4023 }
4024 nictracefile[n - 1] = argv[i + 1];
4025 i++;
4026 }
4027 else if (strncmp(argv[i], "-nictrace", 9) == 0)
4028 {
4029 unsigned n = parseNum(&argv[i][9], NetworkAdapterCount, "NIC");
4030 if (!n)
4031 return 1;
4032 if (argc <= i + 1)
4033 {
4034 return errorArgument("Missing argument to '%s'", argv[i]);
4035 }
4036 nictrace[n - 1] = argv[i + 1];
4037 i++;
4038 }
4039 else if (strncmp(argv[i], "-nictype", 8) == 0)
4040 {
4041 unsigned n = parseNum(&argv[i][8], NetworkAdapterCount, "NIC");
4042 if (!n)
4043 return 1;
4044 if (argc <= i + 1)
4045 {
4046 return errorArgument("Missing argument to '%s'", argv[i]);
4047 }
4048 nictype[n - 1] = argv[i + 1];
4049 i++;
4050 }
4051 else if (strncmp(argv[i], "-nicspeed", 9) == 0)
4052 {
4053 unsigned n = parseNum(&argv[i][9], NetworkAdapterCount, "NIC");
4054 if (!n)
4055 return 1;
4056 if (argc <= i + 1)
4057 {
4058 return errorArgument("Missing argument to '%s'", argv[i]);
4059 }
4060 nicspeed[n - 1] = argv[i + 1];
4061 i++;
4062 }
4063 else if (strncmp(argv[i], "-nic", 4) == 0)
4064 {
4065 unsigned n = parseNum(&argv[i][4], NetworkAdapterCount, "NIC");
4066 if (!n)
4067 return 1;
4068 if (argc <= i + 1)
4069 {
4070 return errorArgument("Missing argument to '%s'", argv[i]);
4071 }
4072 nics[n - 1] = argv[i + 1];
4073 i++;
4074 }
4075 else if (strncmp(argv[i], "-hostifdev", 10) == 0)
4076 {
4077 unsigned n = parseNum(&argv[i][10], NetworkAdapterCount, "NIC");
4078 if (!n)
4079 return 1;
4080 if (argc <= i + 1)
4081 {
4082 return errorArgument("Missing argument to '%s'", argv[i]);
4083 }
4084 hostifdev[n - 1] = argv[i + 1];
4085 i++;
4086 }
4087 else if (strncmp(argv[i], "-intnet", 7) == 0)
4088 {
4089 unsigned n = parseNum(&argv[i][7], NetworkAdapterCount, "NIC");
4090 if (!n)
4091 return 1;
4092 if (argc <= i + 1)
4093 {
4094 return errorArgument("Missing argument to '%s'", argv[i]);
4095 }
4096 intnet[n - 1] = argv[i + 1];
4097 i++;
4098 }
4099#ifdef RT_OS_LINUX
4100 else if (strncmp(argv[i], "-tapsetup", 9) == 0)
4101 {
4102 unsigned n = parseNum(&argv[i][9], NetworkAdapterCount, "NIC");
4103 if (!n)
4104 return 1;
4105 if (argc <= i + 1)
4106 {
4107 return errorArgument("Missing argument to '%s'", argv[i]);
4108 }
4109 tapsetup[n - 1] = argv[i + 1];
4110 i++;
4111 }
4112 else if (strncmp(argv[i], "-tapterminate", 13) == 0)
4113 {
4114 unsigned n = parseNum(&argv[i][13], NetworkAdapterCount, "NIC");
4115 if (!n)
4116 return 1;
4117 if (argc <= i + 1)
4118 {
4119 return errorArgument("Missing argument to '%s'", argv[i]);
4120 }
4121 tapterm[n - 1] = argv[i + 1];
4122 i++;
4123 }
4124#endif /* RT_OS_LINUX */
4125 else if (strncmp(argv[i], "-macaddress", 11) == 0)
4126 {
4127 unsigned n = parseNum(&argv[i][11], NetworkAdapterCount, "NIC");
4128 if (!n)
4129 return 1;
4130 if (argc <= i + 1)
4131 {
4132 return errorArgument("Missing argument to '%s'", argv[i]);
4133 }
4134 macs[n - 1] = argv[i + 1];
4135 i++;
4136 }
4137#ifdef VBOX_VRDP
4138 else if (strcmp(argv[i], "-vrdp") == 0)
4139 {
4140 if (argc <= i + 1)
4141 {
4142 return errorArgument("Missing argument to '%s'", argv[i]);
4143 }
4144 i++;
4145 vrdp = argv[i];
4146 }
4147 else if (strcmp(argv[i], "-vrdpport") == 0)
4148 {
4149 if (argc <= i + 1)
4150 {
4151 return errorArgument("Missing argument to '%s'", argv[i]);
4152 }
4153 i++;
4154 if (strcmp(argv[i], "default") == 0)
4155 vrdpport = 0;
4156 else
4157 vrdpport = atoi(argv[i]);
4158 }
4159 else if (strcmp(argv[i], "-vrdpaddress") == 0)
4160 {
4161 if (argc <= i + 1)
4162 {
4163 return errorArgument("Missing argument to '%s'", argv[i]);
4164 }
4165 i++;
4166 vrdpaddress = argv[i];
4167 }
4168 else if (strcmp(argv[i], "-vrdpauthtype") == 0)
4169 {
4170 if (argc <= i + 1)
4171 {
4172 return errorArgument("Missing argument to '%s'", argv[i]);
4173 }
4174 i++;
4175 vrdpauthtype = argv[i];
4176 }
4177 else if (strcmp(argv[i], "-vrdpmulticon") == 0)
4178 {
4179 if (argc <= i + 1)
4180 {
4181 return errorArgument("Missing argument to '%s'", argv[i]);
4182 }
4183 i++;
4184 vrdpmulticon = argv[i];
4185 }
4186#endif /* VBOX_VRDP */
4187 else if (strcmp(argv[i], "-usb") == 0)
4188 {
4189 if (argc <= i + 1)
4190 {
4191 return errorArgument("Missing argument to '%s'", argv[i]);
4192 }
4193 i++;
4194 if (strcmp(argv[i], "on") == 0 || strcmp(argv[i], "enable") == 0)
4195 fUsbEnabled = 1;
4196 else if (strcmp(argv[i], "off") == 0 || strcmp(argv[i], "disable") == 0)
4197 fUsbEnabled = 0;
4198 else
4199 return errorArgument("Invalid -usb argument '%s'", argv[i]);
4200 }
4201 else if (strcmp(argv[i], "-usbehci") == 0)
4202 {
4203 if (argc <= i + 1)
4204 {
4205 return errorArgument("Missing argument to '%s'", argv[i]);
4206 }
4207 i++;
4208 if (strcmp(argv[i], "on") == 0 || strcmp(argv[i], "enable") == 0)
4209 fUsbEhciEnabled = 1;
4210 else if (strcmp(argv[i], "off") == 0 || strcmp(argv[i], "disable") == 0)
4211 fUsbEhciEnabled = 0;
4212 else
4213 return errorArgument("Invalid -usbehci argument '%s'", argv[i]);
4214 }
4215 else if (strcmp(argv[i], "-snapshotfolder") == 0)
4216 {
4217 if (argc <= i + 1)
4218 {
4219 return errorArgument("Missing argument to '%s'", argv[i]);
4220 }
4221 i++;
4222 snapshotFolder = argv[i];
4223 }
4224 else if (strncmp(argv[i], "-uartmode", 9) == 0)
4225 {
4226 unsigned n = parseNum(&argv[i][9], SerialPortCount, "UART");
4227 if (!n)
4228 return 1;
4229 i++;
4230 if (strcmp(argv[i], "disconnected") == 0)
4231 {
4232 uarts_mode[n - 1] = argv[i];
4233 }
4234 else
4235 {
4236 if (strcmp(argv[i], "server") == 0 || strcmp(argv[i], "client") == 0)
4237 {
4238 uarts_mode[n - 1] = argv[i];
4239 i++;
4240#ifdef RT_OS_WINDOWS
4241 if (strncmp(argv[i], "\\\\.\\pipe\\", 9))
4242 return errorArgument("Uart pipe must start with \\\\.\\pipe\\");
4243#endif
4244 }
4245 else
4246 {
4247 uarts_mode[n - 1] = (char*)"device";
4248 }
4249 if (argc <= i)
4250 {
4251 return errorArgument("Missing argument to -uartmode");
4252 }
4253 uarts_path[n - 1] = argv[i];
4254 }
4255 }
4256 else if (strncmp(argv[i], "-uart", 5) == 0)
4257 {
4258 unsigned n = parseNum(&argv[i][5], SerialPortCount, "UART");
4259 if (!n)
4260 return 1;
4261 if (argc <= i + 1)
4262 {
4263 return errorArgument("Missing argument to '%s'", argv[i]);
4264 }
4265 i++;
4266 if (strcmp(argv[i], "off") == 0 || strcmp(argv[i], "disable") == 0)
4267 {
4268 uarts_base[n - 1] = (ULONG)-1;
4269 }
4270 else
4271 {
4272 if (argc <= i + 1)
4273 {
4274 return errorArgument("Missing argument to '%s'", argv[i-1]);
4275 }
4276 uint32_t uVal;
4277 int vrc;
4278 vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal);
4279 if (vrc != VINF_SUCCESS || uVal == 0)
4280 return errorArgument("Error parsing UART I/O base '%s'", argv[i]);
4281 uarts_base[n - 1] = uVal;
4282 i++;
4283 vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal);
4284 if (vrc != VINF_SUCCESS)
4285 return errorArgument("Error parsing UART IRQ '%s'", argv[i]);
4286 uarts_irq[n - 1] = uVal;
4287 }
4288 }
4289 else if (strncmp(argv[i], "-guestmemoryballoon", 19) == 0)
4290 {
4291 if (argc <= i + 1)
4292 return errorArgument("Missing argument to '%s'", argv[i]);
4293 i++;
4294 uint32_t uVal;
4295 int vrc;
4296 vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal);
4297 if (vrc != VINF_SUCCESS)
4298 return errorArgument("Error parsing guest memory balloon size '%s'", argv[i]);
4299 guestMemBalloonSize = uVal;
4300 }
4301 else if (strncmp(argv[i], "-gueststatisticsinterval", 24) == 0)
4302 {
4303 if (argc <= i + 1)
4304 return errorArgument("Missing argument to '%s'", argv[i]);
4305 i++;
4306 uint32_t uVal;
4307 int vrc;
4308 vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal);
4309 if (vrc != VINF_SUCCESS)
4310 return errorArgument("Error parsing guest statistics interval '%s'", argv[i]);
4311 guestStatInterval = uVal;
4312 }
4313 else
4314 {
4315 return errorSyntax(USAGE_MODIFYVM, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
4316 }
4317 }
4318
4319 /* try to find the given machine */
4320 ComPtr <IMachine> machine;
4321 Guid uuid (argv[0]);
4322 if (!uuid.isEmpty())
4323 {
4324 CHECK_ERROR (virtualBox, GetMachine (uuid, machine.asOutParam()));
4325 }
4326 else
4327 {
4328 CHECK_ERROR (virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
4329 if (SUCCEEDED (rc))
4330 machine->COMGETTER(Id)(uuid.asOutParam());
4331 }
4332 if (FAILED (rc))
4333 return 1;
4334
4335 /* open a session for the VM */
4336 CHECK_ERROR_RET (virtualBox, OpenSession(session, uuid), 1);
4337
4338 do
4339 {
4340 /* get the mutable session machine */
4341 session->COMGETTER(Machine)(machine.asOutParam());
4342
4343 ComPtr <IBIOSSettings> biosSettings;
4344 machine->COMGETTER(BIOSSettings)(biosSettings.asOutParam());
4345
4346 if (name)
4347 CHECK_ERROR(machine, COMSETTER(Name)(name));
4348 if (ostype)
4349 {
4350 ComPtr<IGuestOSType> guestOSType;
4351 CHECK_ERROR(virtualBox, GetGuestOSType(ostype, guestOSType.asOutParam()));
4352 if (SUCCEEDED(rc) && guestOSType)
4353 {
4354 CHECK_ERROR(machine, COMSETTER(OSTypeId)(ostype));
4355 }
4356 else
4357 {
4358 errorArgument("Invalid guest OS type '%s'", Utf8Str(ostype).raw());
4359 rc = E_FAIL;
4360 break;
4361 }
4362 }
4363 if (memorySize > 0)
4364 CHECK_ERROR(machine, COMSETTER(MemorySize)(memorySize));
4365 if (vramSize > 0)
4366 CHECK_ERROR(machine, COMSETTER(VRAMSize)(vramSize));
4367 if (acpi)
4368 {
4369 if (strcmp(acpi, "on") == 0)
4370 {
4371 CHECK_ERROR(biosSettings, COMSETTER(ACPIEnabled)(true));
4372 }
4373 else if (strcmp(acpi, "off") == 0)
4374 {
4375 CHECK_ERROR(biosSettings, COMSETTER(ACPIEnabled)(false));
4376 }
4377 else
4378 {
4379 errorArgument("Invalid -acpi argument '%s'", acpi);
4380 rc = E_FAIL;
4381 break;
4382 }
4383 }
4384 if (ioapic)
4385 {
4386 if (strcmp(ioapic, "on") == 0)
4387 {
4388 CHECK_ERROR(biosSettings, COMSETTER(IOAPICEnabled)(true));
4389 }
4390 else if (strcmp(ioapic, "off") == 0)
4391 {
4392 CHECK_ERROR(biosSettings, COMSETTER(IOAPICEnabled)(false));
4393 }
4394 else
4395 {
4396 errorArgument("Invalid -ioapic argument '%s'", ioapic);
4397 rc = E_FAIL;
4398 break;
4399 }
4400 }
4401 if (hwvirtex)
4402 {
4403 if (strcmp(hwvirtex, "on") == 0)
4404 {
4405 CHECK_ERROR(machine, COMSETTER(HWVirtExEnabled)(TSBool_True));
4406 }
4407 else if (strcmp(hwvirtex, "off") == 0)
4408 {
4409 CHECK_ERROR(machine, COMSETTER(HWVirtExEnabled)(TSBool_False));
4410 }
4411 else if (strcmp(hwvirtex, "default") == 0)
4412 {
4413 CHECK_ERROR(machine, COMSETTER(HWVirtExEnabled)(TSBool_Default));
4414 }
4415 else
4416 {
4417 errorArgument("Invalid -hwvirtex argument '%s'", hwvirtex);
4418 rc = E_FAIL;
4419 break;
4420 }
4421 }
4422 if (monitorcount != -1)
4423 {
4424 CHECK_ERROR(machine, COMSETTER(MonitorCount)(monitorcount));
4425 }
4426 if (bioslogofadein)
4427 {
4428 if (strcmp(bioslogofadein, "on") == 0)
4429 {
4430 CHECK_ERROR(biosSettings, COMSETTER(LogoFadeIn)(true));
4431 }
4432 else if (strcmp(bioslogofadein, "off") == 0)
4433 {
4434 CHECK_ERROR(biosSettings, COMSETTER(LogoFadeIn)(false));
4435 }
4436 else
4437 {
4438 errorArgument("Invalid -bioslogofadein argument '%s'", bioslogofadein);
4439 rc = E_FAIL;
4440 break;
4441 }
4442 }
4443 if (bioslogofadeout)
4444 {
4445 if (strcmp(bioslogofadeout, "on") == 0)
4446 {
4447 CHECK_ERROR(biosSettings, COMSETTER(LogoFadeOut)(true));
4448 }
4449 else if (strcmp(bioslogofadeout, "off") == 0)
4450 {
4451 CHECK_ERROR(biosSettings, COMSETTER(LogoFadeOut)(false));
4452 }
4453 else
4454 {
4455 errorArgument("Invalid -bioslogofadeout argument '%s'", bioslogofadeout);
4456 rc = E_FAIL;
4457 break;
4458 }
4459 }
4460 if (bioslogodisplaytime != ~0U)
4461 {
4462 CHECK_ERROR(biosSettings, COMSETTER(LogoDisplayTime)(bioslogodisplaytime));
4463 }
4464 if (bioslogoimagepath)
4465 {
4466 CHECK_ERROR(biosSettings, COMSETTER(LogoImagePath)(Bstr(bioslogoimagepath)));
4467 }
4468 if (biosbootmenumode)
4469 {
4470 if (strcmp(biosbootmenumode, "disabled") == 0)
4471 CHECK_ERROR(biosSettings, COMSETTER(BootMenuMode)(BIOSBootMenuMode_Disabled));
4472 else if (strcmp(biosbootmenumode, "menuonly") == 0)
4473 CHECK_ERROR(biosSettings, COMSETTER(BootMenuMode)(BIOSBootMenuMode_MenuOnly));
4474 else if (strcmp(biosbootmenumode, "messageandmenu") == 0)
4475 CHECK_ERROR(biosSettings, COMSETTER(BootMenuMode)(BIOSBootMenuMode_MessageAndMenu));
4476 else
4477 {
4478 errorArgument("Invalid -biosbootmenu argument '%s'", biosbootmenumode);
4479 rc = E_FAIL;
4480 break;
4481 }
4482
4483 }
4484 if (biossystemtimeoffset)
4485 {
4486 LONG64 timeOffset = RTStrToInt64(biossystemtimeoffset);
4487 CHECK_ERROR(biosSettings, COMSETTER(TimeOffset)(timeOffset));
4488 }
4489 if (biospxedebug)
4490 {
4491 if (strcmp(biospxedebug, "on") == 0)
4492 {
4493 CHECK_ERROR(biosSettings, COMSETTER(PXEDebugEnabled)(true));
4494 }
4495 else if (strcmp(biospxedebug, "off") == 0)
4496 {
4497 CHECK_ERROR(biosSettings, COMSETTER(PXEDebugEnabled)(false));
4498 }
4499 else
4500 {
4501 errorArgument("Invalid -biospxedebug argument '%s'", biospxedebug);
4502 rc = E_FAIL;
4503 break;
4504 }
4505 }
4506 for (int curBootDev = 0; curBootDev < 4; curBootDev++)
4507 {
4508 if (bootDeviceChanged[curBootDev])
4509 CHECK_ERROR(machine, SetBootOrder (curBootDev + 1, bootDevice[curBootDev]));
4510 }
4511 if (hdds[0])
4512 {
4513 if (strcmp(hdds[0], "none") == 0)
4514 {
4515 machine->DetachHardDisk(DiskControllerType_IDE0, 0);
4516 }
4517 else
4518 {
4519 /* first guess is that it's a UUID */
4520 Guid uuid(hdds[0]);
4521 ComPtr<IHardDisk> hardDisk;
4522 rc = virtualBox->GetHardDisk(uuid, hardDisk.asOutParam());
4523 /* not successful? Then it must be a filename */
4524 if (!hardDisk)
4525 {
4526 CHECK_ERROR(virtualBox, OpenHardDisk(Bstr(hdds[0]), hardDisk.asOutParam()));
4527 if (SUCCEEDED(rc) && hardDisk)
4528 {
4529 /* first check if it's already registered */
4530 Guid hddUUID;
4531 hardDisk->COMGETTER(Id)(hddUUID.asOutParam());
4532 ComPtr<IHardDisk> registeredHDD;
4533 rc = virtualBox->GetHardDisk(hddUUID, registeredHDD.asOutParam());
4534 if (SUCCEEDED(rc) && registeredHDD)
4535 hardDisk = registeredHDD;
4536 else
4537 {
4538 /* it has to be registered */
4539 CHECK_ERROR(virtualBox, RegisterHardDisk(hardDisk));
4540 if (FAILED(rc))
4541 break;
4542 }
4543 }
4544 }
4545 if (hardDisk)
4546 {
4547 hardDisk->COMGETTER(Id)(uuid.asOutParam());
4548 CHECK_ERROR(machine, AttachHardDisk(uuid, DiskControllerType_IDE0, 0));
4549 }
4550 else
4551 rc = E_FAIL;
4552 if (FAILED(rc))
4553 break;
4554 }
4555 }
4556 if (hdds[1])
4557 {
4558 if (strcmp(hdds[1], "none") == 0)
4559 {
4560 machine->DetachHardDisk(DiskControllerType_IDE0, 1);
4561 }
4562 else
4563 {
4564 /* first guess is that it's a UUID */
4565 Guid uuid(hdds[1]);
4566 ComPtr<IHardDisk> hardDisk;
4567 rc = virtualBox->GetHardDisk(uuid, hardDisk.asOutParam());
4568 /* not successful? Then it must be a filename */
4569 if (!hardDisk)
4570 {
4571 CHECK_ERROR(virtualBox, OpenHardDisk(Bstr(hdds[1]), hardDisk.asOutParam()));
4572 if (SUCCEEDED(rc) && hardDisk)
4573 {
4574 /* first check if it's already registered */
4575 Guid hddUUID;
4576 hardDisk->COMGETTER(Id)(hddUUID.asOutParam());
4577 ComPtr<IHardDisk> registeredHDD;
4578 rc = virtualBox->GetHardDisk(hddUUID, registeredHDD.asOutParam());
4579 if (SUCCEEDED(rc) && registeredHDD)
4580 hardDisk = registeredHDD;
4581 else
4582 {
4583 /* it has to be registered */
4584 CHECK_ERROR(virtualBox, RegisterHardDisk(hardDisk));
4585 if (FAILED(rc))
4586 break;
4587 }
4588 }
4589 }
4590 if (hardDisk)
4591 {
4592 hardDisk->COMGETTER(Id)(uuid.asOutParam());
4593 CHECK_ERROR(machine, AttachHardDisk(uuid, DiskControllerType_IDE0, 1));
4594 }
4595 else
4596 rc = E_FAIL;
4597 if (FAILED(rc))
4598 break;
4599 }
4600 }
4601 if (hdds[2])
4602 {
4603 if (strcmp(hdds[2], "none") == 0)
4604 {
4605 machine->DetachHardDisk(DiskControllerType_IDE1, 1);
4606 }
4607 else
4608 {
4609 /* first guess is that it's a UUID */
4610 Guid uuid(hdds[2]);
4611 ComPtr<IHardDisk> hardDisk;
4612 rc = virtualBox->GetHardDisk(uuid, hardDisk.asOutParam());
4613 /* not successful? Then it must be a filename */
4614 if (!hardDisk)
4615 {
4616 CHECK_ERROR(virtualBox, OpenHardDisk(Bstr(hdds[2]), hardDisk.asOutParam()));
4617 if (SUCCEEDED(rc) && hardDisk)
4618 {
4619 /* first check if it's already registered */
4620 Guid hddUUID;
4621 hardDisk->COMGETTER(Id)(hddUUID.asOutParam());
4622 ComPtr<IHardDisk> registeredHDD;
4623 rc = virtualBox->GetHardDisk(hddUUID, registeredHDD.asOutParam());
4624 if (SUCCEEDED(rc) && registeredHDD)
4625 hardDisk = registeredHDD;
4626 else
4627 {
4628 /* it has to be registered */
4629 CHECK_ERROR(virtualBox, RegisterHardDisk(hardDisk));
4630 if (FAILED(rc))
4631 break;
4632 }
4633 }
4634 }
4635 if (hardDisk)
4636 {
4637 hardDisk->COMGETTER(Id)(uuid.asOutParam());
4638 CHECK_ERROR(machine, AttachHardDisk(uuid, DiskControllerType_IDE1, 1));
4639 }
4640 else
4641 rc = E_FAIL;
4642 if (FAILED(rc))
4643 break;
4644 }
4645 }
4646 if (dvd)
4647 {
4648 ComPtr<IDVDDrive> dvdDrive;
4649 machine->COMGETTER(DVDDrive)(dvdDrive.asOutParam());
4650 ASSERT(dvdDrive);
4651
4652 /* unmount? */
4653 if (strcmp(dvd, "none") == 0)
4654 {
4655 CHECK_ERROR(dvdDrive, Unmount());
4656 }
4657 /* host drive? */
4658 else if (strncmp(dvd, "host:", 5) == 0)
4659 {
4660 ComPtr<IHost> host;
4661 CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam()));
4662 ComPtr<IHostDVDDriveCollection> hostDVDs;
4663 CHECK_ERROR(host, COMGETTER(DVDDrives)(hostDVDs.asOutParam()));
4664 ComPtr<IHostDVDDrive> hostDVDDrive;
4665 rc = hostDVDs->FindByName(Bstr(dvd + 5), hostDVDDrive.asOutParam());
4666 if (!hostDVDDrive)
4667 {
4668 /* 2nd try: try with the real name, important on Linux+libhal */
4669 char szPathReal[RTPATH_MAX];
4670 if (VBOX_FAILURE(RTPathReal(dvd + 5, szPathReal, sizeof(szPathReal))))
4671 {
4672 errorArgument("Invalid host DVD drive name");
4673 rc = E_FAIL;
4674 break;
4675 }
4676 rc = hostDVDs->FindByName(Bstr(szPathReal), hostDVDDrive.asOutParam());
4677 if (!hostDVDDrive)
4678 {
4679 errorArgument("Invalid host DVD drive name");
4680 rc = E_FAIL;
4681 break;
4682 }
4683 }
4684 CHECK_ERROR(dvdDrive, CaptureHostDrive(hostDVDDrive));
4685 }
4686 else
4687 {
4688 /* first assume it's a UUID */
4689 Guid uuid(dvd);
4690 ComPtr<IDVDImage> dvdImage;
4691 rc = virtualBox->GetDVDImage(uuid, dvdImage.asOutParam());
4692 if (FAILED(rc) || !dvdImage)
4693 {
4694 /* must be a filename, check if it's in the collection */
4695 ComPtr<IDVDImageCollection> dvdImages;
4696 virtualBox->COMGETTER(DVDImages)(dvdImages.asOutParam());
4697 rc = dvdImages->FindByPath(Bstr(dvd), dvdImage.asOutParam());
4698 /* not registered, do that on the fly */
4699 if (!dvdImage)
4700 {
4701 Guid emptyUUID;
4702 CHECK_ERROR(virtualBox, OpenDVDImage(Bstr(dvd), emptyUUID, dvdImage.asOutParam()));
4703 if (SUCCEEDED(rc) && dvdImage)
4704 {
4705 /* time to register the image */
4706 CHECK_ERROR(virtualBox, RegisterDVDImage(dvdImage));
4707 }
4708 }
4709 }
4710 if (!dvdImage)
4711 {
4712 rc = E_FAIL;
4713 break;
4714 }
4715
4716 dvdImage->COMGETTER(Id)(uuid.asOutParam());
4717 CHECK_ERROR(dvdDrive, MountImage(uuid));
4718 }
4719 }
4720 if (dvdpassthrough)
4721 {
4722 ComPtr<IDVDDrive> dvdDrive;
4723 machine->COMGETTER(DVDDrive)(dvdDrive.asOutParam());
4724 ASSERT(dvdDrive);
4725
4726 CHECK_ERROR(dvdDrive, COMSETTER(Passthrough)(strcmp(dvdpassthrough, "on") == 0));
4727 }
4728 if (floppy)
4729 {
4730 ComPtr<IFloppyDrive> floppyDrive;
4731 machine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());
4732 ASSERT(floppyDrive);
4733
4734 /* disable? */
4735 if (strcmp(floppy, "disabled") == 0)
4736 {
4737 /* disable the controller */
4738 CHECK_ERROR(floppyDrive, COMSETTER(Enabled)(false));
4739 }
4740 else
4741 {
4742 /* enable the controller */
4743 CHECK_ERROR(floppyDrive, COMSETTER(Enabled)(true));
4744
4745 /* unmount? */
4746 if (strcmp(floppy, "empty") == 0)
4747 {
4748 CHECK_ERROR(floppyDrive, Unmount());
4749 }
4750 /* host drive? */
4751 else if (strncmp(floppy, "host:", 5) == 0)
4752 {
4753 ComPtr<IHost> host;
4754 CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam()));
4755 ComPtr<IHostFloppyDriveCollection> hostFloppies;
4756 CHECK_ERROR(host, COMGETTER(FloppyDrives)(hostFloppies.asOutParam()));
4757 ComPtr<IHostFloppyDrive> hostFloppyDrive;
4758 rc = hostFloppies->FindByName(Bstr(floppy + 5), hostFloppyDrive.asOutParam());
4759 if (!hostFloppyDrive)
4760 {
4761 errorArgument("Invalid host floppy drive name");
4762 rc = E_FAIL;
4763 break;
4764 }
4765 CHECK_ERROR(floppyDrive, CaptureHostDrive(hostFloppyDrive));
4766 }
4767 else
4768 {
4769 /* first assume it's a UUID */
4770 Guid uuid(floppy);
4771 ComPtr<IFloppyImage> floppyImage;
4772 rc = virtualBox->GetFloppyImage(uuid, floppyImage.asOutParam());
4773 if (FAILED(rc) || !floppyImage)
4774 {
4775 /* must be a filename */
4776 Guid emptyUUID;
4777 CHECK_ERROR(virtualBox, OpenFloppyImage(Bstr(floppy), emptyUUID, floppyImage.asOutParam()));
4778 if (SUCCEEDED(rc) && floppyImage)
4779 {
4780 /** @todo first iterate through the collection and try to find the image */
4781 /* time to register the image */
4782 CHECK_ERROR(virtualBox, RegisterFloppyImage(floppyImage));
4783 }
4784 }
4785 if (!floppyImage)
4786 {
4787 rc = E_FAIL;
4788 break;
4789 }
4790
4791 floppyImage->COMGETTER(Id)(uuid.asOutParam());
4792 CHECK_ERROR(floppyDrive, MountImage(uuid));
4793 }
4794 }
4795 }
4796 if (audio || audiocontroller)
4797 {
4798 ComPtr<IAudioAdapter> audioAdapter;
4799 machine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam());
4800 ASSERT(audioAdapter);
4801
4802 if (audio)
4803 {
4804 /* disable? */
4805 if (strcmp(audio, "none") == 0)
4806 {
4807 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(false));
4808 }
4809 else if (strcmp(audio, "null") == 0)
4810 {
4811 CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_Null));
4812 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true));
4813 }
4814#ifdef RT_OS_WINDOWS
4815#ifdef VBOX_WITH_WINMM
4816 else if (strcmp(audio, "winmm") == 0)
4817 {
4818 CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_WINMM));
4819 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true));
4820 }
4821#endif
4822 else if (strcmp(audio, "dsound") == 0)
4823 {
4824 CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_DSOUND));
4825 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true));
4826 }
4827#endif /* RT_OS_WINDOWS */
4828#ifdef RT_OS_LINUX
4829 else if (strcmp(audio, "oss") == 0)
4830 {
4831 CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_OSS));
4832 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true));
4833 }
4834# ifdef VBOX_WITH_ALSA
4835 else if (strcmp(audio, "alsa") == 0)
4836 {
4837 CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_ALSA));
4838 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true));
4839 }
4840# endif
4841# ifdef VBOX_WITH_PULSE
4842 else if (strcmp(audio, "pulse") == 0)
4843 {
4844 CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_Pulse));
4845 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true));
4846 }
4847# endif
4848#endif /* !RT_OS_LINUX */
4849#ifdef RT_OS_DARWIN
4850 else if (strcmp(audio, "coreaudio") == 0)
4851 {
4852 CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_Core));
4853 CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true));
4854 }
4855
4856#endif /* !RT_OS_DARWIN */
4857 else
4858 {
4859 errorArgument("Invalid -audio argument '%s'", audio);
4860 rc = E_FAIL;
4861 break;
4862 }
4863 }
4864 if (audiocontroller)
4865 {
4866 if (strcmp(audiocontroller, "sb16") == 0)
4867 CHECK_ERROR(audioAdapter, COMSETTER(AudioController)(AudioControllerType_SB16));
4868 else if (strcmp(audiocontroller, "ac97") == 0)
4869 CHECK_ERROR(audioAdapter, COMSETTER(AudioController)(AudioControllerType_AC97));
4870 else
4871 {
4872 errorArgument("Invalid -audiocontroller argument '%s'", audiocontroller);
4873 rc = E_FAIL;
4874 break;
4875 }
4876 }
4877 }
4878 /* Shared clipboard state */
4879 if (clipboard)
4880 {
4881/* ComPtr<IClipboardMode> clipboardMode;
4882 machine->COMGETTER(ClipboardMode)(clipboardMode.asOutParam());
4883 ASSERT(clipboardMode);
4884*/
4885 if (strcmp(clipboard, "disabled") == 0)
4886 {
4887 CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_Disabled));
4888 }
4889 else if (strcmp(clipboard, "hosttoguest") == 0)
4890 {
4891 CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_HostToGuest));
4892 }
4893 else if (strcmp(clipboard, "guesttohost") == 0)
4894 {
4895 CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_GuestToHost));
4896 }
4897 else if (strcmp(clipboard, "bidirectional") == 0)
4898 {
4899 CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_Bidirectional));
4900 }
4901 else
4902 {
4903 errorArgument("Invalid -clipboard argument '%s'", clipboard);
4904 rc = E_FAIL;
4905 break;
4906 }
4907 }
4908 /* iterate through all possible NICs */
4909 for (ULONG n = 0; n < NetworkAdapterCount; n ++)
4910 {
4911 ComPtr<INetworkAdapter> nic;
4912 CHECK_ERROR_RET (machine, GetNetworkAdapter (n, nic.asOutParam()), 1);
4913
4914 ASSERT(nic);
4915
4916 /* something about the NIC? */
4917 if (nics[n])
4918 {
4919 if (strcmp(nics[n], "none") == 0)
4920 {
4921 CHECK_ERROR_RET(nic, COMSETTER(Enabled) (FALSE), 1);
4922 }
4923 else if (strcmp(nics[n], "null") == 0)
4924 {
4925 CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1);
4926 CHECK_ERROR_RET(nic, Detach(), 1);
4927 }
4928 else if (strcmp(nics[n], "nat") == 0)
4929 {
4930 CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1);
4931 CHECK_ERROR_RET(nic, AttachToNAT(), 1);
4932 }
4933 else if (strcmp(nics[n], "hostif") == 0)
4934 {
4935 CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1);
4936 CHECK_ERROR_RET(nic, AttachToHostInterface(), 1);
4937 }
4938 else if (strcmp(nics[n], "intnet") == 0)
4939 {
4940 CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1);
4941 CHECK_ERROR_RET(nic, AttachToInternalNetwork(), 1);
4942 }
4943 else
4944 {
4945 errorArgument("Invalid type '%s' specfied for NIC %lu", nics[n], n + 1);
4946 rc = E_FAIL;
4947 break;
4948 }
4949 }
4950
4951 /* something about the NIC type? */
4952 if (nictype[n])
4953 {
4954 if (strcmp(nictype[n], "Am79C970A") == 0)
4955 {
4956 CHECK_ERROR_RET(nic, COMSETTER(AdapterType)(NetworkAdapterType_Am79C970A), 1);
4957 }
4958 else if (strcmp(nictype[n], "Am79C973") == 0)
4959 {
4960 CHECK_ERROR_RET(nic, COMSETTER(AdapterType)(NetworkAdapterType_Am79C973), 1);
4961 }
4962#ifdef VBOX_WITH_E1000
4963 else if (strcmp(nictype[n], "82540EM") == 0)
4964 {
4965 CHECK_ERROR_RET(nic, COMSETTER(AdapterType)(NetworkAdapterType_I82540EM), 1);
4966 }
4967#endif
4968 else
4969 {
4970 errorArgument("Invalid NIC type '%s' specified for NIC %lu", nictype[n], n + 1);
4971 rc = E_FAIL;
4972 break;
4973 }
4974 }
4975
4976 /* something about the MAC address? */
4977 if (macs[n])
4978 {
4979 /* generate one? */
4980 if (strcmp(macs[n], "auto") == 0)
4981 {
4982 CHECK_ERROR_RET(nic, COMSETTER(MACAddress)(NULL), 1);
4983 }
4984 else
4985 {
4986 CHECK_ERROR_RET(nic, COMSETTER(MACAddress)(Bstr(macs[n])), 1);
4987 }
4988 }
4989
4990 /* something about the reported link speed? */
4991 if (nicspeed[n])
4992 {
4993 uint32_t u32LineSpeed;
4994
4995 u32LineSpeed = atoi(nicspeed[n]);
4996
4997 if (u32LineSpeed < 1000 || u32LineSpeed > 4000000)
4998 {
4999 errorArgument("Invalid -nicspeed%lu argument '%s'", n + 1, nicspeed[n]);
5000 rc = E_FAIL;
5001 break;
5002 }
5003 CHECK_ERROR_RET(nic, COMSETTER(LineSpeed)(u32LineSpeed), 1);
5004 }
5005
5006 /* the link status flag? */
5007 if (cableconnected[n])
5008 {
5009 if (strcmp(cableconnected[n], "on") == 0)
5010 {
5011 CHECK_ERROR_RET(nic, COMSETTER(CableConnected)(TRUE), 1);
5012 }
5013 else if (strcmp(cableconnected[n], "off") == 0)
5014 {
5015 CHECK_ERROR_RET(nic, COMSETTER(CableConnected)(FALSE), 1);
5016 }
5017 else
5018 {
5019 errorArgument("Invalid -cableconnected%lu argument '%s'", n + 1, cableconnected[n]);
5020 rc = E_FAIL;
5021 break;
5022 }
5023 }
5024
5025 /* the trace flag? */
5026 if (nictrace[n])
5027 {
5028 if (strcmp(nictrace[n], "on") == 0)
5029 {
5030 CHECK_ERROR_RET(nic, COMSETTER(TraceEnabled)(TRUE), 1);
5031 }
5032 else if (strcmp(nictrace[n], "off") == 0)
5033 {
5034 CHECK_ERROR_RET(nic, COMSETTER(TraceEnabled)(FALSE), 1);
5035 }
5036 else
5037 {
5038 errorArgument("Invalid -nictrace%lu argument '%s'", n + 1, nictrace[n]);
5039 rc = E_FAIL;
5040 break;
5041 }
5042 }
5043
5044 /* the tracefile flag? */
5045 if (nictracefile[n])
5046 {
5047 CHECK_ERROR_RET(nic, COMSETTER(TraceFile)(Bstr(nictracefile[n])), 1);
5048 }
5049
5050 /* the host interface device? */
5051 if (hostifdev[n])
5052 {
5053 /* remove it? */
5054 if (strcmp(hostifdev[n], "none") == 0)
5055 {
5056 CHECK_ERROR_RET(nic, COMSETTER(HostInterface)(NULL), 1);
5057 }
5058 else
5059 {
5060 CHECK_ERROR_RET(nic, COMSETTER(HostInterface)(Bstr(hostifdev[n])), 1);
5061 }
5062 }
5063
5064 /* the internal network name? */
5065 if (intnet[n])
5066 {
5067 /* remove it? */
5068 if (strcmp(intnet[n], "none") == 0)
5069 {
5070 CHECK_ERROR_RET(nic, COMSETTER(InternalNetwork)(NULL), 1);
5071 }
5072 else
5073 {
5074 CHECK_ERROR_RET(nic, COMSETTER(InternalNetwork)(Bstr(intnet[n])), 1);
5075 }
5076 }
5077
5078#ifdef RT_OS_LINUX
5079 /* the TAP setup application? */
5080 if (tapsetup[n])
5081 {
5082 /* remove it? */
5083 if (strcmp(tapsetup[n], "none") == 0)
5084 {
5085 CHECK_ERROR_RET(nic, COMSETTER(TAPSetupApplication)(NULL), 1);
5086 }
5087 else
5088 {
5089 CHECK_ERROR_RET(nic, COMSETTER(TAPSetupApplication)(Bstr(tapsetup[n])), 1);
5090 }
5091 }
5092
5093 /* the TAP terminate application? */
5094 if (tapterm[n])
5095 {
5096 /* remove it? */
5097 if (strcmp(tapterm[n], "none") == 0)
5098 {
5099 CHECK_ERROR_RET(nic, COMSETTER(TAPTerminateApplication)(NULL), 1);
5100 }
5101 else
5102 {
5103 CHECK_ERROR_RET(nic, COMSETTER(TAPTerminateApplication)(Bstr(tapterm[n])), 1);
5104 }
5105 }
5106#endif /* RT_OS_LINUX */
5107
5108 }
5109 if (FAILED(rc))
5110 break;
5111
5112 /* iterate through all possible serial ports */
5113 for (ULONG n = 0; n < SerialPortCount; n ++)
5114 {
5115 ComPtr<ISerialPort> uart;
5116 CHECK_ERROR_RET (machine, GetSerialPort (n, uart.asOutParam()), 1);
5117
5118 ASSERT(uart);
5119
5120 if (uarts_base[n])
5121 {
5122 if (uarts_base[n] == (ULONG)-1)
5123 {
5124 CHECK_ERROR_RET(uart, COMSETTER(Enabled) (FALSE), 1);
5125 }
5126 else
5127 {
5128 CHECK_ERROR_RET(uart, COMSETTER(IOBase) (uarts_base[n]), 1);
5129 CHECK_ERROR_RET(uart, COMSETTER(IRQ) (uarts_irq[n]), 1);
5130 CHECK_ERROR_RET(uart, COMSETTER(Enabled) (TRUE), 1);
5131 }
5132 }
5133 if (uarts_mode[n])
5134 {
5135 if (strcmp(uarts_mode[n], "disconnected") == 0)
5136 {
5137 CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_Disconnected), 1);
5138 }
5139 else
5140 {
5141 if (strcmp(uarts_mode[n], "server") == 0)
5142 {
5143 CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_HostPipe), 1);
5144 CHECK_ERROR_RET(uart, COMSETTER(Server) (TRUE), 1);
5145 }
5146 else if (strcmp(uarts_mode[n], "client") == 0)
5147 {
5148 CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_HostPipe), 1);
5149 CHECK_ERROR_RET(uart, COMSETTER(Server) (FALSE), 1);
5150 }
5151 else
5152 {
5153 CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_HostDevice), 1);
5154 }
5155 CHECK_ERROR_RET(uart, COMSETTER(Path) (Bstr(uarts_path[n])), 1);
5156 }
5157 }
5158 }
5159 if (FAILED(rc))
5160 break;
5161
5162#ifdef VBOX_VRDP
5163 if (vrdp || (vrdpport != UINT16_MAX) || vrdpaddress || vrdpauthtype || vrdpmulticon)
5164 {
5165 ComPtr<IVRDPServer> vrdpServer;
5166 machine->COMGETTER(VRDPServer)(vrdpServer.asOutParam());
5167 ASSERT(vrdpServer);
5168 if (vrdpServer)
5169 {
5170 if (vrdp)
5171 {
5172 if (strcmp(vrdp, "on") == 0)
5173 {
5174 CHECK_ERROR(vrdpServer, COMSETTER(Enabled)(true));
5175 }
5176 else if (strcmp(vrdp, "off") == 0)
5177 {
5178 CHECK_ERROR(vrdpServer, COMSETTER(Enabled)(false));
5179 }
5180 else
5181 {
5182 errorArgument("Invalid -vrdp argument '%s'", vrdp);
5183 rc = E_FAIL;
5184 break;
5185 }
5186 }
5187 if (vrdpport != UINT16_MAX)
5188 {
5189 CHECK_ERROR(vrdpServer, COMSETTER(Port)(vrdpport));
5190 }
5191 if (vrdpaddress)
5192 {
5193 CHECK_ERROR(vrdpServer, COMSETTER(NetAddress)(Bstr(vrdpaddress)));
5194 }
5195 if (vrdpauthtype)
5196 {
5197 if (strcmp(vrdpauthtype, "null") == 0)
5198 {
5199 CHECK_ERROR(vrdpServer, COMSETTER(AuthType)(VRDPAuthType_Null));
5200 }
5201 else if (strcmp(vrdpauthtype, "external") == 0)
5202 {
5203 CHECK_ERROR(vrdpServer, COMSETTER(AuthType)(VRDPAuthType_External));
5204 }
5205 else if (strcmp(vrdpauthtype, "guest") == 0)
5206 {
5207 CHECK_ERROR(vrdpServer, COMSETTER(AuthType)(VRDPAuthType_Guest));
5208 }
5209 else
5210 {
5211 errorArgument("Invalid -vrdpauthtype argument '%s'", vrdpauthtype);
5212 rc = E_FAIL;
5213 break;
5214 }
5215 }
5216 if (vrdpmulticon)
5217 {
5218 if (strcmp(vrdpmulticon, "on") == 0)
5219 {
5220 CHECK_ERROR(vrdpServer, COMSETTER(AllowMultiConnection)(true));
5221 }
5222 else if (strcmp(vrdpmulticon, "off") == 0)
5223 {
5224 CHECK_ERROR(vrdpServer, COMSETTER(AllowMultiConnection)(false));
5225 }
5226 else
5227 {
5228 errorArgument("Invalid -vrdpmulticon argument '%s'", vrdpmulticon);
5229 rc = E_FAIL;
5230 break;
5231 }
5232 }
5233 }
5234 }
5235#endif /* VBOX_VRDP */
5236
5237 /*
5238 * USB enable/disable
5239 */
5240 if (fUsbEnabled != -1)
5241 {
5242 ComPtr<IUSBController> UsbCtl;
5243 CHECK_ERROR(machine, COMGETTER(USBController)(UsbCtl.asOutParam()));
5244 if (SUCCEEDED(rc))
5245 {
5246 CHECK_ERROR(UsbCtl, COMSETTER(Enabled)(!!fUsbEnabled));
5247 }
5248 }
5249 /*
5250 * USB EHCI enable/disable
5251 */
5252 if (fUsbEhciEnabled != -1)
5253 {
5254 ComPtr<IUSBController> UsbCtl;
5255 CHECK_ERROR(machine, COMGETTER(USBController)(UsbCtl.asOutParam()));
5256 if (SUCCEEDED(rc))
5257 {
5258 CHECK_ERROR(UsbCtl, COMSETTER(EnabledEhci)(!!fUsbEhciEnabled));
5259 }
5260 }
5261
5262 if (snapshotFolder)
5263 {
5264 if (strcmp(snapshotFolder, "default") == 0)
5265 {
5266 CHECK_ERROR(machine, COMSETTER(SnapshotFolder)(NULL));
5267 }
5268 else
5269 {
5270 CHECK_ERROR(machine, COMSETTER(SnapshotFolder)(Bstr(snapshotFolder)));
5271 }
5272 }
5273
5274 if (guestMemBalloonSize != (ULONG)-1)
5275 CHECK_ERROR(machine, COMSETTER(MemoryBalloonSize)(guestMemBalloonSize));
5276
5277 if (guestStatInterval != (ULONG)-1)
5278 CHECK_ERROR(machine, COMSETTER(StatisticsUpdateInterval)(guestStatInterval));
5279
5280 /* commit changes */
5281 CHECK_ERROR(machine, SaveSettings());
5282 }
5283 while (0);
5284
5285 /* it's important to always close sessions */
5286 session->Close();
5287
5288 return SUCCEEDED(rc) ? 0 : 1;
5289}
5290
5291static int handleStartVM(int argc, char *argv[],
5292 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
5293{
5294 HRESULT rc;
5295
5296 if (argc < 1)
5297 {
5298 return errorSyntax(USAGE_STARTVM, "Not enough parameters");
5299 }
5300
5301 ComPtr<IMachine> machine;
5302 /* assume it's a UUID */
5303 rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam());
5304 if (FAILED(rc) || !machine)
5305 {
5306 /* must be a name */
5307 CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
5308 }
5309 if (machine)
5310 {
5311 Guid uuid;
5312 machine->COMGETTER(Id)(uuid.asOutParam());
5313
5314 /* default to GUI session type */
5315 Bstr sessionType = "gui";
5316 /* has a session type been specified? */
5317 if ((argc > 2) && (strcmp(argv[1], "-type") == 0))
5318 {
5319 if (strcmp(argv[2], "gui") == 0)
5320 {
5321 sessionType = "gui";
5322 }
5323 else if (strcmp(argv[2], "vrdp") == 0)
5324 {
5325 sessionType = "vrdp";
5326 }
5327 else if (strcmp(argv[2], "capture") == 0)
5328 {
5329 sessionType = "capture";
5330 }
5331 else
5332 {
5333 return errorArgument("Invalid session type argument '%s'", argv[2]);
5334 }
5335 }
5336
5337 Bstr env;
5338#ifdef RT_OS_LINUX
5339 /* make sure the VM process will start on the same display as VBoxManage */
5340 {
5341 const char *display = RTEnvGet ("DISPLAY");
5342 if (display)
5343 env = Utf8StrFmt ("DISPLAY=%s", display);
5344 }
5345#endif
5346 ComPtr<IProgress> progress;
5347 CHECK_ERROR_RET(virtualBox, OpenRemoteSession(session, uuid, sessionType,
5348 env, progress.asOutParam()), rc);
5349 RTPrintf("Waiting for the remote session to open...\n");
5350 CHECK_ERROR_RET(progress, WaitForCompletion (-1), 1);
5351
5352 BOOL completed;
5353 CHECK_ERROR_RET(progress, COMGETTER(Completed)(&completed), rc);
5354 ASSERT(completed);
5355
5356 HRESULT resultCode;
5357 CHECK_ERROR_RET(progress, COMGETTER(ResultCode)(&resultCode), rc);
5358 if (FAILED(resultCode))
5359 {
5360 ComPtr <IVirtualBoxErrorInfo> errorInfo;
5361 CHECK_ERROR_RET(progress, COMGETTER(ErrorInfo)(errorInfo.asOutParam()), 1);
5362 ErrorInfo info (errorInfo);
5363 PRINT_ERROR_INFO(info);
5364 }
5365 else
5366 {
5367 RTPrintf("Remote session has been successfully opened.\n");
5368 }
5369 }
5370
5371 /* it's important to always close sessions */
5372 session->Close();
5373
5374 return SUCCEEDED(rc) ? 0 : 1;
5375}
5376
5377static int handleControlVM(int argc, char *argv[],
5378 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
5379{
5380 HRESULT rc;
5381
5382 if (argc < 2)
5383 {
5384 return errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
5385 }
5386
5387 /* try to find the given machine */
5388 ComPtr <IMachine> machine;
5389 Guid uuid (argv[0]);
5390 if (!uuid.isEmpty())
5391 {
5392 CHECK_ERROR (virtualBox, GetMachine (uuid, machine.asOutParam()));
5393 }
5394 else
5395 {
5396 CHECK_ERROR (virtualBox, FindMachine (Bstr(argv[0]), machine.asOutParam()));
5397 if (SUCCEEDED (rc))
5398 machine->COMGETTER(Id) (uuid.asOutParam());
5399 }
5400 if (FAILED (rc))
5401 return 1;
5402
5403 /* open a session for the VM */
5404 CHECK_ERROR_RET (virtualBox, OpenExistingSession (session, uuid), 1);
5405
5406 do
5407 {
5408 /* get the associated console */
5409 ComPtr<IConsole> console;
5410 CHECK_ERROR_BREAK (session, COMGETTER(Console)(console.asOutParam()));
5411 /* ... and session machine */
5412 ComPtr<IMachine> sessionMachine;
5413 CHECK_ERROR_BREAK (session, COMGETTER(Machine)(sessionMachine.asOutParam()));
5414
5415 /* which command? */
5416 if (strcmp(argv[1], "pause") == 0)
5417 {
5418 CHECK_ERROR_BREAK (console, Pause());
5419 }
5420 else if (strcmp(argv[1], "resume") == 0)
5421 {
5422 CHECK_ERROR_BREAK (console, Resume());
5423 }
5424 else if (strcmp(argv[1], "reset") == 0)
5425 {
5426 CHECK_ERROR_BREAK (console, Reset());
5427 }
5428 else if (strcmp(argv[1], "poweroff") == 0)
5429 {
5430 CHECK_ERROR_BREAK (console, PowerDown());
5431 }
5432 else if (strcmp(argv[1], "savestate") == 0)
5433 {
5434 ComPtr<IProgress> progress;
5435 CHECK_ERROR_BREAK (console, SaveState(progress.asOutParam()));
5436
5437 showProgress(progress);
5438
5439 progress->COMGETTER(ResultCode)(&rc);
5440 if (FAILED(rc))
5441 {
5442 com::ProgressErrorInfo info(progress);
5443 if (info.isBasicAvailable())
5444 {
5445 RTPrintf("Error: failed to save machine state. Error message: %lS\n", info.getText().raw());
5446 }
5447 else
5448 {
5449 RTPrintf("Error: failed to save machine state. No error message available!\n");
5450 }
5451 }
5452 }
5453 else if (strcmp(argv[1], "acpipowerbutton") == 0)
5454 {
5455 CHECK_ERROR_BREAK (console, PowerButton());
5456 }
5457 else if (strcmp(argv[1], "acpisleepbutton") == 0)
5458 {
5459 CHECK_ERROR_BREAK (console, SleepButton());
5460 }
5461 else if (strncmp(argv[1], "setlinkstate", 12) == 0)
5462 {
5463 /* Get the number of network adapters */
5464 ULONG NetworkAdapterCount = 0;
5465 ComPtr <ISystemProperties> info;
5466 CHECK_ERROR_BREAK (virtualBox, COMGETTER(SystemProperties) (info.asOutParam()));
5467 CHECK_ERROR_BREAK (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount));
5468
5469 unsigned n = parseNum(&argv[1][12], NetworkAdapterCount, "NIC");
5470 if (!n)
5471 {
5472 rc = E_FAIL;
5473 break;
5474 }
5475 if (argc <= 1 + 1)
5476 {
5477 errorArgument("Missing argument to '%s'", argv[1]);
5478 rc = E_FAIL;
5479 break;
5480 }
5481 /* get the corresponding network adapter */
5482 ComPtr<INetworkAdapter> adapter;
5483 CHECK_ERROR_BREAK (sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
5484 if (adapter)
5485 {
5486 if (strcmp(argv[2], "on") == 0)
5487 {
5488 CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(TRUE));
5489 }
5490 else if (strcmp(argv[2], "off") == 0)
5491 {
5492 CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(FALSE));
5493 }
5494 else
5495 {
5496 errorArgument("Invalid link state '%s'", Utf8Str(argv[2]).raw());
5497 rc = E_FAIL;
5498 break;
5499 }
5500 }
5501 }
5502 else if (strcmp (argv[1], "usbattach") == 0 ||
5503 strcmp (argv[1], "usbdetach") == 0)
5504 {
5505 if (argc < 3)
5506 {
5507 errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
5508 rc = E_FAIL;
5509 break;
5510 }
5511
5512 bool attach = strcmp (argv[1], "usbattach") == 0;
5513
5514 Guid usbId = argv [2];
5515 if (usbId.isEmpty())
5516 {
5517 // assume address
5518 if (attach)
5519 {
5520 ComPtr <IHost> host;
5521 CHECK_ERROR_BREAK (virtualBox, COMGETTER(Host) (host.asOutParam()));
5522 ComPtr <IHostUSBDeviceCollection> coll;
5523 CHECK_ERROR_BREAK (host, COMGETTER(USBDevices) (coll.asOutParam()));
5524 ComPtr <IHostUSBDevice> dev;
5525 CHECK_ERROR_BREAK (coll, FindByAddress (Bstr (argv [2]), dev.asOutParam()));
5526 CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam()));
5527 }
5528 else
5529 {
5530 ComPtr <IUSBDeviceCollection> coll;
5531 CHECK_ERROR_BREAK (console, COMGETTER(USBDevices)(coll.asOutParam()));
5532 ComPtr <IUSBDevice> dev;
5533 CHECK_ERROR_BREAK (coll, FindByAddress (Bstr (argv [2]), dev.asOutParam()));
5534 CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam()));
5535 }
5536 }
5537
5538 if (attach)
5539 CHECK_ERROR_BREAK (console, AttachUSBDevice (usbId));
5540 else
5541 {
5542 ComPtr <IUSBDevice> dev;
5543 CHECK_ERROR_BREAK (console, DetachUSBDevice (usbId, dev.asOutParam()));
5544 }
5545 }
5546 else if (strcmp(argv[1], "setvideomodehint") == 0)
5547 {
5548 if (argc != 5 && argc != 6)
5549 {
5550 errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
5551 rc = E_FAIL;
5552 break;
5553 }
5554 uint32_t xres = atoi(argv[2]);
5555 uint32_t yres = atoi(argv[3]);
5556 uint32_t bpp = atoi(argv[4]);
5557 uint32_t displayIdx = 0;
5558 if (argc == 6)
5559 displayIdx = atoi(argv[5]);
5560
5561 ComPtr<IDisplay> display;
5562 CHECK_ERROR_BREAK(console, COMGETTER(Display)(display.asOutParam()));
5563 CHECK_ERROR_BREAK(display, SetVideoModeHint(xres, yres, bpp, displayIdx));
5564 }
5565 else if (strcmp(argv[1], "setcredentials") == 0)
5566 {
5567 bool fAllowLocalLogon = true;
5568 if (argc == 7)
5569 {
5570 if (strcmp(argv[5], "-allowlocallogon") != 0)
5571 {
5572 errorArgument("Invalid parameter '%s'", argv[5]);
5573 rc = E_FAIL;
5574 break;
5575 }
5576 if (strcmp(argv[6], "no") == 0)
5577 fAllowLocalLogon = false;
5578 }
5579 else if (argc != 5)
5580 {
5581 errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
5582 rc = E_FAIL;
5583 break;
5584 }
5585
5586 ComPtr<IGuest> guest;
5587 CHECK_ERROR_BREAK(console, COMGETTER(Guest)(guest.asOutParam()));
5588 CHECK_ERROR_BREAK(guest, SetCredentials(Bstr(argv[2]), Bstr(argv[3]), Bstr(argv[4]), fAllowLocalLogon));
5589 }
5590 else if (strcmp(argv[1], "dvdattach") == 0)
5591 {
5592 if (argc != 3)
5593 {
5594 errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
5595 rc = E_FAIL;
5596 break;
5597 }
5598 ComPtr<IDVDDrive> dvdDrive;
5599 sessionMachine->COMGETTER(DVDDrive)(dvdDrive.asOutParam());
5600 ASSERT(dvdDrive);
5601
5602 /* unmount? */
5603 if (strcmp(argv[2], "none") == 0)
5604 {
5605 CHECK_ERROR(dvdDrive, Unmount());
5606 }
5607 /* host drive? */
5608 else if (strncmp(argv[2], "host:", 5) == 0)
5609 {
5610 ComPtr<IHost> host;
5611 CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam()));
5612 ComPtr<IHostDVDDriveCollection> hostDVDs;
5613 CHECK_ERROR(host, COMGETTER(DVDDrives)(hostDVDs.asOutParam()));
5614 ComPtr<IHostDVDDrive> hostDVDDrive;
5615 rc = hostDVDs->FindByName(Bstr(argv[2] + 5), hostDVDDrive.asOutParam());
5616 if (!hostDVDDrive)
5617 {
5618 errorArgument("Invalid host DVD drive name");
5619 rc = E_FAIL;
5620 break;
5621 }
5622 CHECK_ERROR(dvdDrive, CaptureHostDrive(hostDVDDrive));
5623 }
5624 else
5625 {
5626 /* first assume it's a UUID */
5627 Guid uuid(argv[2]);
5628 ComPtr<IDVDImage> dvdImage;
5629 rc = virtualBox->GetDVDImage(uuid, dvdImage.asOutParam());
5630 if (FAILED(rc) || !dvdImage)
5631 {
5632 /* must be a filename, check if it's in the collection */
5633 ComPtr<IDVDImageCollection> dvdImages;
5634 virtualBox->COMGETTER(DVDImages)(dvdImages.asOutParam());
5635 rc = dvdImages->FindByPath(Bstr(argv[2]), dvdImage.asOutParam());
5636 /* not registered, do that on the fly */
5637 if (!dvdImage)
5638 {
5639 Guid emptyUUID;
5640 CHECK_ERROR(virtualBox, OpenDVDImage(Bstr(argv[2]), emptyUUID, dvdImage.asOutParam()));
5641 if (SUCCEEDED(rc) && dvdImage)
5642 {
5643 /* time to register the image */
5644 CHECK_ERROR(virtualBox, RegisterDVDImage(dvdImage));
5645 }
5646 }
5647 }
5648 if (!dvdImage)
5649 {
5650 rc = E_FAIL;
5651 break;
5652 }
5653 dvdImage->COMGETTER(Id)(uuid.asOutParam());
5654 CHECK_ERROR(dvdDrive, MountImage(uuid));
5655 }
5656 }
5657 else if (strcmp(argv[1], "floppyattach") == 0)
5658 {
5659 if (argc != 3)
5660 {
5661 errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
5662 rc = E_FAIL;
5663 break;
5664 }
5665
5666 ComPtr<IFloppyDrive> floppyDrive;
5667 sessionMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam());
5668 ASSERT(floppyDrive);
5669
5670 /* unmount? */
5671 if (strcmp(argv[2], "none") == 0)
5672 {
5673 CHECK_ERROR(floppyDrive, Unmount());
5674 }
5675 /* host drive? */
5676 else if (strncmp(argv[2], "host:", 5) == 0)
5677 {
5678 ComPtr<IHost> host;
5679 CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam()));
5680 ComPtr<IHostFloppyDriveCollection> hostFloppies;
5681 CHECK_ERROR(host, COMGETTER(FloppyDrives)(hostFloppies.asOutParam()));
5682 ComPtr<IHostFloppyDrive> hostFloppyDrive;
5683 rc = hostFloppies->FindByName(Bstr(argv[2] + 5), hostFloppyDrive.asOutParam());
5684 if (!hostFloppyDrive)
5685 {
5686 errorArgument("Invalid host floppy drive name");
5687 rc = E_FAIL;
5688 break;
5689 }
5690 CHECK_ERROR(floppyDrive, CaptureHostDrive(hostFloppyDrive));
5691 }
5692 else
5693 {
5694 /* first assume it's a UUID */
5695 Guid uuid(argv[2]);
5696 ComPtr<IFloppyImage> floppyImage;
5697 rc = virtualBox->GetFloppyImage(uuid, floppyImage.asOutParam());
5698 if (FAILED(rc) || !floppyImage)
5699 {
5700 /* must be a filename, check if it's in the collection */
5701 ComPtr<IFloppyImageCollection> floppyImages;
5702 virtualBox->COMGETTER(FloppyImages)(floppyImages.asOutParam());
5703 rc = floppyImages->FindByPath(Bstr(argv[2]), floppyImage.asOutParam());
5704 /* not registered, do that on the fly */
5705 if (!floppyImage)
5706 {
5707 Guid emptyUUID;
5708 CHECK_ERROR(virtualBox, OpenFloppyImage(Bstr(argv[2]), emptyUUID, floppyImage.asOutParam()));
5709 if (SUCCEEDED(rc) && floppyImage)
5710 {
5711 /* time to register the image */
5712 CHECK_ERROR(virtualBox, RegisterFloppyImage(floppyImage));
5713 }
5714 }
5715 }
5716 if (!floppyImage)
5717 {
5718 rc = E_FAIL;
5719 break;
5720 }
5721 floppyImage->COMGETTER(Id)(uuid.asOutParam());
5722 CHECK_ERROR(floppyDrive, MountImage(uuid));
5723 }
5724 }
5725 else if (strncmp(argv[1], "-guestmemoryballoon", 19) == 0)
5726 {
5727 if (argc != 3)
5728 {
5729 errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
5730 rc = E_FAIL;
5731 break;
5732 }
5733 uint32_t uVal;
5734 int vrc;
5735 vrc = RTStrToUInt32Ex(argv[2], NULL, 0, &uVal);
5736 if (vrc != VINF_SUCCESS)
5737 {
5738 errorArgument("Error parsing guest memory balloon size '%s'", argv[2]);
5739 rc = E_FAIL;
5740 break;
5741 }
5742
5743 /* guest is running; update IGuest */
5744 ComPtr <IGuest> guest;
5745
5746 rc = console->COMGETTER(Guest)(guest.asOutParam());
5747 if (SUCCEEDED(rc))
5748 CHECK_ERROR(guest, COMSETTER(MemoryBalloonSize)(uVal));
5749 }
5750 else if (strncmp(argv[1], "-gueststatisticsinterval", 24) == 0)
5751 {
5752 if (argc != 3)
5753 {
5754 errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
5755 rc = E_FAIL;
5756 break;
5757 }
5758 uint32_t uVal;
5759 int vrc;
5760 vrc = RTStrToUInt32Ex(argv[2], NULL, 0, &uVal);
5761 if (vrc != VINF_SUCCESS)
5762 {
5763 errorArgument("Error parsing guest memory balloon size '%s'", argv[2]);
5764 rc = E_FAIL;
5765 break;
5766 }
5767
5768 /* guest is running; update IGuest */
5769 ComPtr <IGuest> guest;
5770
5771 rc = console->COMGETTER(Guest)(guest.asOutParam());
5772 if (SUCCEEDED(rc))
5773 CHECK_ERROR(guest, COMSETTER(StatisticsUpdateInterval)(uVal));
5774 }
5775 else
5776 {
5777 errorSyntax(USAGE_CONTROLVM, "Invalid parameter '%s'", Utf8Str(argv[1]).raw());
5778 rc = E_FAIL;
5779 }
5780 }
5781 while (0);
5782
5783 session->Close();
5784
5785 return SUCCEEDED (rc) ? 0 : 1;
5786}
5787
5788static int handleDiscardState(int argc, char *argv[],
5789 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
5790{
5791 HRESULT rc;
5792
5793 if (argc != 1)
5794 {
5795 return errorSyntax(USAGE_DISCARDSTATE, "Incorrect number of parameters");
5796 }
5797
5798 ComPtr<IMachine> machine;
5799 /* assume it's a UUID */
5800 rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam());
5801 if (FAILED(rc) || !machine)
5802 {
5803 /* must be a name */
5804 CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
5805 }
5806 if (machine)
5807 {
5808 do
5809 {
5810 /* we have to open a session for this task */
5811 Guid guid;
5812 machine->COMGETTER(Id)(guid.asOutParam());
5813 CHECK_ERROR_BREAK(virtualBox, OpenSession(session, guid));
5814 do
5815 {
5816 ComPtr<IConsole> console;
5817 CHECK_ERROR_BREAK(session, COMGETTER(Console)(console.asOutParam()));
5818 CHECK_ERROR_BREAK(console, DiscardSavedState());
5819 }
5820 while (0);
5821 CHECK_ERROR_BREAK(session, Close());
5822 }
5823 while (0);
5824 }
5825
5826 return SUCCEEDED(rc) ? 0 : 1;
5827}
5828
5829static int handleAdoptdState(int argc, char *argv[],
5830 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
5831{
5832 HRESULT rc;
5833
5834 if (argc != 2)
5835 {
5836 return errorSyntax(USAGE_ADOPTSTATE, "Incorrect number of parameters");
5837 }
5838
5839 ComPtr<IMachine> machine;
5840 /* assume it's a UUID */
5841 rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam());
5842 if (FAILED(rc) || !machine)
5843 {
5844 /* must be a name */
5845 CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
5846 }
5847 if (machine)
5848 {
5849 do
5850 {
5851 /* we have to open a session for this task */
5852 Guid guid;
5853 machine->COMGETTER(Id)(guid.asOutParam());
5854 CHECK_ERROR_BREAK(virtualBox, OpenSession(session, guid));
5855 do
5856 {
5857 ComPtr<IConsole> console;
5858 CHECK_ERROR_BREAK(session, COMGETTER(Console)(console.asOutParam()));
5859 CHECK_ERROR_BREAK(console, AdoptSavedState (Bstr (argv[1])));
5860 }
5861 while (0);
5862 CHECK_ERROR_BREAK(session, Close());
5863 }
5864 while (0);
5865 }
5866
5867 return SUCCEEDED(rc) ? 0 : 1;
5868}
5869
5870static int handleSnapshot(int argc, char *argv[],
5871 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
5872{
5873 HRESULT rc;
5874
5875 /* we need at least a VM and a command */
5876 if (argc < 2)
5877 {
5878 return errorSyntax(USAGE_SNAPSHOT, "Not enough parameters");
5879 }
5880
5881 /* the first argument must be the VM */
5882 ComPtr<IMachine> machine;
5883 /* assume it's a UUID */
5884 rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam());
5885 if (FAILED(rc) || !machine)
5886 {
5887 /* must be a name */
5888 CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
5889 }
5890 if (!machine)
5891 return 1;
5892 Guid guid;
5893 machine->COMGETTER(Id)(guid.asOutParam());
5894
5895 do
5896 {
5897 /* we have to open a session for this task. First try an existing session */
5898 rc = virtualBox->OpenExistingSession(session, guid);
5899 if (FAILED(rc))
5900 CHECK_ERROR_BREAK(virtualBox, OpenSession(session, guid));
5901 ComPtr<IConsole> console;
5902 CHECK_ERROR_BREAK(session, COMGETTER(Console)(console.asOutParam()));
5903
5904 /* switch based on the command */
5905 if (strcmp(argv[1], "take") == 0)
5906 {
5907 /* there must be a name */
5908 if (argc < 3)
5909 {
5910 errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
5911 rc = E_FAIL;
5912 break;
5913 }
5914 Bstr name(argv[2]);
5915 if ((argc > 3) && ((argc != 5) || (strcmp(argv[3], "-desc") != 0)))
5916 {
5917 errorSyntax(USAGE_SNAPSHOT, "Incorrect description format");
5918 rc = E_FAIL;
5919 break;
5920 }
5921 Bstr desc;
5922 if (argc == 5)
5923 desc = argv[4];
5924 ComPtr<IProgress> progress;
5925 CHECK_ERROR_BREAK(console, TakeSnapshot(name, desc, progress.asOutParam()));
5926
5927 showProgress(progress);
5928 progress->COMGETTER(ResultCode)(&rc);
5929 if (FAILED(rc))
5930 {
5931 com::ProgressErrorInfo info(progress);
5932 if (info.isBasicAvailable())
5933 {
5934 RTPrintf("Error: failed to take snapshot. Error message: %lS\n", info.getText().raw());
5935 }
5936 else
5937 {
5938 RTPrintf("Error: failed to take snapshot. No error message available!\n");
5939 }
5940 }
5941 }
5942 else if (strcmp(argv[1], "discard") == 0)
5943 {
5944 /* exactly one parameter: snapshot name */
5945 if (argc != 3)
5946 {
5947 errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
5948 rc = E_FAIL;
5949 break;
5950 }
5951
5952 ComPtr<ISnapshot> snapshot;
5953
5954 /* assume it's a UUID */
5955 Guid guid(argv[2]);
5956 if (!guid.isEmpty())
5957 {
5958 CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam()));
5959 }
5960 else
5961 {
5962 /* then it must be a name */
5963 CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(argv[2]), snapshot.asOutParam()));
5964 }
5965
5966 snapshot->COMGETTER(Id)(guid.asOutParam());
5967
5968 ComPtr<IProgress> progress;
5969 CHECK_ERROR_BREAK(console, DiscardSnapshot(guid, progress.asOutParam()));
5970
5971 showProgress(progress);
5972 progress->COMGETTER(ResultCode)(&rc);
5973 if (FAILED(rc))
5974 {
5975 com::ProgressErrorInfo info(progress);
5976 if (info.isBasicAvailable())
5977 {
5978 RTPrintf("Error: failed to discard snapshot. Error message: %lS\n", info.getText().raw());
5979 }
5980 else
5981 {
5982 RTPrintf("Error: failed to discard snapshot. No error message available!\n");
5983 }
5984 }
5985 }
5986 else if (strcmp(argv[1], "discardcurrent") == 0)
5987 {
5988 if ( (argc != 3)
5989 || ( (strcmp(argv[2], "-state") != 0)
5990 && (strcmp(argv[2], "-all") != 0)))
5991 {
5992 errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(argv[2]).raw());
5993 rc = E_FAIL;
5994 break;
5995 }
5996 bool fAll = false;
5997 if (strcmp(argv[2], "-all") == 0)
5998 fAll = true;
5999
6000 ComPtr<IProgress> progress;
6001
6002 if (fAll)
6003 {
6004 CHECK_ERROR_BREAK(console, DiscardCurrentSnapshotAndState(progress.asOutParam()));
6005 }
6006 else
6007 {
6008 CHECK_ERROR_BREAK(console, DiscardCurrentState(progress.asOutParam()));
6009 }
6010
6011 showProgress(progress);
6012 progress->COMGETTER(ResultCode)(&rc);
6013 if (FAILED(rc))
6014 {
6015 com::ProgressErrorInfo info(progress);
6016 if (info.isBasicAvailable())
6017 {
6018 RTPrintf("Error: failed to discard. Error message: %lS\n", info.getText().raw());
6019 }
6020 else
6021 {
6022 RTPrintf("Error: failed to discard. No error message available!\n");
6023 }
6024 }
6025
6026 }
6027 else if (strcmp(argv[1], "edit") == 0)
6028 {
6029 if (argc < 3)
6030 {
6031 errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name");
6032 rc = E_FAIL;
6033 break;
6034 }
6035
6036 ComPtr<ISnapshot> snapshot;
6037
6038 if (strcmp(argv[2], "-current") == 0)
6039 {
6040 CHECK_ERROR_BREAK(machine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam()));
6041 }
6042 else
6043 {
6044 /* assume it's a UUID */
6045 Guid guid(argv[2]);
6046 if (!guid.isEmpty())
6047 {
6048 CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam()));
6049 }
6050 else
6051 {
6052 /* then it must be a name */
6053 CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(argv[2]), snapshot.asOutParam()));
6054 }
6055 }
6056
6057 /* parse options */
6058 for (int i = 3; i < argc; i++)
6059 {
6060 if (strcmp(argv[i], "-newname") == 0)
6061 {
6062 if (argc <= i + 1)
6063 {
6064 errorArgument("Missing argument to '%s'", argv[i]);
6065 rc = E_FAIL;
6066 break;
6067 }
6068 i++;
6069 snapshot->COMSETTER(Name)(Bstr(argv[i]));
6070 }
6071 else if (strcmp(argv[i], "-newdesc") == 0)
6072 {
6073 if (argc <= i + 1)
6074 {
6075 errorArgument("Missing argument to '%s'", argv[i]);
6076 rc = E_FAIL;
6077 break;
6078 }
6079 i++;
6080 snapshot->COMSETTER(Description)(Bstr(argv[i]));
6081 }
6082 else
6083 {
6084 errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
6085 rc = E_FAIL;
6086 break;
6087 }
6088 }
6089
6090 }
6091 else if (strcmp(argv[1], "showvminfo") == 0)
6092 {
6093 /* exactly one parameter: snapshot name */
6094 if (argc != 3)
6095 {
6096 errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only");
6097 rc = E_FAIL;
6098 break;
6099 }
6100
6101 ComPtr<ISnapshot> snapshot;
6102
6103 /* assume it's a UUID */
6104 Guid guid(argv[2]);
6105 if (!guid.isEmpty())
6106 {
6107 CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam()));
6108 }
6109 else
6110 {
6111 /* then it must be a name */
6112 CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(argv[2]), snapshot.asOutParam()));
6113 }
6114
6115 /* get the machine of the given snapshot */
6116 ComPtr<IMachine> machine;
6117 snapshot->COMGETTER(Machine)(machine.asOutParam());
6118 showVMInfo(virtualBox, machine, console);
6119 }
6120 else
6121 {
6122 errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(argv[1]).raw());
6123 rc = E_FAIL;
6124 }
6125 } while (0);
6126
6127 session->Close();
6128
6129 return SUCCEEDED(rc) ? 0 : 1;
6130}
6131
6132static int handleShowVDIInfo(int argc, char *argv[],
6133 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6134{
6135 HRESULT rc;
6136
6137 if (argc != 1)
6138 {
6139 return errorSyntax(USAGE_SHOWVDIINFO, "Incorrect number of parameters");
6140 }
6141
6142 ComPtr<IHardDisk> hardDisk;
6143 Bstr filepath;
6144
6145 bool registered = true;
6146
6147 /* first guess is that it's a UUID */
6148 Guid uuid(argv[0]);
6149 rc = virtualBox->GetHardDisk(uuid, hardDisk.asOutParam());
6150 /* no? then it must be a filename */
6151 if (FAILED (rc))
6152 {
6153 filepath = argv[0];
6154 rc = virtualBox->FindHardDisk(filepath, hardDisk.asOutParam());
6155 /* no? well, then it's an unregistered image */
6156 if (FAILED (rc))
6157 {
6158 registered = false;
6159 CHECK_ERROR(virtualBox, OpenHardDisk(filepath, hardDisk.asOutParam()));
6160 }
6161 }
6162 if (SUCCEEDED(rc) && hardDisk)
6163 {
6164 /* query a VDI object (will remain null if it's not VDI) */
6165 ComPtr<IVirtualDiskImage> vdi = hardDisk;
6166
6167 hardDisk->COMGETTER(Id)(uuid.asOutParam());
6168 RTPrintf("UUID: %s\n", uuid.toString().raw());
6169
6170 RTPrintf("Registered: %s\n", registered ? "yes" : "no");
6171
6172 /* check for accessibility */
6173 BOOL accessible = FALSE;
6174 CHECK_ERROR_RET (hardDisk, COMGETTER(Accessible)(&accessible), 1);
6175 RTPrintf("Accessible: %s\n", accessible ? "yes" : "no");
6176
6177 if (!accessible)
6178 {
6179 Bstr err;
6180 CHECK_ERROR_RET (hardDisk, COMGETTER(LastAccessError)(err.asOutParam()), 1);
6181 RTPrintf("Access Error: %lS\n", err.raw());
6182 }
6183
6184 Bstr description;
6185 hardDisk->COMGETTER(Description)(description.asOutParam());
6186 if (description)
6187 {
6188 RTPrintf("Description: %lS\n", description.raw());
6189 }
6190
6191 ULONG64 size;
6192 hardDisk->COMGETTER(Size)(&size);
6193 RTPrintf("Size: %llu MBytes\n", size);
6194 ULONG64 actualSize;
6195 hardDisk->COMGETTER(ActualSize)(&actualSize);
6196 RTPrintf("Current size on disk: %llu MBytes\n", actualSize >> 20);
6197
6198 HardDiskType_T type;
6199 hardDisk->COMGETTER(Type)(&type);
6200 const char *typeStr = "unknown";
6201 switch (type)
6202 {
6203 case HardDiskType_Normal:
6204 typeStr = "standard";
6205 break;
6206 case HardDiskType_Immutable:
6207 typeStr = "immutable";
6208 break;
6209 case HardDiskType_Writethrough:
6210 typeStr = "writethrough";
6211 break;
6212 }
6213 RTPrintf("Type: %s\n", typeStr);
6214
6215 HardDiskStorageType_T storageType;
6216 const char *storageTypeStr = "unknown";
6217 hardDisk->COMGETTER(StorageType)(&storageType);
6218 switch (storageType)
6219 {
6220 case HardDiskStorageType_VirtualDiskImage:
6221 storageTypeStr = "Virtual Disk Image (VDI)";
6222 break;
6223 case HardDiskStorageType_VMDKImage:
6224 storageTypeStr = "VMDK Image";
6225 break;
6226 case HardDiskStorageType_ISCSIHardDisk:
6227 storageTypeStr = "iSCSI target";
6228 break;
6229 case HardDiskStorageType_VHDImage:
6230 storageTypeStr = "VHD Image";
6231 break;
6232 }
6233 RTPrintf("Storage type: %s\n", storageTypeStr);
6234
6235 if (registered)
6236 {
6237 hardDisk->COMGETTER(MachineId)(uuid.asOutParam());
6238 RTPrintf("In use by VM: %s\n", uuid ? uuid.toString().raw() : "<none>");
6239 }
6240
6241 if (vdi)
6242 {
6243 /* VDI specific information */
6244 vdi->COMGETTER(FilePath)(filepath.asOutParam());
6245 RTPrintf("Path: %lS\n", filepath.raw());
6246
6247 }
6248 else
6249 {
6250 /* Generic location information */
6251 Bstr loc;
6252 hardDisk->COMGETTER(Location)(loc.asOutParam());
6253 RTPrintf("Location: %lS\n", loc.raw());
6254 }
6255 }
6256 return SUCCEEDED(rc) ? 0 : 1;
6257}
6258
6259static int handleRegisterImage(int argc, char *argv[],
6260 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6261{
6262 HRESULT rc;
6263
6264 if (argc < 2)
6265 {
6266 return errorSyntax(USAGE_REGISTERIMAGE, "Not enough parameters");
6267 }
6268
6269 Bstr filepath(argv[1]);
6270
6271 if (strcmp(argv[0], "disk") == 0)
6272 {
6273 const char *type = NULL;
6274 /* there can be a type parameter */
6275 if ((argc > 2) && (argc != 4))
6276 {
6277 return errorSyntax(USAGE_REGISTERIMAGE, "Incorrect number of parameters");
6278 }
6279 if (argc == 4)
6280 {
6281 if (strcmp(argv[2], "-type") != 0)
6282 {
6283 return errorSyntax(USAGE_REGISTERIMAGE, "Invalid parameter '%s'", Utf8Str(argv[2]).raw());
6284 }
6285 if ( (strcmp(argv[3], "normal") != 0)
6286 && (strcmp(argv[3], "immutable") != 0)
6287 && (strcmp(argv[3], "writethrough") != 0))
6288 {
6289 return errorArgument("Invalid VDI type '%s' specified", Utf8Str(argv[3]).raw());
6290 }
6291 type = argv[3];
6292 }
6293
6294 ComPtr<IHardDisk> hardDisk;
6295 CHECK_ERROR(virtualBox, OpenHardDisk(filepath, hardDisk.asOutParam()));
6296 if (SUCCEEDED(rc) && hardDisk)
6297 {
6298 /* change the type if requested */
6299 if (type)
6300 {
6301 if (strcmp(type, "normal") == 0)
6302 CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Normal));
6303 else if (strcmp(type, "immutable") == 0)
6304 CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Immutable));
6305 else if (strcmp(type, "writethrough") == 0)
6306 CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Writethrough));
6307 }
6308 if (SUCCEEDED(rc))
6309 CHECK_ERROR(virtualBox, RegisterHardDisk(hardDisk));
6310 }
6311 }
6312 else if (strcmp(argv[0], "dvd") == 0)
6313 {
6314 ComPtr<IDVDImage> dvdImage;
6315 CHECK_ERROR(virtualBox, OpenDVDImage(filepath, Guid(), dvdImage.asOutParam()));
6316 if (SUCCEEDED(rc) && dvdImage)
6317 {
6318 CHECK_ERROR(virtualBox, RegisterDVDImage(dvdImage));
6319 }
6320 }
6321 else if (strcmp(argv[0], "floppy") == 0)
6322 {
6323 ComPtr<IFloppyImage> floppyImage;
6324 CHECK_ERROR(virtualBox, OpenFloppyImage(filepath, Guid(), floppyImage.asOutParam()));
6325 if (SUCCEEDED(rc) && floppyImage)
6326 {
6327 CHECK_ERROR(virtualBox, RegisterFloppyImage(floppyImage));
6328 }
6329 }
6330 else
6331 {
6332 return errorSyntax(USAGE_REGISTERIMAGE, "Invalid parameter '%s'", Utf8Str(argv[1]).raw());
6333 }
6334 return SUCCEEDED(rc) ? 0 : 1;
6335}
6336
6337static int handleUnregisterImage(int argc, char *argv[],
6338 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6339{
6340 HRESULT rc;
6341
6342 if (argc != 2)
6343 {
6344 return errorSyntax(USAGE_UNREGISTERIMAGE, "Incorrect number of parameters");
6345 }
6346
6347 /* first guess is that it's a UUID */
6348 Guid uuid(argv[1]);
6349
6350 if (strcmp(argv[0], "disk") == 0)
6351 {
6352 ComPtr<IHardDisk> hardDisk;
6353 rc = virtualBox->GetHardDisk(uuid, hardDisk.asOutParam());
6354 /* not a UUID or not registered? Then it must be a filename */
6355 if (!hardDisk)
6356 {
6357 ComPtr<IVirtualDiskImage> vdi;
6358 CHECK_ERROR(virtualBox, FindVirtualDiskImage(Bstr(argv[1]), vdi.asOutParam()));
6359 hardDisk = vdi;
6360 }
6361 if (SUCCEEDED(rc) && hardDisk)
6362 {
6363 hardDisk->COMGETTER(Id)(uuid.asOutParam());
6364 CHECK_ERROR(virtualBox, UnregisterHardDisk(uuid, hardDisk.asOutParam()));
6365 }
6366 }
6367 else
6368 if (strcmp(argv[0], "dvd") == 0)
6369 {
6370 ComPtr<IDVDImage> dvdImage;
6371 rc = virtualBox->GetDVDImage(uuid, dvdImage.asOutParam());
6372 /* not a UUID or not registered? Then it must be a filename */
6373 if (!dvdImage)
6374 {
6375 ComPtr<IDVDImageCollection> dvdColl;
6376 virtualBox->COMGETTER(DVDImages)(dvdColl.asOutParam());
6377 CHECK_ERROR(dvdColl, FindByPath(Bstr(argv[1]), dvdImage.asOutParam()));
6378 }
6379 if (SUCCEEDED(rc) && dvdImage)
6380 {
6381 dvdImage->COMGETTER(Id)(uuid.asOutParam());
6382 CHECK_ERROR(virtualBox, UnregisterDVDImage(uuid, dvdImage.asOutParam()));
6383 }
6384 }
6385 else
6386 if (strcmp(argv[0], "floppy") == 0)
6387 {
6388 ComPtr<IFloppyImage> floppyImage;
6389 rc = virtualBox->GetFloppyImage(uuid, floppyImage.asOutParam());
6390 /* not a UUID or not registered? Then it must be a filename */
6391 if (!floppyImage)
6392 {
6393 ComPtr<IFloppyImageCollection> floppyColl;
6394 virtualBox->COMGETTER(FloppyImages)(floppyColl.asOutParam());
6395 CHECK_ERROR(floppyColl, FindByPath(Bstr(argv[1]), floppyImage.asOutParam()));
6396 }
6397 if (SUCCEEDED(rc) && floppyImage)
6398 {
6399 floppyImage->COMGETTER(Id)(uuid.asOutParam());
6400 CHECK_ERROR(virtualBox, UnregisterFloppyImage(uuid, floppyImage.asOutParam()));
6401 }
6402 }
6403 else
6404 {
6405 return errorSyntax(USAGE_UNREGISTERIMAGE, "Invalid parameter '%s'", Utf8Str(argv[1]).raw());
6406 }
6407 return SUCCEEDED(rc) ? 0 : 1;
6408}
6409
6410#ifdef RT_OS_WINDOWS
6411static int handleCreateHostIF(int argc, char *argv[],
6412 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6413{
6414 if (argc != 1)
6415 {
6416 return errorSyntax(USAGE_CREATEHOSTIF, "Incorrect number of parameters");
6417 }
6418
6419 HRESULT rc = S_OK;
6420
6421 do
6422 {
6423 ComPtr<IHost> host;
6424 CHECK_ERROR_BREAK(virtualBox, COMGETTER(Host)(host.asOutParam()));
6425
6426 ComPtr<IHostNetworkInterface> hostif;
6427 ComPtr<IProgress> progress;
6428 CHECK_ERROR_BREAK(host,
6429 CreateHostNetworkInterface(Bstr(argv[0]),
6430 hostif.asOutParam(),
6431 progress.asOutParam()));
6432
6433 showProgress(progress);
6434 HRESULT result;
6435 CHECK_ERROR_BREAK(progress, COMGETTER(ResultCode)(&result));
6436 if (FAILED(result))
6437 {
6438 com::ProgressErrorInfo info(progress);
6439 PRINT_ERROR_INFO(info);
6440 rc = result;
6441 }
6442 }
6443 while (0);
6444
6445 return SUCCEEDED(rc) ? 0 : 1;
6446}
6447
6448static int handleRemoveHostIF(int argc, char *argv[],
6449 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6450{
6451 if (argc != 1)
6452 {
6453 return errorSyntax(USAGE_REMOVEHOSTIF, "Incorrect number of parameters");
6454 }
6455
6456 HRESULT rc = S_OK;
6457
6458 do
6459 {
6460 ComPtr<IHost> host;
6461 CHECK_ERROR_BREAK(virtualBox, COMGETTER(Host)(host.asOutParam()));
6462
6463 ComPtr<IHostNetworkInterface> hostif;
6464
6465 /* first guess is that it's a UUID */
6466 Guid uuid(argv[0]);
6467 if (uuid.isEmpty())
6468 {
6469 /* not a valid UUID, search for it */
6470 ComPtr<IHostNetworkInterfaceCollection> coll;
6471 CHECK_ERROR_BREAK(host, COMGETTER(NetworkInterfaces)(coll.asOutParam()));
6472 CHECK_ERROR_BREAK(coll, FindByName(Bstr(argv[0]), hostif.asOutParam()));
6473 CHECK_ERROR_BREAK(hostif, COMGETTER(Id)(uuid.asOutParam()));
6474 }
6475
6476 ComPtr<IProgress> progress;
6477 CHECK_ERROR_BREAK(host,
6478 RemoveHostNetworkInterface(uuid,
6479 hostif.asOutParam(),
6480 progress.asOutParam()));
6481
6482 showProgress(progress);
6483 HRESULT result;
6484 CHECK_ERROR_BREAK(progress, COMGETTER(ResultCode)(&result));
6485 if (FAILED(result))
6486 {
6487 com::ProgressErrorInfo info(progress);
6488 PRINT_ERROR_INFO(info);
6489 rc = result;
6490 }
6491 }
6492 while (0);
6493
6494 return SUCCEEDED(rc) ? 0 : 1;
6495}
6496#endif /* RT_OS_WINDOWS */
6497
6498static int handleGetExtraData(int argc, char *argv[],
6499 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6500{
6501 HRESULT rc = S_OK;
6502
6503 if (argc != 2)
6504 {
6505 return errorSyntax(USAGE_GETEXTRADATA, "Incorrect number of parameters");
6506 }
6507 /* global data? */
6508 if (strcmp(argv[0], "global") == 0)
6509 {
6510 /* enumeration? */
6511 if (strcmp(argv[1], "enumerate") == 0)
6512 {
6513 Bstr extraDataKey;
6514
6515 do
6516 {
6517 Bstr nextExtraDataKey;
6518 Bstr nextExtraDataValue;
6519 HRESULT rcEnum = virtualBox->GetNextExtraDataKey(extraDataKey, nextExtraDataKey.asOutParam(),
6520 nextExtraDataValue.asOutParam());
6521 extraDataKey = nextExtraDataKey;
6522
6523 if (SUCCEEDED(rcEnum) && extraDataKey)
6524 {
6525 RTPrintf("Key: %lS, Value: %lS\n", nextExtraDataKey.raw(), nextExtraDataValue.raw());
6526 }
6527 } while (extraDataKey);
6528 }
6529 else
6530 {
6531 Bstr value;
6532 CHECK_ERROR(virtualBox, GetExtraData(Bstr(argv[1]), value.asOutParam()));
6533 if (value)
6534 RTPrintf("Value: %lS\n", value.raw());
6535 else
6536 RTPrintf("No value set!\n");
6537 }
6538 }
6539 else
6540 {
6541 ComPtr<IMachine> machine;
6542 /* assume it's a UUID */
6543 rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam());
6544 if (FAILED(rc) || !machine)
6545 {
6546 /* must be a name */
6547 CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
6548 }
6549 if (machine)
6550 {
6551 /* enumeration? */
6552 if (strcmp(argv[1], "enumerate") == 0)
6553 {
6554 Bstr extraDataKey;
6555
6556 do
6557 {
6558 Bstr nextExtraDataKey;
6559 Bstr nextExtraDataValue;
6560 HRESULT rcEnum = machine->GetNextExtraDataKey(extraDataKey, nextExtraDataKey.asOutParam(),
6561 nextExtraDataValue.asOutParam());
6562 extraDataKey = nextExtraDataKey;
6563
6564 if (SUCCEEDED(rcEnum) && extraDataKey)
6565 {
6566 RTPrintf("Key: %lS, Value: %lS\n", nextExtraDataKey.raw(), nextExtraDataValue.raw());
6567 }
6568 } while (extraDataKey);
6569 }
6570 else
6571 {
6572 Bstr value;
6573 CHECK_ERROR(machine, GetExtraData(Bstr(argv[1]), value.asOutParam()));
6574 if (value)
6575 RTPrintf("Value: %lS\n", value.raw());
6576 else
6577 RTPrintf("No value set!\n");
6578 }
6579 }
6580 }
6581 return SUCCEEDED(rc) ? 0 : 1;
6582}
6583
6584static int handleSetExtraData(int argc, char *argv[],
6585 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6586{
6587 HRESULT rc = S_OK;
6588
6589 if (argc < 2)
6590 {
6591 return errorSyntax(USAGE_SETEXTRADATA, "Not enough parameters");
6592 }
6593 /* global data? */
6594 if (strcmp(argv[0], "global") == 0)
6595 {
6596 if (argc < 3)
6597 CHECK_ERROR(virtualBox, SetExtraData(Bstr(argv[1]), NULL));
6598 else if (argc == 3)
6599 CHECK_ERROR(virtualBox, SetExtraData(Bstr(argv[1]), Bstr(argv[2])));
6600 else
6601 return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters");
6602 }
6603 else
6604 {
6605 ComPtr<IMachine> machine;
6606 /* assume it's a UUID */
6607 rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam());
6608 if (FAILED(rc) || !machine)
6609 {
6610 /* must be a name */
6611 CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
6612 }
6613 if (machine)
6614 {
6615 if (argc < 3)
6616 CHECK_ERROR(machine, SetExtraData(Bstr(argv[1]), NULL));
6617 else if (argc == 3)
6618 CHECK_ERROR(machine, SetExtraData(Bstr(argv[1]), Bstr(argv[2])));
6619 else
6620 return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters");
6621 }
6622 }
6623 return SUCCEEDED(rc) ? 0 : 1;
6624}
6625
6626static int handleSetProperty(int argc, char *argv[],
6627 ComPtr<IVirtualBox> virtualBox, ComPtr<ISession> session)
6628{
6629 HRESULT rc;
6630
6631 /* there must be two arguments: property name and value */
6632 if (argc != 2)
6633 {
6634 return errorSyntax(USAGE_SETPROPERTY, "Incorrect number of parameters");
6635 }
6636 ComPtr<ISystemProperties> systemProperties;
6637 virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
6638
6639 if (strcmp(argv[0], "vdifolder") == 0)
6640 {
6641 /* reset to default? */
6642 if (strcmp(argv[1], "default") == 0)
6643 CHECK_ERROR(systemProperties, COMSETTER(DefaultVDIFolder)(NULL));
6644 else
6645 CHECK_ERROR(systemProperties, COMSETTER(DefaultVDIFolder)(Bstr(argv[1])));
6646 }
6647 else if (strcmp(argv[0], "machinefolder") == 0)
6648 {
6649 /* reset to default? */
6650 if (strcmp(argv[1], "default") == 0)
6651 CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(NULL));
6652 else
6653 CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(Bstr(argv[1])));
6654 }
6655 else if (strcmp(argv[0], "vrdpauthlibrary") == 0)
6656 {
6657 /* reset to default? */
6658 if (strcmp(argv[1], "default") == 0)
6659 CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(NULL));
6660 else
6661 CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(Bstr(argv[1])));
6662 }
6663 else if (strcmp(argv[0], "websrvauthlibrary") == 0)
6664 {
6665 /* reset to default? */
6666 if (strcmp(argv[1], "default") == 0)
6667 CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(NULL));
6668 else
6669 CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(Bstr(argv[1])));
6670 }
6671 else if (strcmp(argv[0], "hwvirtexenabled") == 0)
6672 {
6673 if (strcmp(argv[1], "yes") == 0)
6674 CHECK_ERROR(systemProperties, COMSETTER(HWVirtExEnabled)(TRUE));
6675 else if (strcmp(argv[1], "no") == 0)
6676 CHECK_ERROR(systemProperties, COMSETTER(HWVirtExEnabled)(FALSE));
6677 else
6678 return errorArgument("Invalid value '%s' for hardware virtualization extension flag", argv[1]);
6679 }
6680 else if (strcmp(argv[0], "loghistorycount") == 0)
6681 {
6682 uint32_t uVal;
6683 int vrc;
6684 vrc = RTStrToUInt32Ex(argv[1], NULL, 0, &uVal);
6685 if (vrc != VINF_SUCCESS)
6686 return errorArgument("Error parsing Log history count '%s'", argv[1]);
6687 CHECK_ERROR(systemProperties, COMSETTER(LogHistoryCount)(uVal));
6688 }
6689 else
6690 return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", argv[0]);
6691
6692 return SUCCEEDED(rc) ? 0 : 1;
6693}
6694
6695static int handleUSBFilter (int argc, char *argv[],
6696 ComPtr <IVirtualBox> aVirtualBox, ComPtr<ISession> aSession)
6697{
6698 HRESULT rc = S_OK;
6699 USBFilterCmd cmd;
6700
6701 /* at least: 0: command, 1: index, 2: -target, 3: <target value> */
6702 if (argc < 4)
6703 {
6704 return errorSyntax(USAGE_USBFILTER, "Not enough parameters");
6705 }
6706
6707 /* which command? */
6708 cmd.mAction = USBFilterCmd::Invalid;
6709 if (strcmp (argv [0], "add") == 0) cmd.mAction = USBFilterCmd::Add;
6710 else if (strcmp (argv [0], "modify") == 0) cmd.mAction = USBFilterCmd::Modify;
6711 else if (strcmp (argv [0], "remove") == 0) cmd.mAction = USBFilterCmd::Remove;
6712
6713 if (cmd.mAction == USBFilterCmd::Invalid)
6714 {
6715 return errorSyntax(USAGE_USBFILTER, "Invalid parameter '%s'", argv[0]);
6716 }
6717
6718 /* which index? */
6719 char *endptr = NULL;
6720 cmd.mIndex = strtoul (argv[1], &endptr, 10);
6721 if (!endptr || *endptr)
6722 {
6723 return errorSyntax(USAGE_USBFILTER, "Invalid index '%s'", argv[1]);
6724 }
6725
6726 switch (cmd.mAction)
6727 {
6728 case USBFilterCmd::Add:
6729 case USBFilterCmd::Modify:
6730 {
6731 /* at least: 0: command, 1: index, 2: -target, 3: <target value>, 4: -name, 5: <name value> */
6732 if (argc < 6)
6733 {
6734 if (cmd.mAction == USBFilterCmd::Add)
6735 {
6736 return errorSyntax(USAGE_USBFILTER_ADD, "Not enough parameters");
6737 }
6738 return errorSyntax(USAGE_USBFILTER_MODIFY, "Not enough parameters");
6739 }
6740
6741 // set Active to true by default
6742 // (assuming that the user sets up all necessary attributes
6743 // at once and wants the filter to be active immediately)
6744 if (cmd.mAction == USBFilterCmd::Add)
6745 cmd.mFilter.mActive = true;
6746
6747 for (int i = 2; i < argc; i++)
6748 {
6749 if (strcmp(argv [i], "-target") == 0)
6750 {
6751 if (argc <= i + 1 || !*argv[i+1])
6752 {
6753 return errorArgument("Missing argument to '%s'", argv[i]);
6754 }
6755 i++;
6756 if (strcmp (argv [i], "global") == 0)
6757 cmd.mGlobal = true;
6758 else
6759 {
6760 /* assume it's a UUID of a machine */
6761 rc = aVirtualBox->GetMachine(Guid(argv[i]), cmd.mMachine.asOutParam());
6762 if (FAILED(rc) || !cmd.mMachine)
6763 {
6764 /* must be a name */
6765 CHECK_ERROR_RET(aVirtualBox, FindMachine(Bstr(argv[i]), cmd.mMachine.asOutParam()), 1);
6766 }
6767 }
6768 }
6769 else if (strcmp(argv [i], "-name") == 0)
6770 {
6771 if (argc <= i + 1 || !*argv[i+1])
6772 {
6773 return errorArgument("Missing argument to '%s'", argv[i]);
6774 }
6775 i++;
6776 cmd.mFilter.mName = argv [i];
6777 }
6778 else if (strcmp(argv [i], "-active") == 0)
6779 {
6780 if (argc <= i + 1)
6781 {
6782 return errorArgument("Missing argument to '%s'", argv[i]);
6783 }
6784 i++;
6785 if (strcmp (argv [i], "yes") == 0)
6786 cmd.mFilter.mActive = true;
6787 else if (strcmp (argv [i], "no") == 0)
6788 cmd.mFilter.mActive = false;
6789 else
6790 {
6791 return errorArgument("Invalid -active argument '%s'", argv[i]);
6792 }
6793 }
6794 else if (strcmp(argv [i], "-vendorid") == 0)
6795 {
6796 if (argc <= i + 1)
6797 {
6798 return errorArgument("Missing argument to '%s'", argv[i]);
6799 }
6800 i++;
6801 cmd.mFilter.mVendorId = argv [i];
6802 }
6803 else if (strcmp(argv [i], "-productid") == 0)
6804 {
6805 if (argc <= i + 1)
6806 {
6807 return errorArgument("Missing argument to '%s'", argv[i]);
6808 }
6809 i++;
6810 cmd.mFilter.mProductId = argv [i];
6811 }
6812 else if (strcmp(argv [i], "-revision") == 0)
6813 {
6814 if (argc <= i + 1)
6815 {
6816 return errorArgument("Missing argument to '%s'", argv[i]);
6817 }
6818 i++;
6819 cmd.mFilter.mRevision = argv [i];
6820 }
6821 else if (strcmp(argv [i], "-manufacturer") == 0)
6822 {
6823 if (argc <= i + 1)
6824 {
6825 return errorArgument("Missing argument to '%s'", argv[i]);
6826 }
6827 i++;
6828 cmd.mFilter.mManufacturer = argv [i];
6829 }
6830 else if (strcmp(argv [i], "-product") == 0)
6831 {
6832 if (argc <= i + 1)
6833 {
6834 return errorArgument("Missing argument to '%s'", argv[i]);
6835 }
6836 i++;
6837 cmd.mFilter.mProduct = argv [i];
6838 }
6839 else if (strcmp(argv [i], "-remote") == 0)
6840 {
6841 if (argc <= i + 1)
6842 {
6843 return errorArgument("Missing argument to '%s'", argv[i]);
6844 }
6845 i++;
6846 cmd.mFilter.mRemote = argv[i];
6847 }
6848 else if (strcmp(argv [i], "-serialnumber") == 0)
6849 {
6850 if (argc <= i + 1)
6851 {
6852 return errorArgument("Missing argument to '%s'", argv[i]);
6853 }
6854 i++;
6855 cmd.mFilter.mSerialNumber = argv [i];
6856 }
6857 else if (strcmp(argv [i], "-maskedinterfaces") == 0)
6858 {
6859 if (argc <= i + 1)
6860 {
6861 return errorArgument("Missing argument to '%s'", argv[i]);
6862 }
6863 i++;
6864 uint32_t u32;
6865 rc = RTStrToUInt32Full(argv[i], 0, &u32);
6866 if (RT_FAILURE(rc))
6867 {
6868 return errorArgument("Failed to convert the -maskedinterfaces value '%s' to a number, rc=%Rrc", argv[i], rc);
6869 }
6870 cmd.mFilter.mMaskedInterfaces = u32;
6871 }
6872 else if (strcmp(argv [i], "-action") == 0)
6873 {
6874 if (argc <= i + 1)
6875 {
6876 return errorArgument("Missing argument to '%s'", argv[i]);
6877 }
6878 i++;
6879 if (strcmp (argv [i], "ignore") == 0)
6880 cmd.mFilter.mAction = USBDeviceFilterAction_Ignore;
6881 else if (strcmp (argv [i], "hold") == 0)
6882 cmd.mFilter.mAction = USBDeviceFilterAction_Hold;
6883 else
6884 {
6885 return errorArgument("Invalid USB filter action '%s'", argv[i]);
6886 }
6887 }
6888 else
6889 {
6890 return errorSyntax(cmd.mAction == USBFilterCmd::Add ? USAGE_USBFILTER_ADD : USAGE_USBFILTER_MODIFY,
6891 "Unknown option '%s'", argv[i]);
6892 }
6893 }
6894
6895 if (cmd.mAction == USBFilterCmd::Add)
6896 {
6897 // mandatory/forbidden options
6898 if ( cmd.mFilter.mName.isEmpty()
6899 ||
6900 ( cmd.mGlobal
6901 && cmd.mFilter.mAction == USBDeviceFilterAction_Null
6902 )
6903 || ( !cmd.mGlobal
6904 && !cmd.mMachine)
6905 || ( cmd.mGlobal
6906 && cmd.mFilter.mRemote)
6907 )
6908 {
6909 return errorSyntax(USAGE_USBFILTER_ADD, "Mandatory options not supplied");
6910 }
6911 }
6912 break;
6913 }
6914
6915 case USBFilterCmd::Remove:
6916 {
6917 /* at least: 0: command, 1: index, 2: -target, 3: <target value> */
6918 if (argc < 4)
6919 {
6920 return errorSyntax(USAGE_USBFILTER_REMOVE, "Not enough parameters");
6921 }
6922
6923 for (int i = 2; i < argc; i++)
6924 {
6925 if (strcmp(argv [i], "-target") == 0)
6926 {
6927 if (argc <= i + 1 || !*argv[i+1])
6928 {
6929 return errorArgument("Missing argument to '%s'", argv[i]);
6930 }
6931 i++;
6932 if (strcmp (argv [i], "global") == 0)
6933 cmd.mGlobal = true;
6934 else
6935 {
6936 /* assume it's a UUID of a machine */
6937 rc = aVirtualBox->GetMachine(Guid(argv[i]), cmd.mMachine.asOutParam());
6938 if (FAILED(rc) || !cmd.mMachine)
6939 {
6940 /* must be a name */
6941 CHECK_ERROR_RET(aVirtualBox, FindMachine(Bstr(argv[i]), cmd.mMachine.asOutParam()), 1);
6942 }
6943 }
6944 }
6945 }
6946
6947 // mandatory options
6948 if (!cmd.mGlobal && !cmd.mMachine)
6949 {
6950 return errorSyntax(USAGE_USBFILTER_REMOVE, "Mandatory options not supplied");
6951 }
6952
6953 break;
6954 }
6955
6956 default: break;
6957 }
6958
6959 USBFilterCmd::USBFilter &f = cmd.mFilter;
6960
6961 ComPtr <IHost> host;
6962 ComPtr <IUSBController> ctl;
6963 if (cmd.mGlobal)
6964 CHECK_ERROR_RET (aVirtualBox, COMGETTER(Host) (host.asOutParam()), 1);
6965 else
6966 {
6967 Guid uuid;
6968 cmd.mMachine->COMGETTER(Id)(uuid.asOutParam());
6969 /* open a session for the VM */
6970 CHECK_ERROR_RET (aVirtualBox, OpenSession(aSession, uuid), 1);
6971 /* get the mutable session machine */
6972 aSession->COMGETTER(Machine)(cmd.mMachine.asOutParam());
6973 /* and get the USB controller */
6974 CHECK_ERROR_RET (cmd.mMachine, COMGETTER(USBController) (ctl.asOutParam()), 1);
6975 }
6976
6977 switch (cmd.mAction)
6978 {
6979 case USBFilterCmd::Add:
6980 {
6981 if (cmd.mGlobal)
6982 {
6983 ComPtr <IHostUSBDeviceFilter> flt;
6984 CHECK_ERROR_BREAK (host, CreateUSBDeviceFilter (f.mName, flt.asOutParam()));
6985
6986 if (!f.mActive.isNull())
6987 CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
6988 if (!f.mVendorId.isNull())
6989 CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
6990 if (!f.mProductId.isNull())
6991 CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
6992 if (!f.mRevision.isNull())
6993 CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
6994 if (!f.mManufacturer.isNull())
6995 CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
6996 if (!f.mSerialNumber.isNull())
6997 CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
6998 if (!f.mMaskedInterfaces.isNull())
6999 CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
7000
7001 if (f.mAction != USBDeviceFilterAction_Null)
7002 CHECK_ERROR_BREAK (flt, COMSETTER(Action) (f.mAction));
7003
7004 CHECK_ERROR_BREAK (host, InsertUSBDeviceFilter (cmd.mIndex, flt));
7005 }
7006 else
7007 {
7008 ComPtr <IUSBDeviceFilter> flt;
7009 CHECK_ERROR_BREAK (ctl, CreateDeviceFilter (f.mName, flt.asOutParam()));
7010
7011 if (!f.mActive.isNull())
7012 CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
7013 if (!f.mVendorId.isNull())
7014 CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
7015 if (!f.mProductId.isNull())
7016 CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
7017 if (!f.mRevision.isNull())
7018 CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
7019 if (!f.mManufacturer.isNull())
7020 CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
7021 if (!f.mRemote.isNull())
7022 CHECK_ERROR_BREAK (flt, COMSETTER(Remote) (f.mRemote.setNullIfEmpty()));
7023 if (!f.mSerialNumber.isNull())
7024 CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
7025 if (!f.mMaskedInterfaces.isNull())
7026 CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
7027
7028 CHECK_ERROR_BREAK (ctl, InsertDeviceFilter (cmd.mIndex, flt));
7029 }
7030 break;
7031 }
7032 case USBFilterCmd::Modify:
7033 {
7034 if (cmd.mGlobal)
7035 {
7036 ComPtr <IHostUSBDeviceFilterCollection> coll;
7037 CHECK_ERROR_BREAK (host, COMGETTER(USBDeviceFilters) (coll.asOutParam()));
7038 ComPtr <IHostUSBDeviceFilter> flt;
7039 CHECK_ERROR_BREAK (coll, GetItemAt (cmd.mIndex, flt.asOutParam()));
7040
7041 if (!f.mName.isNull())
7042 CHECK_ERROR_BREAK (flt, COMSETTER(Name) (f.mName.setNullIfEmpty()));
7043 if (!f.mActive.isNull())
7044 CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
7045 if (!f.mVendorId.isNull())
7046 CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
7047 if (!f.mProductId.isNull())
7048 CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
7049 if (!f.mRevision.isNull())
7050 CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
7051 if (!f.mManufacturer.isNull())
7052 CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
7053 if (!f.mSerialNumber.isNull())
7054 CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
7055 if (!f.mMaskedInterfaces.isNull())
7056 CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
7057
7058 if (f.mAction != USBDeviceFilterAction_Null)
7059 CHECK_ERROR_BREAK (flt, COMSETTER(Action) (f.mAction));
7060 }
7061 else
7062 {
7063 ComPtr <IUSBDeviceFilterCollection> coll;
7064 CHECK_ERROR_BREAK (ctl, COMGETTER(DeviceFilters) (coll.asOutParam()));
7065
7066 ComPtr <IUSBDeviceFilter> flt;
7067 CHECK_ERROR_BREAK (coll, GetItemAt (cmd.mIndex, flt.asOutParam()));
7068
7069 if (!f.mName.isNull())
7070 CHECK_ERROR_BREAK (flt, COMSETTER(Name) (f.mName.setNullIfEmpty()));
7071 if (!f.mActive.isNull())
7072 CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive));
7073 if (!f.mVendorId.isNull())
7074 CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty()));
7075 if (!f.mProductId.isNull())
7076 CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty()));
7077 if (!f.mRevision.isNull())
7078 CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty()));
7079 if (!f.mManufacturer.isNull())
7080 CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty()));
7081 if (!f.mRemote.isNull())
7082 CHECK_ERROR_BREAK (flt, COMSETTER(Remote) (f.mRemote.setNullIfEmpty()));
7083 if (!f.mSerialNumber.isNull())
7084 CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty()));
7085 if (!f.mMaskedInterfaces.isNull())
7086 CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces));
7087 }
7088 break;
7089 }
7090 case USBFilterCmd::Remove:
7091 {
7092 if (cmd.mGlobal)
7093 {
7094 ComPtr <IHostUSBDeviceFilter> flt;
7095 CHECK_ERROR_BREAK (host, RemoveUSBDeviceFilter (cmd.mIndex, flt.asOutParam()));
7096 }
7097 else
7098 {
7099 ComPtr <IUSBDeviceFilter> flt;
7100 CHECK_ERROR_BREAK (ctl, RemoveDeviceFilter (cmd.mIndex, flt.asOutParam()));
7101 }
7102 break;
7103 }
7104 default:
7105 break;
7106 }
7107
7108 if (cmd.mMachine)
7109 {
7110 /* commit and close the session */
7111 CHECK_ERROR(cmd.mMachine, SaveSettings());
7112 aSession->Close();
7113 }
7114
7115 return SUCCEEDED (rc) ? 0 : 1;
7116}
7117
7118static int handleSharedFolder (int argc, char *argv[],
7119 ComPtr <IVirtualBox> aVirtualBox, ComPtr<ISession> aSession)
7120{
7121 HRESULT rc;
7122
7123 /* we need at least a command and target */
7124 if (argc < 2)
7125 {
7126 return errorSyntax(USAGE_SHAREDFOLDER, "Not enough parameters");
7127 }
7128
7129 ComPtr<IMachine> machine;
7130 /* assume it's a UUID */
7131 rc = aVirtualBox->GetMachine(Guid(argv[1]), machine.asOutParam());
7132 if (FAILED(rc) || !machine)
7133 {
7134 /* must be a name */
7135 CHECK_ERROR(aVirtualBox, FindMachine(Bstr(argv[1]), machine.asOutParam()));
7136 }
7137 if (!machine)
7138 return 1;
7139 Guid uuid;
7140 machine->COMGETTER(Id)(uuid.asOutParam());
7141
7142 if (strcmp(argv[0], "add") == 0)
7143 {
7144 /* we need at least four more parameters */
7145 if (argc < 5)
7146 {
7147 return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Not enough parameters");
7148 }
7149
7150 char *name = NULL;
7151 char *hostpath = NULL;
7152 bool fTransient = false;
7153 bool fWritable = true;
7154
7155 for (int i = 2; i < argc; i++)
7156 {
7157 if (strcmp(argv[i], "-name") == 0)
7158 {
7159 if (argc <= i + 1 || !*argv[i+1])
7160 {
7161 return errorArgument("Missing argument to '%s'", argv[i]);
7162 }
7163 i++;
7164 name = argv[i];
7165 }
7166 else if (strcmp(argv[i], "-hostpath") == 0)
7167 {
7168 if (argc <= i + 1 || !*argv[i+1])
7169 {
7170 return errorArgument("Missing argument to '%s'", argv[i]);
7171 }
7172 i++;
7173 hostpath = argv[i];
7174 }
7175 else if (strcmp(argv[i], "-readonly") == 0)
7176 {
7177 fWritable = false;
7178 }
7179 else if (strcmp(argv[i], "-transient") == 0)
7180 {
7181 fTransient = true;
7182 }
7183 else
7184 {
7185 return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
7186 }
7187 }
7188
7189 /* required arguments */
7190 if (!name || !hostpath)
7191 {
7192 return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Parameters -name and -hostpath are required");
7193 }
7194
7195 if (fTransient)
7196 {
7197 ComPtr <IConsole> console;
7198
7199 /* open an existing session for the VM */
7200 CHECK_ERROR_RET(aVirtualBox, OpenExistingSession (aSession, uuid), 1);
7201 /* get the session machine */
7202 CHECK_ERROR_RET(aSession, COMGETTER(Machine)(machine.asOutParam()), 1);
7203 /* get the session console */
7204 CHECK_ERROR_RET(aSession, COMGETTER(Console)(console.asOutParam()), 1);
7205
7206 CHECK_ERROR(console, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable));
7207
7208 if (console)
7209 aSession->Close();
7210 }
7211 else
7212 {
7213 /* open a session for the VM */
7214 CHECK_ERROR_RET (aVirtualBox, OpenSession(aSession, uuid), 1);
7215
7216 /* get the mutable session machine */
7217 aSession->COMGETTER(Machine)(machine.asOutParam());
7218
7219 CHECK_ERROR(machine, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable));
7220
7221 if (SUCCEEDED(rc))
7222 CHECK_ERROR(machine, SaveSettings());
7223
7224 aSession->Close();
7225 }
7226 }
7227 else if (strcmp(argv[0], "remove") == 0)
7228 {
7229 /* we need at least two more parameters */
7230 if (argc < 3)
7231 {
7232 return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Not enough parameters");
7233 }
7234
7235 char *name = NULL;
7236 bool fTransient = false;
7237
7238 for (int i = 2; i < argc; i++)
7239 {
7240 if (strcmp(argv[i], "-name") == 0)
7241 {
7242 if (argc <= i + 1 || !*argv[i+1])
7243 {
7244 return errorArgument("Missing argument to '%s'", argv[i]);
7245 }
7246 i++;
7247 name = argv[i];
7248 }
7249 else if (strcmp(argv[i], "-transient") == 0)
7250 {
7251 fTransient = true;
7252 }
7253 else
7254 {
7255 return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
7256 }
7257 }
7258
7259 /* required arguments */
7260 if (!name)
7261 {
7262 return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Parameter -name is required");
7263 }
7264
7265 if (fTransient)
7266 {
7267 ComPtr <IConsole> console;
7268
7269 /* open an existing session for the VM */
7270 CHECK_ERROR_RET(aVirtualBox, OpenExistingSession (aSession, uuid), 1);
7271 /* get the session machine */
7272 CHECK_ERROR_RET(aSession, COMGETTER(Machine)(machine.asOutParam()), 1);
7273 /* get the session console */
7274 CHECK_ERROR_RET(aSession, COMGETTER(Console)(console.asOutParam()), 1);
7275
7276 CHECK_ERROR(console, RemoveSharedFolder(Bstr(name)));
7277
7278 if (console)
7279 aSession->Close();
7280 }
7281 else
7282 {
7283 /* open a session for the VM */
7284 CHECK_ERROR_RET (aVirtualBox, OpenSession(aSession, uuid), 1);
7285
7286 /* get the mutable session machine */
7287 aSession->COMGETTER(Machine)(machine.asOutParam());
7288
7289 CHECK_ERROR(machine, RemoveSharedFolder(Bstr(name)));
7290
7291 /* commit and close the session */
7292 CHECK_ERROR(machine, SaveSettings());
7293 aSession->Close();
7294 }
7295 }
7296 else
7297 {
7298 return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", Utf8Str(argv[0]).raw());
7299 }
7300 return 0;
7301}
7302
7303static int handleVMStatistics(int argc, char *argv[],
7304 ComPtr<IVirtualBox> aVirtualBox, ComPtr<ISession> aSession)
7305{
7306 HRESULT rc;
7307
7308 /* at least one option: the UUID or name of the VM */
7309 if (argc < 1)
7310 return errorSyntax(USAGE_VM_STATISTICS, "Incorrect number of parameters");
7311
7312 /* try to find the given machine */
7313 ComPtr <IMachine> machine;
7314 Guid uuid (argv[0]);
7315 if (!uuid.isEmpty())
7316 CHECK_ERROR(aVirtualBox, GetMachine(uuid, machine.asOutParam()));
7317 else
7318 {
7319 CHECK_ERROR(aVirtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam()));
7320 if (SUCCEEDED (rc))
7321 machine->COMGETTER(Id)(uuid.asOutParam());
7322 }
7323 if (FAILED(rc))
7324 return 1;
7325
7326 /* parse arguments. */
7327 bool fReset = false;
7328 bool fWithDescriptions = false;
7329 const char *pszPattern = NULL; /* all */
7330 for (int i = 1; i < argc; i++)
7331 {
7332 if (!strcmp(argv[i], "-pattern"))
7333 {
7334 if (pszPattern)
7335 return errorSyntax(USAGE_VM_STATISTICS, "Multiple -patterns options is not permitted");
7336 if (i + 1 >= argc)
7337 return errorArgument("Missing argument to '%s'", argv[i]);
7338 pszPattern = argv[++i];
7339 }
7340 else if (!strcmp(argv[i], "-descriptions"))
7341 fWithDescriptions = true;
7342 /* add: -file <filename> and -formatted */
7343 else if (!strcmp(argv[i], "-reset"))
7344 fReset = true;
7345 else
7346 return errorSyntax(USAGE_VM_STATISTICS, "Unknown option '%s'", argv[i]);
7347 }
7348 if (fReset && fWithDescriptions)
7349 return errorSyntax(USAGE_VM_STATISTICS, "The -reset and -descriptions options does not mix");
7350
7351
7352 /* open an existing session for the VM. */
7353 CHECK_ERROR(aVirtualBox, OpenExistingSession(aSession, uuid));
7354 if (SUCCEEDED(rc))
7355 {
7356 /* get the session console. */
7357 ComPtr <IConsole> console;
7358 CHECK_ERROR(aSession, COMGETTER(Console)(console.asOutParam()));
7359 if (SUCCEEDED(rc))
7360 {
7361 /* get the machine debugger. */
7362 ComPtr <IMachineDebugger> debugger;
7363 CHECK_ERROR(console, COMGETTER(Debugger)(debugger.asOutParam()));
7364 if (SUCCEEDED(rc))
7365 {
7366 if (fReset)
7367 CHECK_ERROR(debugger, ResetStats(Bstr(pszPattern).raw()));
7368 else
7369 {
7370 Bstr stats;
7371 CHECK_ERROR(debugger, GetStats(Bstr(pszPattern).raw(), fWithDescriptions, stats.asOutParam()));
7372 if (SUCCEEDED(rc))
7373 {
7374 /* if (fFormatted)
7375 { big mess }
7376 else
7377 */
7378 RTPrintf("%ls\n", stats.raw());
7379 }
7380 }
7381 }
7382 aSession->Close();
7383 }
7384 }
7385
7386 return SUCCEEDED(rc) ? 0 : 1;
7387}
7388
7389enum HUSPD { HUSPD_DryRun, HUSPD_Apply, HUSPD_ApplyNoBackup };
7390
7391static int handleUpdateSettings_processFile (const char *filePath, HUSPD mode)
7392{
7393 RTPrintf ("%s\n", filePath);
7394
7395/// @todo later, when the settings file update funciton is reimplemented using
7396/// libxslt (search for CFGLDR to find related parts of code below). Note that
7397/// it doesn't make sense to enable this code since CFGLDR is no more
7398/// available.
7399#if 0
7400
7401 CFGHANDLE config = 0;
7402 char *errMsg = NULL;
7403
7404 int vrc = CFGLDRLoad (&config, filePath, NIL_RTFILE,
7405 NULL, false, NULL, //cfgLdrEntityResolver,
7406 &errMsg);
7407 if (VBOX_SUCCESS (vrc))
7408 {
7409 CFGNODE vbox = 0;
7410 CFGLDRGetNode (config, "VirtualBox", 0, &vbox);
7411 Bstr version;
7412 CFGLDRQueryBSTR (vbox, "version", version.asOutParam());
7413 CFGLDRReleaseNode (vbox);
7414
7415 RTPrintf (" current version : %ls\n", version.raw());
7416
7417 /// @todo (dmik) use cfgLdrEntityResolver later
7418 vrc = CFGLDRTransform (config, "SettingsConverter.xsl", NULL, &errMsg);
7419 if (VBOX_SUCCESS (vrc))
7420 {
7421 CFGLDRGetNode (config, "VirtualBox", 0, &vbox);
7422 CFGLDRQueryBSTR (vbox, "version", version.asOutParam());
7423 CFGLDRReleaseNode (vbox);
7424
7425 RTPrintf (" new version : %ls\n\n", version.raw());
7426
7427 if (mode != HUSPD_DryRun)
7428 {
7429 if (mode != HUSPD_ApplyNoBackup)
7430 {
7431 Utf8StrFmt filePathBak ("%s.bak", filePath);
7432 vrc = RTFileCopy (filePath, filePathBak);
7433 if (VBOX_FAILURE (vrc))
7434 {
7435 RTPrintf ("Error copying '%s' to '%s' (%Vrc)\n",
7436 filePath, filePathBak.raw(), vrc);
7437 }
7438 }
7439
7440 if (VBOX_SUCCESS (vrc))
7441 {
7442 vrc = CFGLDRSave (config, &errMsg);
7443 if (VBOX_FAILURE (vrc))
7444 {
7445 RTPrintf ("Error saving the settings file '%s' (%Vrc)%s%s\n",
7446 filePath, vrc,
7447 errMsg ? "\n" : "", errMsg ? errMsg : "");
7448 }
7449 }
7450 }
7451 }
7452 else
7453 {
7454 RTPrintf ("Could not convert the settings file '%s' (%Vrc)%s%s\n",
7455 filePath, vrc, errMsg ? "\n" : "", errMsg ? errMsg : "");
7456 }
7457
7458 CFGLDRFree (config);
7459 }
7460 else
7461 {
7462 RTPrintf ("Error loading the settings file '%s' (%Vrc)%s%s\n",
7463 filePath, vrc, errMsg ? "\n" : "", errMsg ? errMsg : "");
7464 }
7465
7466 if (errMsg)
7467 RTStrFree (errMsg);
7468
7469 return vrc;
7470
7471#else
7472
7473 RTPrintf ("Error converting settings file '%s': "
7474 "THE FUNCTION IS TEMPORARILY DISABLED!\n");
7475 return 1;
7476
7477#endif
7478}
7479
7480static int handleUpdateSettings_processDir (const char *dirPath, HUSPD mode,
7481 bool skipInvalid)
7482{
7483 PRTDIR dir;
7484 int vrc = RTDirOpen (&dir, dirPath);
7485 if (VBOX_FAILURE (vrc))
7486 {
7487 return vrc;
7488 }
7489
7490 RTDIRENTRYEX entry;
7491 while (VBOX_SUCCESS (vrc))
7492 {
7493 vrc = RTDirReadEx (dir, &entry, NULL, RTFSOBJATTRADD_UNIX);
7494 if (VBOX_FAILURE (vrc))
7495 {
7496 if (vrc == VERR_NO_MORE_FILES)
7497 vrc = VINF_SUCCESS;
7498 else
7499 RTPrintf ("Error reading directory '%s' (%Vrc)\n", dirPath, vrc);
7500 break;
7501 }
7502
7503 if (RTFS_IS_DIRECTORY (entry.Info.Attr.fMode))
7504 {
7505 if (entry.szName[0] == '.' &&
7506 (entry.szName[1] == 0 ||
7507 (entry.szName[1] == '.' && entry.szName[2] == 0)))
7508 continue;
7509
7510 vrc = handleUpdateSettings_processDir (
7511 Utf8StrFmt ("%s%c%s", dirPath, RTPATH_DELIMITER, entry.szName),
7512 mode, skipInvalid);
7513 if (VBOX_FAILURE (vrc))
7514 break;
7515
7516 continue;
7517 }
7518 else if (RTFS_IS_FILE (entry.Info.Attr.fMode))
7519 {
7520 const char *ext = RTPathExt (entry.szName);
7521 if (!ext || strcmp (ext, ".xml") != 0)
7522 continue;
7523 }
7524 else
7525 continue;
7526
7527 Utf8Str filePath = Utf8StrFmt ("%s%c%s", dirPath, RTPATH_DELIMITER,
7528 entry.szName);
7529
7530 vrc = handleUpdateSettings_processFile (filePath, mode);
7531
7532 if (skipInvalid)
7533 vrc = VINF_SUCCESS;
7534 }
7535
7536 RTDirClose (dir);
7537
7538 return vrc;
7539}
7540
7541static int handleUpdateSettings (int argc, char *argv[])
7542{
7543 const char *dirOrFilePath = NULL;
7544 bool apply = false;
7545 bool nobackup = false;
7546 bool skipinvalid = false;
7547
7548 for (int i = 0; i < argc; i++)
7549 {
7550 if (i == 0 && argv[i][0] != '-')
7551 {
7552 dirOrFilePath = argv[i];
7553 }
7554 else if (argv[i][0] == '-')
7555 {
7556 if (strcmp (&argv[i][1], "apply") == 0)
7557 apply = true;
7558 else if (strcmp (&argv[i][1], "nobackup") == 0)
7559 nobackup = true;
7560 else if (strcmp (&argv[i][1], "skipinvalid") == 0)
7561 skipinvalid = true;
7562 else
7563 {
7564 return errorSyntax(USAGE_UPDATESETTINGS, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
7565 }
7566 }
7567 else
7568 {
7569 return errorSyntax(USAGE_UPDATESETTINGS, "Invalid parameter '%s'", Utf8Str(argv[i]).raw());
7570 }
7571 }
7572
7573 HUSPD mode = HUSPD_DryRun;
7574 if (apply)
7575 mode = nobackup ? HUSPD_ApplyNoBackup : HUSPD_Apply;
7576
7577/// @todo later, when the settings file update funciton is reimplemented using
7578/// libxslt (search for CFGLDR to find related parts of code below). Note that
7579/// it doesn't make sense to enable this code since CFGLDR is no more
7580/// available.
7581#if 0
7582
7583 int vrc = CFGLDRInitialize();
7584 if (VBOX_FAILURE (vrc))
7585 {
7586 RTPrintf ("Could not initialize XML subsystem (%Vrc)\n", vrc);
7587 return 1;
7588 }
7589
7590 if (dirOrFilePath)
7591 {
7592 if (RTDirExists (dirOrFilePath))
7593 {
7594 char fullPath [RTPATH_MAX];
7595 vrc = RTPathReal (dirOrFilePath, fullPath, RTPATH_MAX);
7596 if (VBOX_FAILURE (vrc))
7597 {
7598 RTPrintf ("Invalid directory path '%s' (%Vrc)\n", dirOrFilePath, vrc);
7599 return 1;
7600 }
7601
7602 RTPrintf ("Updating settings files in the following directory:\n"
7603 "\n %s\n\n", fullPath);
7604
7605 vrc = handleUpdateSettings_processDir (dirOrFilePath, mode, skipinvalid);
7606 }
7607 else
7608 {
7609 vrc = handleUpdateSettings_processFile (dirOrFilePath, mode);
7610 }
7611 }
7612 else
7613 {
7614 char homeDir [RTPATH_MAX];
7615 vrc = GetVBoxUserHomeDirectory (homeDir, sizeof (homeDir));
7616
7617 AssertRC (vrc);
7618 if (VBOX_SUCCESS (vrc))
7619 {
7620 RTPrintf ("Updating settings files in the following VirtualBox Home Directory:\n"
7621 "\n %s\n\n", homeDir);
7622
7623 vrc = handleUpdateSettings_processDir (homeDir, mode, skipinvalid);
7624 }
7625 }
7626
7627 if (mode == HUSPD_DryRun)
7628 {
7629 RTPrintf ("NOTE: No actual changes to the setting files were made.\n"
7630 " Repeat the command with the -apply option supplied.\n");
7631 }
7632
7633 CFGLDRShutdown();
7634
7635 return VBOX_SUCCESS (vrc) ? 0 : 1;
7636
7637#else
7638
7639 NOREF (mode);
7640
7641 RTPrintf ("THE SETTINGS FILE UPDATE FUNCTION IS TEMPORARILY DISABLED!\n");
7642 return 1;
7643
7644
7645#endif
7646}
7647
7648// main
7649///////////////////////////////////////////////////////////////////////////////
7650
7651int main(int argc, char *argv[])
7652{
7653 /*
7654 * Before we do anything, init the runtime without loading
7655 * the support driver.
7656 */
7657 RTR3Init(false);
7658
7659 bool fShowLogo = true;
7660 int iCmd = 1;
7661 int iCmdArg;
7662
7663 for (int i = 1; i < argc || argc <= iCmd; i++)
7664 {
7665 if ( argc <= iCmd
7666 || (strcmp(argv[i], "help") == 0)
7667 || (strcmp(argv[i], "-?") == 0)
7668 || (strcmp(argv[i], "-h") == 0)
7669 || (strcmp(argv[i], "-help") == 0)
7670 || (strcmp(argv[i], "--help") == 0))
7671 {
7672 showLogo();
7673 printUsage(USAGE_ALL);
7674 return 0;
7675 }
7676 else if ( strcmp(argv[i], "-v") == 0
7677 || strcmp(argv[i], "-version") == 0
7678 || strcmp(argv[i], "-Version") == 0
7679 || strcmp(argv[i], "--version") == 0)
7680 {
7681 /* Print version number, and do nothing else. */
7682 RTPrintf("%sr%d\n", VBOX_VERSION_STRING, VBoxSVNRev ());
7683 exit(0);
7684 }
7685 else if (strcmp(argv[i], "-nologo") == 0)
7686 {
7687 /* suppress the logo */
7688 fShowLogo = false;
7689 iCmd++;
7690 }
7691 else if (strcmp(argv[i], "-dumpopts") == 0)
7692 {
7693 /* Special option to dump really all commands,
7694 * even the ones not understood on this platform. */
7695 printUsage(USAGE_DUMPOPTS);
7696 return 0;
7697 }
7698 else
7699 {
7700 break;
7701 }
7702 }
7703
7704 iCmdArg = iCmd + 1;
7705
7706 if (fShowLogo)
7707 showLogo();
7708
7709 HRESULT rc;
7710
7711 CHECK_RC_RET (com::Initialize());
7712
7713 /*
7714 * The input is in the host OS'es codepage (NT guarantees ACP).
7715 * For VBox we use UTF-8 and convert to UCS-2 when calling (XP)COM APIs.
7716 * For simplicity, just convert the argv[] array here.
7717 */
7718 for (int i = iCmdArg; i < argc; i++)
7719 {
7720 char *converted;
7721 RTStrCurrentCPToUtf8(&converted, argv[i]);
7722 argv[i] = converted;
7723 }
7724
7725 do
7726 {
7727 // scopes all the stuff till shutdown
7728 ////////////////////////////////////////////////////////////////////////////
7729
7730 /* update settings command (no VirtualBox instantiation!) */
7731 if (argc >= iCmdArg && (strcmp(argv[iCmd], "updatesettings") == 0))
7732 {
7733 rc = handleUpdateSettings(argc - iCmdArg, argv + iCmdArg);
7734 break;
7735 }
7736
7737 /* convertdd: does not need a VirtualBox instantiation) */
7738 if (argc >= iCmdArg && (strcmp(argv[iCmd], "convertdd") == 0))
7739 {
7740 rc = handleConvertDDImage(argc - iCmdArg, argv + iCmdArg);
7741 break;
7742 }
7743
7744 ComPtr <IVirtualBox> virtualBox;
7745 ComPtr <ISession> session;
7746
7747 rc = virtualBox.createLocalObject (CLSID_VirtualBox);
7748 if (FAILED(rc))
7749 {
7750 RTPrintf ("[!] Failed to create the VirtualBox object!\n");
7751 PRINT_RC_MESSAGE (rc);
7752
7753 com::ErrorInfo info;
7754 if (!info.isFullAvailable() && !info.isBasicAvailable())
7755 RTPrintf ("[!] Most likely, the VirtualBox COM server is not running "
7756 "or failed to start.\n");
7757 else
7758 PRINT_ERROR_INFO (info);
7759 break;
7760 }
7761
7762 CHECK_RC_BREAK (session.createInprocObject (CLSID_Session));
7763
7764 /* create the event queue
7765 * (here it is necessary only to process remaining XPCOM/IPC events
7766 * after the session is closed) */
7767
7768 EventQueue eventQ;
7769
7770 /*
7771 * All registered command handlers
7772 */
7773 struct
7774 {
7775 const char *command;
7776 PFNHANDLER handler;
7777 } commandHandlers[] =
7778 {
7779 { "internalcommands", handleInternalCommands },
7780 { "list", handleList },
7781 { "showvminfo", handleShowVMInfo },
7782 { "registervm", handleRegisterVM },
7783 { "unregistervm", handleUnregisterVM },
7784 { "createvdi", handleCreateVDI },
7785 { "modifyvdi", handleModifyVDI },
7786 { "addiscsidisk", handleAddiSCSIDisk },
7787 { "createvm", handleCreateVM },
7788 { "modifyvm", handleModifyVM },
7789 { "clonevdi", handleCloneVDI },
7790 { "startvm", handleStartVM },
7791 { "controlvm", handleControlVM },
7792 { "discardstate", handleDiscardState },
7793 { "adoptstate", handleAdoptdState },
7794 { "snapshot", handleSnapshot },
7795 { "registerimage", handleRegisterImage },
7796 { "unregisterimage", handleUnregisterImage },
7797 { "showvdiinfo", handleShowVDIInfo },
7798#ifdef RT_OS_WINDOWS
7799 { "createhostif", handleCreateHostIF },
7800 { "removehostif", handleRemoveHostIF },
7801#endif
7802 { "getextradata", handleGetExtraData },
7803 { "setextradata", handleSetExtraData },
7804 { "setproperty", handleSetProperty },
7805 { "usbfilter", handleUSBFilter },
7806 { "sharedfolder", handleSharedFolder },
7807 { "vmstatistics", handleVMStatistics },
7808 { NULL, NULL }
7809 };
7810
7811 int commandIndex;
7812 for (commandIndex = 0; commandHandlers[commandIndex].command != NULL; commandIndex++)
7813 {
7814 if (strcmp(commandHandlers[commandIndex].command, argv[iCmd]) == 0)
7815 {
7816 rc = commandHandlers[commandIndex].handler(argc - iCmdArg, &argv[iCmdArg], virtualBox, session);
7817 break;
7818 }
7819 }
7820 if (!commandHandlers[commandIndex].command)
7821 {
7822 rc = errorSyntax(USAGE_ALL, "Invalid command '%s'", Utf8Str(argv[iCmd]).raw());
7823 }
7824
7825 /* Although all handlers should always close the session if they open it,
7826 * we do it here just in case if some of the handlers contains a bug --
7827 * leaving the direct session not closed will turn the machine state to
7828 * Aborted which may have unwanted side effects like killing the saved
7829 * state file (if the machine was in the Saved state before). */
7830 session->Close();
7831
7832 // end "all-stuff" scope
7833 ////////////////////////////////////////////////////////////////////////////
7834 }
7835 while (0);
7836
7837 com::Shutdown();
7838
7839 /*
7840 * Free converted argument vector
7841 */
7842 for (int i = iCmdArg; i < argc; i++)
7843 RTStrFree(argv[i]);
7844
7845 return rc;
7846}
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette