VirtualBox

source: vbox/trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp@ 67273

Last change on this file since 67273 was 66938, checked in by vboxsync, 8 years ago

Main/VirtualBox+DHCPServer+GuestOSType: lots of redundant Bstr/Utf8Str conversions removed, less Bstr use in general avoiding the need for conversion, plus some cleanup of VirtualBox::i_findGuestOSType which is now used consistently
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 174.0 KB
Line 
1/* $Id: VirtualBoxImpl.cpp 66938 2017-05-17 16:09:58Z vboxsync $ */
2/** @file
3 * Implementation of IVirtualBox in VBoxSVC.
4 */
5
6/*
7 * Copyright (C) 2006-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#include <iprt/asm.h>
19#include <iprt/base64.h>
20#include <iprt/buildconfig.h>
21#include <iprt/cpp/utils.h>
22#include <iprt/dir.h>
23#include <iprt/env.h>
24#include <iprt/file.h>
25#include <iprt/path.h>
26#include <iprt/process.h>
27#include <iprt/rand.h>
28#include <iprt/sha.h>
29#include <iprt/string.h>
30#include <iprt/stream.h>
31#include <iprt/thread.h>
32#include <iprt/uuid.h>
33#include <iprt/cpp/xml.h>
34
35#include <VBox/com/com.h>
36#include <VBox/com/array.h>
37#include "VBox/com/EventQueue.h"
38#include "VBox/com/MultiResult.h"
39
40#include <VBox/err.h>
41#include <VBox/param.h>
42#include <VBox/settings.h>
43#include <VBox/version.h>
44
45#include <package-generated.h>
46
47#include <algorithm>
48#include <set>
49#include <vector>
50#include <memory> // for auto_ptr
51
52#include "VirtualBoxImpl.h"
53
54#include "Global.h"
55#include "MachineImpl.h"
56#include "MediumImpl.h"
57#include "SharedFolderImpl.h"
58#include "ProgressImpl.h"
59#include "HostImpl.h"
60#include "USBControllerImpl.h"
61#include "SystemPropertiesImpl.h"
62#include "GuestOSTypeImpl.h"
63#include "NetworkServiceRunner.h"
64#include "DHCPServerImpl.h"
65#include "NATNetworkImpl.h"
66#ifdef VBOX_WITH_RESOURCE_USAGE_API
67# include "PerformanceImpl.h"
68#endif /* VBOX_WITH_RESOURCE_USAGE_API */
69#include "EventImpl.h"
70#ifdef VBOX_WITH_EXTPACK
71# include "ExtPackManagerImpl.h"
72#endif
73#include "AutostartDb.h"
74#include "ClientWatcher.h"
75
76#include "AutoCaller.h"
77#include "Logging.h"
78
79#include <QMTranslator.h>
80
81#ifdef RT_OS_WINDOWS
82# include "win/svchlp.h"
83# include "tchar.h"
84#endif
85
86#include "ThreadTask.h"
87
88////////////////////////////////////////////////////////////////////////////////
89//
90// Definitions
91//
92////////////////////////////////////////////////////////////////////////////////
93
94#define VBOX_GLOBAL_SETTINGS_FILE "VirtualBox.xml"
95
96////////////////////////////////////////////////////////////////////////////////
97//
98// Global variables
99//
100////////////////////////////////////////////////////////////////////////////////
101
102// static
103com::Utf8Str VirtualBox::sVersion;
104
105// static
106com::Utf8Str VirtualBox::sVersionNormalized;
107
108// static
109ULONG VirtualBox::sRevision;
110
111// static
112com::Utf8Str VirtualBox::sPackageType;
113
114// static
115com::Utf8Str VirtualBox::sAPIVersion;
116
117// static
118std::map<com::Utf8Str, int> VirtualBox::sNatNetworkNameToRefCount;
119
120// static leaked (todo: find better place to free it.)
121RWLockHandle *VirtualBox::spMtxNatNetworkNameToRefCountLock;
122////////////////////////////////////////////////////////////////////////////////
123//
124// CallbackEvent class
125//
126////////////////////////////////////////////////////////////////////////////////
127
128/**
129 * Abstract callback event class to asynchronously call VirtualBox callbacks
130 * on a dedicated event thread. Subclasses reimplement #prepareEventDesc()
131 * to initialize the event depending on the event to be dispatched.
132 *
133 * @note The VirtualBox instance passed to the constructor is strongly
134 * referenced, so that the VirtualBox singleton won't be released until the
135 * event gets handled by the event thread.
136 */
137class VirtualBox::CallbackEvent : public Event
138{
139public:
140
141 CallbackEvent(VirtualBox *aVirtualBox, VBoxEventType_T aWhat)
142 : mVirtualBox(aVirtualBox), mWhat(aWhat)
143 {
144 Assert(aVirtualBox);
145 }
146
147 void *handler();
148
149 virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc) = 0;
150
151private:
152
153 /**
154 * Note that this is a weak ref -- the CallbackEvent handler thread
155 * is bound to the lifetime of the VirtualBox instance, so it's safe.
156 */
157 VirtualBox *mVirtualBox;
158protected:
159 VBoxEventType_T mWhat;
160};
161
162////////////////////////////////////////////////////////////////////////////////
163//
164// VirtualBox private member data definition
165//
166////////////////////////////////////////////////////////////////////////////////
167
168typedef ObjectsList<Medium> MediaOList;
169typedef ObjectsList<GuestOSType> GuestOSTypesOList;
170typedef ObjectsList<SharedFolder> SharedFoldersOList;
171typedef ObjectsList<DHCPServer> DHCPServersOList;
172typedef ObjectsList<NATNetwork> NATNetworksOList;
173
174typedef std::map<Guid, ComPtr<IProgress> > ProgressMap;
175typedef std::map<Guid, ComObjPtr<Medium> > HardDiskMap;
176
177/**
178 * Main VirtualBox data structure.
179 * @note |const| members are persistent during lifetime so can be accessed
180 * without locking.
181 */
182struct VirtualBox::Data
183{
184 Data()
185 : pMainConfigFile(NULL),
186 uuidMediaRegistry("48024e5c-fdd9-470f-93af-ec29f7ea518c"),
187 uRegistryNeedsSaving(0),
188 lockMachines(LOCKCLASS_LISTOFMACHINES),
189 allMachines(lockMachines),
190 lockGuestOSTypes(LOCKCLASS_LISTOFOTHEROBJECTS),
191 allGuestOSTypes(lockGuestOSTypes),
192 lockMedia(LOCKCLASS_LISTOFMEDIA),
193 allHardDisks(lockMedia),
194 allDVDImages(lockMedia),
195 allFloppyImages(lockMedia),
196 lockSharedFolders(LOCKCLASS_LISTOFOTHEROBJECTS),
197 allSharedFolders(lockSharedFolders),
198 lockDHCPServers(LOCKCLASS_LISTOFOTHEROBJECTS),
199 allDHCPServers(lockDHCPServers),
200 lockNATNetworks(LOCKCLASS_LISTOFOTHEROBJECTS),
201 allNATNetworks(lockNATNetworks),
202 mtxProgressOperations(LOCKCLASS_PROGRESSLIST),
203 pClientWatcher(NULL),
204 threadAsyncEvent(NIL_RTTHREAD),
205 pAsyncEventQ(NULL),
206 pAutostartDb(NULL),
207 fSettingsCipherKeySet(false)
208 {
209 }
210
211 ~Data()
212 {
213 if (pMainConfigFile)
214 {
215 delete pMainConfigFile;
216 pMainConfigFile = NULL;
217 }
218 };
219
220 // const data members not requiring locking
221 const Utf8Str strHomeDir;
222
223 // VirtualBox main settings file
224 const Utf8Str strSettingsFilePath;
225 settings::MainConfigFile *pMainConfigFile;
226
227 // constant pseudo-machine ID for global media registry
228 const Guid uuidMediaRegistry;
229
230 // counter if global media registry needs saving, updated using atomic
231 // operations, without requiring any locks
232 uint64_t uRegistryNeedsSaving;
233
234 // const objects not requiring locking
235 const ComObjPtr<Host> pHost;
236 const ComObjPtr<SystemProperties> pSystemProperties;
237#ifdef VBOX_WITH_RESOURCE_USAGE_API
238 const ComObjPtr<PerformanceCollector> pPerformanceCollector;
239#endif /* VBOX_WITH_RESOURCE_USAGE_API */
240
241 // Each of the following lists use a particular lock handle that protects the
242 // list as a whole. As opposed to version 3.1 and earlier, these lists no
243 // longer need the main VirtualBox object lock, but only the respective list
244 // lock. In each case, the locking order is defined that the list must be
245 // requested before object locks of members of the lists (see the order definitions
246 // in AutoLock.h; e.g. LOCKCLASS_LISTOFMACHINES before LOCKCLASS_MACHINEOBJECT).
247 RWLockHandle lockMachines;
248 MachinesOList allMachines;
249
250 RWLockHandle lockGuestOSTypes;
251 GuestOSTypesOList allGuestOSTypes;
252
253 // All the media lists are protected by the following locking handle:
254 RWLockHandle lockMedia;
255 MediaOList allHardDisks, // base images only!
256 allDVDImages,
257 allFloppyImages;
258 // the hard disks map is an additional map sorted by UUID for quick lookup
259 // and contains ALL hard disks (base and differencing); it is protected by
260 // the same lock as the other media lists above
261 HardDiskMap mapHardDisks;
262
263 // list of pending machine renames (also protected by media tree lock;
264 // see VirtualBox::rememberMachineNameChangeForMedia())
265 struct PendingMachineRename
266 {
267 Utf8Str strConfigDirOld;
268 Utf8Str strConfigDirNew;
269 };
270 typedef std::list<PendingMachineRename> PendingMachineRenamesList;
271 PendingMachineRenamesList llPendingMachineRenames;
272
273 RWLockHandle lockSharedFolders;
274 SharedFoldersOList allSharedFolders;
275
276 RWLockHandle lockDHCPServers;
277 DHCPServersOList allDHCPServers;
278
279 RWLockHandle lockNATNetworks;
280 NATNetworksOList allNATNetworks;
281
282 RWLockHandle mtxProgressOperations;
283 ProgressMap mapProgressOperations;
284
285 ClientWatcher * const pClientWatcher;
286
287 // the following are data for the async event thread
288 const RTTHREAD threadAsyncEvent;
289 EventQueue * const pAsyncEventQ;
290 const ComObjPtr<EventSource> pEventSource;
291
292#ifdef VBOX_WITH_EXTPACK
293 /** The extension pack manager object lives here. */
294 const ComObjPtr<ExtPackManager> ptrExtPackManager;
295#endif
296
297 /** The global autostart database for the user. */
298 AutostartDb * const pAutostartDb;
299
300 /** Settings secret */
301 bool fSettingsCipherKeySet;
302 uint8_t SettingsCipherKey[RTSHA512_HASH_SIZE];
303};
304
305// constructor / destructor
306/////////////////////////////////////////////////////////////////////////////
307
308DEFINE_EMPTY_CTOR_DTOR(VirtualBox)
309
310HRESULT VirtualBox::FinalConstruct()
311{
312 LogRelFlowThisFuncEnter();
313 LogRel(("VirtualBox: object creation starts\n"));
314
315 BaseFinalConstruct();
316
317 HRESULT rc = init();
318
319 LogRelFlowThisFuncLeave();
320 LogRel(("VirtualBox: object created\n"));
321
322 return rc;
323}
324
325void VirtualBox::FinalRelease()
326{
327 LogRelFlowThisFuncEnter();
328 LogRel(("VirtualBox: object deletion starts\n"));
329
330 uninit();
331
332 BaseFinalRelease();
333
334 LogRel(("VirtualBox: object deleted\n"));
335 LogRelFlowThisFuncLeave();
336}
337
338// public initializer/uninitializer for internal purposes only
339/////////////////////////////////////////////////////////////////////////////
340
341/**
342 * Initializes the VirtualBox object.
343 *
344 * @return COM result code
345 */
346HRESULT VirtualBox::init()
347{
348 LogRelFlowThisFuncEnter();
349 /* Enclose the state transition NotReady->InInit->Ready */
350 AutoInitSpan autoInitSpan(this);
351 AssertReturn(autoInitSpan.isOk(), E_FAIL);
352
353 /* Locking this object for writing during init sounds a bit paradoxical,
354 * but in the current locking mess this avoids that some code gets a
355 * read lock and later calls code which wants the same write lock. */
356 AutoWriteLock lock(this COMMA_LOCKVAL_SRC_POS);
357
358 // allocate our instance data
359 m = new Data;
360
361 LogFlow(("===========================================================\n"));
362 LogFlowThisFuncEnter();
363
364 if (sVersion.isEmpty())
365 sVersion = RTBldCfgVersion();
366 if (sVersionNormalized.isEmpty())
367 {
368 Utf8Str tmp(RTBldCfgVersion());
369 if (tmp.endsWith(VBOX_BUILD_PUBLISHER))
370 tmp = tmp.substr(0, tmp.length() - strlen(VBOX_BUILD_PUBLISHER));
371 sVersionNormalized = tmp;
372 }
373 sRevision = RTBldCfgRevision();
374 if (sPackageType.isEmpty())
375 sPackageType = VBOX_PACKAGE_STRING;
376 if (sAPIVersion.isEmpty())
377 sAPIVersion = VBOX_API_VERSION_STRING;
378 if (!spMtxNatNetworkNameToRefCountLock)
379 spMtxNatNetworkNameToRefCountLock = new RWLockHandle(LOCKCLASS_VIRTUALBOXOBJECT);
380
381 LogFlowThisFunc(("Version: %s, Package: %s, API Version: %s\n", sVersion.c_str(), sPackageType.c_str(), sAPIVersion.c_str()));
382
383 /* Important: DO NOT USE any kind of "early return" (except the single
384 * one above, checking the init span success) in this method. It is vital
385 * for correct error handling that it has only one point of return, which
386 * does all the magic on COM to signal object creation success and
387 * reporting the error later for every API method. COM translates any
388 * unsuccessful object creation to REGDB_E_CLASSNOTREG errors or similar
389 * unhelpful ones which cause us a lot of grief with troubleshooting. */
390
391 HRESULT rc = S_OK;
392 bool fCreate = false;
393 try
394 {
395 /* Get the VirtualBox home directory. */
396 {
397 char szHomeDir[RTPATH_MAX];
398 int vrc = com::GetVBoxUserHomeDirectory(szHomeDir, sizeof(szHomeDir));
399 if (RT_FAILURE(vrc))
400 throw setError(E_FAIL,
401 tr("Could not create the VirtualBox home directory '%s' (%Rrc)"),
402 szHomeDir, vrc);
403
404 unconst(m->strHomeDir) = szHomeDir;
405 }
406
407 LogRel(("Home directory: '%s'\n", m->strHomeDir.c_str()));
408
409 i_reportDriverVersions();
410
411 /* compose the VirtualBox.xml file name */
412 unconst(m->strSettingsFilePath) = Utf8StrFmt("%s%c%s",
413 m->strHomeDir.c_str(),
414 RTPATH_DELIMITER,
415 VBOX_GLOBAL_SETTINGS_FILE);
416 // load and parse VirtualBox.xml; this will throw on XML or logic errors
417 try
418 {
419 m->pMainConfigFile = new settings::MainConfigFile(&m->strSettingsFilePath);
420 }
421 catch (xml::EIPRTFailure &e)
422 {
423 // this is thrown by the XML backend if the RTOpen() call fails;
424 // only if the main settings file does not exist, create it,
425 // if there's something more serious, then do fail!
426 if (e.rc() == VERR_FILE_NOT_FOUND)
427 fCreate = true;
428 else
429 throw;
430 }
431
432 if (fCreate)
433 m->pMainConfigFile = new settings::MainConfigFile(NULL);
434
435#ifdef VBOX_WITH_RESOURCE_USAGE_API
436 /* create the performance collector object BEFORE host */
437 unconst(m->pPerformanceCollector).createObject();
438 rc = m->pPerformanceCollector->init();
439 ComAssertComRCThrowRC(rc);
440#endif /* VBOX_WITH_RESOURCE_USAGE_API */
441
442 /* create the host object early, machines will need it */
443 unconst(m->pHost).createObject();
444 rc = m->pHost->init(this);
445 ComAssertComRCThrowRC(rc);
446
447 rc = m->pHost->i_loadSettings(m->pMainConfigFile->host);
448 if (FAILED(rc)) throw rc;
449
450 /*
451 * Create autostart database object early, because the system properties
452 * might need it.
453 */
454 unconst(m->pAutostartDb) = new AutostartDb;
455
456#ifdef VBOX_WITH_EXTPACK
457 /*
458 * Initialize extension pack manager before system properties because
459 * it is required for the VD plugins.
460 */
461 rc = unconst(m->ptrExtPackManager).createObject();
462 if (SUCCEEDED(rc))
463 rc = m->ptrExtPackManager->initExtPackManager(this, VBOXEXTPACKCTX_PER_USER_DAEMON);
464 if (FAILED(rc))
465 throw rc;
466#endif
467
468 /* create the system properties object, someone may need it too */
469 unconst(m->pSystemProperties).createObject();
470 rc = m->pSystemProperties->init(this);
471 ComAssertComRCThrowRC(rc);
472
473 rc = m->pSystemProperties->i_loadSettings(m->pMainConfigFile->systemProperties);
474 if (FAILED(rc)) throw rc;
475
476 /* guest OS type objects, needed by machines */
477 for (size_t i = 0; i < Global::cOSTypes; ++i)
478 {
479 ComObjPtr<GuestOSType> guestOSTypeObj;
480 rc = guestOSTypeObj.createObject();
481 if (SUCCEEDED(rc))
482 {
483 rc = guestOSTypeObj->init(Global::sOSTypes[i]);
484 if (SUCCEEDED(rc))
485 m->allGuestOSTypes.addChild(guestOSTypeObj);
486 }
487 ComAssertComRCThrowRC(rc);
488 }
489
490 /* all registered media, needed by machines */
491 if (FAILED(rc = initMedia(m->uuidMediaRegistry,
492 m->pMainConfigFile->mediaRegistry,
493 Utf8Str::Empty))) // const Utf8Str &machineFolder
494 throw rc;
495
496 /* machines */
497 if (FAILED(rc = initMachines()))
498 throw rc;
499
500#ifdef DEBUG
501 LogFlowThisFunc(("Dumping media backreferences\n"));
502 i_dumpAllBackRefs();
503#endif
504
505 /* net services - dhcp services */
506 for (settings::DHCPServersList::const_iterator it = m->pMainConfigFile->llDhcpServers.begin();
507 it != m->pMainConfigFile->llDhcpServers.end();
508 ++it)
509 {
510 const settings::DHCPServer &data = *it;
511
512 ComObjPtr<DHCPServer> pDhcpServer;
513 if (SUCCEEDED(rc = pDhcpServer.createObject()))
514 rc = pDhcpServer->init(this, data);
515 if (FAILED(rc)) throw rc;
516
517 rc = i_registerDHCPServer(pDhcpServer, false /* aSaveRegistry */);
518 if (FAILED(rc)) throw rc;
519 }
520
521 /* net services - nat networks */
522 for (settings::NATNetworksList::const_iterator it = m->pMainConfigFile->llNATNetworks.begin();
523 it != m->pMainConfigFile->llNATNetworks.end();
524 ++it)
525 {
526 const settings::NATNetwork &net = *it;
527
528 ComObjPtr<NATNetwork> pNATNetwork;
529 rc = pNATNetwork.createObject();
530 AssertComRCThrowRC(rc);
531 rc = pNATNetwork->init(this, "");
532 AssertComRCThrowRC(rc);
533 rc = pNATNetwork->i_loadSettings(net);
534 AssertComRCThrowRC(rc);
535 rc = i_registerNATNetwork(pNATNetwork, false /* aSaveRegistry */);
536 AssertComRCThrowRC(rc);
537 }
538
539 /* events */
540 if (SUCCEEDED(rc = unconst(m->pEventSource).createObject()))
541 rc = m->pEventSource->init();
542 if (FAILED(rc)) throw rc;
543 }
544 catch (HRESULT err)
545 {
546 /* we assume that error info is set by the thrower */
547 rc = err;
548 }
549 catch (...)
550 {
551 rc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
552 }
553
554 if (SUCCEEDED(rc))
555 {
556 /* set up client monitoring */
557 try
558 {
559 unconst(m->pClientWatcher) = new ClientWatcher(this);
560 if (!m->pClientWatcher->isReady())
561 {
562 delete m->pClientWatcher;
563 unconst(m->pClientWatcher) = NULL;
564 rc = E_FAIL;
565 }
566 }
567 catch (std::bad_alloc &)
568 {
569 rc = E_OUTOFMEMORY;
570 }
571 }
572
573 if (SUCCEEDED(rc))
574 {
575 try
576 {
577 /* start the async event handler thread */
578 int vrc = RTThreadCreate(&unconst(m->threadAsyncEvent),
579 AsyncEventHandler,
580 &unconst(m->pAsyncEventQ),
581 0,
582 RTTHREADTYPE_MAIN_WORKER,
583 RTTHREADFLAGS_WAITABLE,
584 "EventHandler");
585 ComAssertRCThrow(vrc, E_FAIL);
586
587 /* wait until the thread sets m->pAsyncEventQ */
588 RTThreadUserWait(m->threadAsyncEvent, RT_INDEFINITE_WAIT);
589 ComAssertThrow(m->pAsyncEventQ, E_FAIL);
590 }
591 catch (HRESULT aRC)
592 {
593 rc = aRC;
594 }
595 }
596
597#ifdef VBOX_WITH_EXTPACK
598 /* Let the extension packs have a go at things. */
599 if (SUCCEEDED(rc))
600 {
601 lock.release();
602 m->ptrExtPackManager->i_callAllVirtualBoxReadyHooks();
603 }
604#endif
605
606 /* Confirm a successful initialization when it's the case. Must be last,
607 * as on failure it will uninitialize the object. */
608 if (SUCCEEDED(rc))
609 autoInitSpan.setSucceeded();
610 else
611 autoInitSpan.setFailed(rc);
612
613 LogFlowThisFunc(("rc=%Rhrc\n", rc));
614 LogFlowThisFuncLeave();
615 LogFlow(("===========================================================\n"));
616 /* Unconditionally return success, because the error return is delayed to
617 * the attribute/method calls through the InitFailed object state. */
618 return S_OK;
619}
620
621HRESULT VirtualBox::initMachines()
622{
623 for (settings::MachinesRegistry::const_iterator it = m->pMainConfigFile->llMachines.begin();
624 it != m->pMainConfigFile->llMachines.end();
625 ++it)
626 {
627 HRESULT rc = S_OK;
628 const settings::MachineRegistryEntry &xmlMachine = *it;
629 Guid uuid = xmlMachine.uuid;
630
631 /* Check if machine record has valid parameters. */
632 if (xmlMachine.strSettingsFile.isEmpty() || uuid.isZero())
633 {
634 LogRel(("Skipped invalid machine record.\n"));
635 continue;
636 }
637
638 ComObjPtr<Machine> pMachine;
639 if (SUCCEEDED(rc = pMachine.createObject()))
640 {
641 rc = pMachine->initFromSettings(this,
642 xmlMachine.strSettingsFile,
643 &uuid);
644 if (SUCCEEDED(rc))
645 rc = i_registerMachine(pMachine);
646 if (FAILED(rc))
647 return rc;
648 }
649 }
650
651 return S_OK;
652}
653
654/**
655 * Loads a media registry from XML and adds the media contained therein to
656 * the global lists of known media.
657 *
658 * This now (4.0) gets called from two locations:
659 *
660 * -- VirtualBox::init(), to load the global media registry from VirtualBox.xml;
661 *
662 * -- Machine::loadMachineDataFromSettings(), to load the per-machine registry
663 * from machine XML, for machines created with VirtualBox 4.0 or later.
664 *
665 * In both cases, the media found are added to the global lists so the
666 * global arrays of media (including the GUI's virtual media manager)
667 * continue to work as before.
668 *
669 * @param uuidRegistry The UUID of the media registry. This is either the
670 * transient UUID created at VirtualBox startup for the global registry or
671 * a machine ID.
672 * @param mediaRegistry The XML settings structure to load, either from VirtualBox.xml
673 * or a machine XML.
674 * @param strMachineFolder The folder of the machine.
675 * @return
676 */
677HRESULT VirtualBox::initMedia(const Guid &uuidRegistry,
678 const settings::MediaRegistry &mediaRegistry,
679 const Utf8Str &strMachineFolder)
680{
681 LogFlow(("VirtualBox::initMedia ENTERING, uuidRegistry=%s, strMachineFolder=%s\n",
682 uuidRegistry.toString().c_str(),
683 strMachineFolder.c_str()));
684
685 AutoWriteLock treeLock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
686
687 HRESULT rc = S_OK;
688 settings::MediaList::const_iterator it;
689 for (it = mediaRegistry.llHardDisks.begin();
690 it != mediaRegistry.llHardDisks.end();
691 ++it)
692 {
693 const settings::Medium &xmlHD = *it;
694
695 ComObjPtr<Medium> pHardDisk;
696 if (SUCCEEDED(rc = pHardDisk.createObject()))
697 rc = pHardDisk->init(this,
698 NULL, // parent
699 DeviceType_HardDisk,
700 uuidRegistry,
701 xmlHD, // XML data; this recurses to processes the children
702 strMachineFolder,
703 treeLock);
704 if (FAILED(rc)) return rc;
705
706 rc = i_registerMedium(pHardDisk, &pHardDisk, treeLock);
707 if (FAILED(rc)) return rc;
708 }
709
710 for (it = mediaRegistry.llDvdImages.begin();
711 it != mediaRegistry.llDvdImages.end();
712 ++it)
713 {
714 const settings::Medium &xmlDvd = *it;
715
716 ComObjPtr<Medium> pImage;
717 if (SUCCEEDED(pImage.createObject()))
718 rc = pImage->init(this,
719 NULL,
720 DeviceType_DVD,
721 uuidRegistry,
722 xmlDvd,
723 strMachineFolder,
724 treeLock);
725 if (FAILED(rc)) return rc;
726
727 rc = i_registerMedium(pImage, &pImage, treeLock);
728 if (FAILED(rc)) return rc;
729 }
730
731 for (it = mediaRegistry.llFloppyImages.begin();
732 it != mediaRegistry.llFloppyImages.end();
733 ++it)
734 {
735 const settings::Medium &xmlFloppy = *it;
736
737 ComObjPtr<Medium> pImage;
738 if (SUCCEEDED(pImage.createObject()))
739 rc = pImage->init(this,
740 NULL,
741 DeviceType_Floppy,
742 uuidRegistry,
743 xmlFloppy,
744 strMachineFolder,
745 treeLock);
746 if (FAILED(rc)) return rc;
747
748 rc = i_registerMedium(pImage, &pImage, treeLock);
749 if (FAILED(rc)) return rc;
750 }
751
752 LogFlow(("VirtualBox::initMedia LEAVING\n"));
753
754 return S_OK;
755}
756
757void VirtualBox::uninit()
758{
759 /* Must be done outside the AutoUninitSpan, as it expects AutoCaller to
760 * be successful. This needs additional checks to protect against double
761 * uninit, as then the pointer is NULL. */
762 if (RT_VALID_PTR(m))
763 {
764 Assert(!m->uRegistryNeedsSaving);
765 if (m->uRegistryNeedsSaving)
766 i_saveSettings();
767 }
768
769 /* Enclose the state transition Ready->InUninit->NotReady */
770 AutoUninitSpan autoUninitSpan(this);
771 if (autoUninitSpan.uninitDone())
772 return;
773
774 LogFlow(("===========================================================\n"));
775 LogFlowThisFuncEnter();
776 LogFlowThisFunc(("initFailed()=%d\n", autoUninitSpan.initFailed()));
777
778 /* tell all our child objects we've been uninitialized */
779
780 LogFlowThisFunc(("Uninitializing machines (%d)...\n", m->allMachines.size()));
781 if (m->pHost)
782 {
783 /* It is necessary to hold the VirtualBox and Host locks here because
784 we may have to uninitialize SessionMachines. */
785 AutoMultiWriteLock2 multilock(this, m->pHost COMMA_LOCKVAL_SRC_POS);
786 m->allMachines.uninitAll();
787 }
788 else
789 m->allMachines.uninitAll();
790 m->allFloppyImages.uninitAll();
791 m->allDVDImages.uninitAll();
792 m->allHardDisks.uninitAll();
793 m->allDHCPServers.uninitAll();
794
795 m->mapProgressOperations.clear();
796
797 m->allGuestOSTypes.uninitAll();
798
799 /* Note that we release singleton children after we've all other children.
800 * In some cases this is important because these other children may use
801 * some resources of the singletons which would prevent them from
802 * uninitializing (as for example, mSystemProperties which owns
803 * MediumFormat objects which Medium objects refer to) */
804 if (m->pSystemProperties)
805 {
806 m->pSystemProperties->uninit();
807 unconst(m->pSystemProperties).setNull();
808 }
809
810 if (m->pHost)
811 {
812 m->pHost->uninit();
813 unconst(m->pHost).setNull();
814 }
815
816#ifdef VBOX_WITH_RESOURCE_USAGE_API
817 if (m->pPerformanceCollector)
818 {
819 m->pPerformanceCollector->uninit();
820 unconst(m->pPerformanceCollector).setNull();
821 }
822#endif /* VBOX_WITH_RESOURCE_USAGE_API */
823
824 LogFlowThisFunc(("Terminating the async event handler...\n"));
825 if (m->threadAsyncEvent != NIL_RTTHREAD)
826 {
827 /* signal to exit the event loop */
828 if (RT_SUCCESS(m->pAsyncEventQ->interruptEventQueueProcessing()))
829 {
830 /*
831 * Wait for thread termination (only after we've successfully
832 * interrupted the event queue processing!)
833 */
834 int vrc = RTThreadWait(m->threadAsyncEvent, 60000, NULL);
835 if (RT_FAILURE(vrc))
836 Log1WarningFunc(("RTThreadWait(%RTthrd) -> %Rrc\n", m->threadAsyncEvent, vrc));
837 }
838 else
839 {
840 AssertMsgFailed(("interruptEventQueueProcessing() failed\n"));
841 RTThreadWait(m->threadAsyncEvent, 0, NULL);
842 }
843
844 unconst(m->threadAsyncEvent) = NIL_RTTHREAD;
845 unconst(m->pAsyncEventQ) = NULL;
846 }
847
848 LogFlowThisFunc(("Releasing event source...\n"));
849 if (m->pEventSource)
850 {
851 // Must uninit the event source here, because it makes no sense that
852 // it survives longer than the base object. If someone gets an event
853 // with such an event source then that's life and it has to be dealt
854 // with appropriately on the API client side.
855 m->pEventSource->uninit();
856 unconst(m->pEventSource).setNull();
857 }
858
859 LogFlowThisFunc(("Terminating the client watcher...\n"));
860 if (m->pClientWatcher)
861 {
862 delete m->pClientWatcher;
863 unconst(m->pClientWatcher) = NULL;
864 }
865
866 delete m->pAutostartDb;
867
868 // clean up our instance data
869 delete m;
870 m = NULL;
871
872 /* Unload hard disk plugin backends. */
873 VDShutdown();
874
875 LogFlowThisFuncLeave();
876 LogFlow(("===========================================================\n"));
877}
878
879// Wrapped IVirtualBox properties
880/////////////////////////////////////////////////////////////////////////////
881HRESULT VirtualBox::getVersion(com::Utf8Str &aVersion)
882{
883 aVersion = sVersion;
884 return S_OK;
885}
886
887HRESULT VirtualBox::getVersionNormalized(com::Utf8Str &aVersionNormalized)
888{
889 aVersionNormalized = sVersionNormalized;
890 return S_OK;
891}
892
893HRESULT VirtualBox::getRevision(ULONG *aRevision)
894{
895 *aRevision = sRevision;
896 return S_OK;
897}
898
899HRESULT VirtualBox::getPackageType(com::Utf8Str &aPackageType)
900{
901 aPackageType = sPackageType;
902 return S_OK;
903}
904
905HRESULT VirtualBox::getAPIVersion(com::Utf8Str &aAPIVersion)
906{
907 aAPIVersion = sAPIVersion;
908 return S_OK;
909}
910
911HRESULT VirtualBox::getAPIRevision(LONG64 *aAPIRevision)
912{
913 AssertCompile(VBOX_VERSION_MAJOR < 128 && VBOX_VERSION_MAJOR > 0);
914 AssertCompile((uint64_t)VBOX_VERSION_MINOR < 256);
915 uint64_t uRevision = ((uint64_t)VBOX_VERSION_MAJOR << 56)
916 | ((uint64_t)VBOX_VERSION_MINOR << 48);
917
918 if (VBOX_VERSION_BUILD >= 51 && (VBOX_VERSION_BUILD & 1)) /* pre-release trunk */
919 uRevision |= (uint64_t)VBOX_VERSION_BUILD << 40;
920
921 /** @todo This needs to be the same in OSE and non-OSE, preferrably
922 * only changing when actual API changes happens. */
923 uRevision |= 0;
924
925 *aAPIRevision = uRevision;
926
927 return S_OK;
928}
929
930HRESULT VirtualBox::getHomeFolder(com::Utf8Str &aHomeFolder)
931{
932 /* mHomeDir is const and doesn't need a lock */
933 aHomeFolder = m->strHomeDir;
934 return S_OK;
935}
936
937HRESULT VirtualBox::getSettingsFilePath(com::Utf8Str &aSettingsFilePath)
938{
939 /* mCfgFile.mName is const and doesn't need a lock */
940 aSettingsFilePath = m->strSettingsFilePath;
941 return S_OK;
942}
943
944HRESULT VirtualBox::getHost(ComPtr<IHost> &aHost)
945{
946 /* mHost is const, no need to lock */
947 m->pHost.queryInterfaceTo(aHost.asOutParam());
948 return S_OK;
949}
950
951HRESULT VirtualBox::getSystemProperties(ComPtr<ISystemProperties> &aSystemProperties)
952{
953 /* mSystemProperties is const, no need to lock */
954 m->pSystemProperties.queryInterfaceTo(aSystemProperties.asOutParam());
955 return S_OK;
956}
957
958HRESULT VirtualBox::getMachines(std::vector<ComPtr<IMachine> > &aMachines)
959{
960 AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
961 aMachines.resize(m->allMachines.size());
962 size_t i = 0;
963 for (MachinesOList::const_iterator it= m->allMachines.begin();
964 it!= m->allMachines.end(); ++it, ++i)
965 (*it).queryInterfaceTo(aMachines[i].asOutParam());
966 return S_OK;
967}
968
969HRESULT VirtualBox::getMachineGroups(std::vector<com::Utf8Str> &aMachineGroups)
970{
971 std::list<com::Utf8Str> allGroups;
972
973 /* get copy of all machine references, to avoid holding the list lock */
974 MachinesOList::MyList allMachines;
975 {
976 AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
977 allMachines = m->allMachines.getList();
978 }
979 for (MachinesOList::MyList::const_iterator it = allMachines.begin();
980 it != allMachines.end();
981 ++it)
982 {
983 const ComObjPtr<Machine> &pMachine = *it;
984 AutoCaller autoMachineCaller(pMachine);
985 if (FAILED(autoMachineCaller.rc()))
986 continue;
987 AutoReadLock mlock(pMachine COMMA_LOCKVAL_SRC_POS);
988
989 if (pMachine->i_isAccessible())
990 {
991 const StringsList &thisGroups = pMachine->i_getGroups();
992 for (StringsList::const_iterator it2 = thisGroups.begin();
993 it2 != thisGroups.end(); ++it2)
994 allGroups.push_back(*it2);
995 }
996 }
997
998 /* throw out any duplicates */
999 allGroups.sort();
1000 allGroups.unique();
1001 aMachineGroups.resize(allGroups.size());
1002 size_t i = 0;
1003 for (std::list<com::Utf8Str>::const_iterator it = allGroups.begin();
1004 it != allGroups.end(); ++it, ++i)
1005 aMachineGroups[i] = (*it);
1006 return S_OK;
1007}
1008
1009HRESULT VirtualBox::getHardDisks(std::vector<ComPtr<IMedium> > &aHardDisks)
1010{
1011 AutoReadLock al(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1012 aHardDisks.resize(m->allHardDisks.size());
1013 size_t i = 0;
1014 for (MediaOList::const_iterator it = m->allHardDisks.begin();
1015 it != m->allHardDisks.end(); ++it, ++i)
1016 (*it).queryInterfaceTo(aHardDisks[i].asOutParam());
1017 return S_OK;
1018}
1019
1020HRESULT VirtualBox::getDVDImages(std::vector<ComPtr<IMedium> > &aDVDImages)
1021{
1022 AutoReadLock al(m->allDVDImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1023 aDVDImages.resize(m->allDVDImages.size());
1024 size_t i = 0;
1025 for (MediaOList::const_iterator it = m->allDVDImages.begin();
1026 it!= m->allDVDImages.end(); ++it, ++i)
1027 (*it).queryInterfaceTo(aDVDImages[i].asOutParam());
1028 return S_OK;
1029}
1030
1031HRESULT VirtualBox::getFloppyImages(std::vector<ComPtr<IMedium> > &aFloppyImages)
1032{
1033 AutoReadLock al(m->allFloppyImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1034 aFloppyImages.resize(m->allFloppyImages.size());
1035 size_t i = 0;
1036 for (MediaOList::const_iterator it = m->allFloppyImages.begin();
1037 it != m->allFloppyImages.end(); ++it, ++i)
1038 (*it).queryInterfaceTo(aFloppyImages[i].asOutParam());
1039 return S_OK;
1040}
1041
1042HRESULT VirtualBox::getProgressOperations(std::vector<ComPtr<IProgress> > &aProgressOperations)
1043{
1044 /* protect mProgressOperations */
1045 AutoReadLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
1046 ProgressMap pmap(m->mapProgressOperations);
1047 aProgressOperations.resize(pmap.size());
1048 size_t i = 0;
1049 for (ProgressMap::iterator it = pmap.begin(); it != pmap.end(); ++it, ++i)
1050 it->second.queryInterfaceTo(aProgressOperations[i].asOutParam());
1051 return S_OK;
1052}
1053
1054HRESULT VirtualBox::getGuestOSTypes(std::vector<ComPtr<IGuestOSType> > &aGuestOSTypes)
1055{
1056 AutoReadLock al(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1057 aGuestOSTypes.resize(m->allGuestOSTypes.size());
1058 size_t i = 0;
1059 for (GuestOSTypesOList::const_iterator it = m->allGuestOSTypes.begin();
1060 it != m->allGuestOSTypes.end(); ++it, ++i)
1061 (*it).queryInterfaceTo(aGuestOSTypes[i].asOutParam());
1062 return S_OK;
1063}
1064
1065HRESULT VirtualBox::getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders)
1066{
1067 NOREF(aSharedFolders);
1068
1069 return setError(E_NOTIMPL, "Not yet implemented");
1070}
1071
1072HRESULT VirtualBox::getPerformanceCollector(ComPtr<IPerformanceCollector> &aPerformanceCollector)
1073{
1074#ifdef VBOX_WITH_RESOURCE_USAGE_API
1075 /* mPerformanceCollector is const, no need to lock */
1076 m->pPerformanceCollector.queryInterfaceTo(aPerformanceCollector.asOutParam());
1077
1078 return S_OK;
1079#else /* !VBOX_WITH_RESOURCE_USAGE_API */
1080 NOREF(aPerformanceCollector);
1081 ReturnComNotImplemented();
1082#endif /* !VBOX_WITH_RESOURCE_USAGE_API */
1083}
1084
1085HRESULT VirtualBox::getDHCPServers(std::vector<ComPtr<IDHCPServer> > &aDHCPServers)
1086{
1087 AutoReadLock al(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1088 aDHCPServers.resize(m->allDHCPServers.size());
1089 size_t i = 0;
1090 for (DHCPServersOList::const_iterator it= m->allDHCPServers.begin();
1091 it!= m->allDHCPServers.end(); ++it, ++i)
1092 (*it).queryInterfaceTo(aDHCPServers[i].asOutParam());
1093 return S_OK;
1094}
1095
1096
1097HRESULT VirtualBox::getNATNetworks(std::vector<ComPtr<INATNetwork> > &aNATNetworks)
1098{
1099#ifdef VBOX_WITH_NAT_SERVICE
1100 AutoReadLock al(m->allNATNetworks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1101 aNATNetworks.resize(m->allNATNetworks.size());
1102 size_t i = 0;
1103 for (NATNetworksOList::const_iterator it= m->allNATNetworks.begin();
1104 it!= m->allNATNetworks.end(); ++it, ++i)
1105 (*it).queryInterfaceTo(aNATNetworks[i].asOutParam());
1106 return S_OK;
1107#else
1108 NOREF(aNATNetworks);
1109 return E_NOTIMPL;
1110#endif
1111}
1112
1113HRESULT VirtualBox::getEventSource(ComPtr<IEventSource> &aEventSource)
1114{
1115 /* event source is const, no need to lock */
1116 m->pEventSource.queryInterfaceTo(aEventSource.asOutParam());
1117 return S_OK;
1118}
1119
1120HRESULT VirtualBox::getExtensionPackManager(ComPtr<IExtPackManager> &aExtensionPackManager)
1121{
1122 HRESULT hrc = S_OK;
1123#ifdef VBOX_WITH_EXTPACK
1124 /* The extension pack manager is const, no need to lock. */
1125 hrc = m->ptrExtPackManager.queryInterfaceTo(aExtensionPackManager.asOutParam());
1126#else
1127 hrc = E_NOTIMPL;
1128 NOREF(aExtensionPackManager);
1129#endif
1130 return hrc;
1131}
1132
1133HRESULT VirtualBox::getInternalNetworks(std::vector<com::Utf8Str> &aInternalNetworks)
1134{
1135 std::list<com::Utf8Str> allInternalNetworks;
1136
1137 /* get copy of all machine references, to avoid holding the list lock */
1138 MachinesOList::MyList allMachines;
1139 {
1140 AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1141 allMachines = m->allMachines.getList();
1142 }
1143 for (MachinesOList::MyList::const_iterator it = allMachines.begin();
1144 it != allMachines.end(); ++it)
1145 {
1146 const ComObjPtr<Machine> &pMachine = *it;
1147 AutoCaller autoMachineCaller(pMachine);
1148 if (FAILED(autoMachineCaller.rc()))
1149 continue;
1150 AutoReadLock mlock(pMachine COMMA_LOCKVAL_SRC_POS);
1151
1152 if (pMachine->i_isAccessible())
1153 {
1154 uint32_t cNetworkAdapters = Global::getMaxNetworkAdapters(pMachine->i_getChipsetType());
1155 for (ULONG i = 0; i < cNetworkAdapters; i++)
1156 {
1157 ComPtr<INetworkAdapter> pNet;
1158 HRESULT rc = pMachine->GetNetworkAdapter(i, pNet.asOutParam());
1159 if (FAILED(rc) || pNet.isNull())
1160 continue;
1161 Bstr strInternalNetwork;
1162 rc = pNet->COMGETTER(InternalNetwork)(strInternalNetwork.asOutParam());
1163 if (FAILED(rc) || strInternalNetwork.isEmpty())
1164 continue;
1165
1166 allInternalNetworks.push_back(Utf8Str(strInternalNetwork));
1167 }
1168 }
1169 }
1170
1171 /* throw out any duplicates */
1172 allInternalNetworks.sort();
1173 allInternalNetworks.unique();
1174 size_t i = 0;
1175 aInternalNetworks.resize(allInternalNetworks.size());
1176 for (std::list<com::Utf8Str>::const_iterator it = allInternalNetworks.begin();
1177 it != allInternalNetworks.end();
1178 ++it, ++i)
1179 aInternalNetworks[i] = *it;
1180 return S_OK;
1181}
1182
1183HRESULT VirtualBox::getGenericNetworkDrivers(std::vector<com::Utf8Str> &aGenericNetworkDrivers)
1184{
1185 std::list<com::Utf8Str> allGenericNetworkDrivers;
1186
1187 /* get copy of all machine references, to avoid holding the list lock */
1188 MachinesOList::MyList allMachines;
1189 {
1190 AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1191 allMachines = m->allMachines.getList();
1192 }
1193 for (MachinesOList::MyList::const_iterator it = allMachines.begin();
1194 it != allMachines.end();
1195 ++it)
1196 {
1197 const ComObjPtr<Machine> &pMachine = *it;
1198 AutoCaller autoMachineCaller(pMachine);
1199 if (FAILED(autoMachineCaller.rc()))
1200 continue;
1201 AutoReadLock mlock(pMachine COMMA_LOCKVAL_SRC_POS);
1202
1203 if (pMachine->i_isAccessible())
1204 {
1205 uint32_t cNetworkAdapters = Global::getMaxNetworkAdapters(pMachine->i_getChipsetType());
1206 for (ULONG i = 0; i < cNetworkAdapters; i++)
1207 {
1208 ComPtr<INetworkAdapter> pNet;
1209 HRESULT rc = pMachine->GetNetworkAdapter(i, pNet.asOutParam());
1210 if (FAILED(rc) || pNet.isNull())
1211 continue;
1212 Bstr strGenericNetworkDriver;
1213 rc = pNet->COMGETTER(GenericDriver)(strGenericNetworkDriver.asOutParam());
1214 if (FAILED(rc) || strGenericNetworkDriver.isEmpty())
1215 continue;
1216
1217 allGenericNetworkDrivers.push_back(Utf8Str(strGenericNetworkDriver).c_str());
1218 }
1219 }
1220 }
1221
1222 /* throw out any duplicates */
1223 allGenericNetworkDrivers.sort();
1224 allGenericNetworkDrivers.unique();
1225 aGenericNetworkDrivers.resize(allGenericNetworkDrivers.size());
1226 size_t i = 0;
1227 for (std::list<com::Utf8Str>::const_iterator it = allGenericNetworkDrivers.begin();
1228 it != allGenericNetworkDrivers.end(); ++it, ++i)
1229 aGenericNetworkDrivers[i] = *it;
1230
1231 return S_OK;
1232}
1233
1234HRESULT VirtualBox::checkFirmwarePresent(FirmwareType_T aFirmwareType,
1235 const com::Utf8Str &aVersion,
1236 com::Utf8Str &aUrl,
1237 com::Utf8Str &aFile,
1238 BOOL *aResult)
1239{
1240 NOREF(aVersion);
1241
1242 static const struct
1243 {
1244 FirmwareType_T type;
1245 const char* fileName;
1246 const char* url;
1247 }
1248 firmwareDesc[] =
1249 {
1250 {
1251 /* compiled-in firmware */
1252 FirmwareType_BIOS, NULL, NULL
1253 },
1254 {
1255 FirmwareType_EFI32, "VBoxEFI32.fd", "http://virtualbox.org/firmware/VBoxEFI32.fd"
1256 },
1257 {
1258 FirmwareType_EFI64, "VBoxEFI64.fd", "http://virtualbox.org/firmware/VBoxEFI64.fd"
1259 },
1260 {
1261 FirmwareType_EFIDUAL, "VBoxEFIDual.fd", "http://virtualbox.org/firmware/VBoxEFIDual.fd"
1262 }
1263 };
1264
1265 for (size_t i = 0; i < sizeof(firmwareDesc) / sizeof(firmwareDesc[0]); i++)
1266 {
1267 if (aFirmwareType != firmwareDesc[i].type)
1268 continue;
1269
1270 /* compiled-in firmware */
1271 if (firmwareDesc[i].fileName == NULL)
1272 {
1273 *aResult = TRUE;
1274 break;
1275 }
1276
1277 Utf8Str shortName, fullName;
1278
1279 shortName = Utf8StrFmt("Firmware%c%s",
1280 RTPATH_DELIMITER,
1281 firmwareDesc[i].fileName);
1282 int rc = i_calculateFullPath(shortName, fullName);
1283 AssertRCReturn(rc, VBOX_E_IPRT_ERROR);
1284 if (RTFileExists(fullName.c_str()))
1285 {
1286 *aResult = TRUE;
1287 aFile = fullName;
1288 break;
1289 }
1290
1291 char pszVBoxPath[RTPATH_MAX];
1292 rc = RTPathExecDir(pszVBoxPath, RTPATH_MAX);
1293 AssertRCReturn(rc, VBOX_E_IPRT_ERROR);
1294 fullName = Utf8StrFmt("%s%c%s",
1295 pszVBoxPath,
1296 RTPATH_DELIMITER,
1297 firmwareDesc[i].fileName);
1298 if (RTFileExists(fullName.c_str()))
1299 {
1300 *aResult = TRUE;
1301 aFile = fullName;
1302 break;
1303 }
1304
1305 /** @todo account for version in the URL */
1306 aUrl = firmwareDesc[i].url;
1307 *aResult = FALSE;
1308
1309 /* Assume single record per firmware type */
1310 break;
1311 }
1312
1313 return S_OK;
1314}
1315// Wrapped IVirtualBox methods
1316/////////////////////////////////////////////////////////////////////////////
1317
1318/* Helper for VirtualBox::ComposeMachineFilename */
1319static void sanitiseMachineFilename(Utf8Str &aName);
1320
1321HRESULT VirtualBox::composeMachineFilename(const com::Utf8Str &aName,
1322 const com::Utf8Str &aGroup,
1323 const com::Utf8Str &aCreateFlags,
1324 const com::Utf8Str &aBaseFolder,
1325 com::Utf8Str &aFile)
1326{
1327 if (RT_UNLIKELY(aName.isEmpty()))
1328 return setError(E_INVALIDARG, tr("Machine name is invalid, must not be empty"));
1329
1330 Utf8Str strBase = aBaseFolder;
1331 Utf8Str strName = aName;
1332
1333 LogFlowThisFunc(("aName=\"%s\",aBaseFolder=\"%s\"\n", strName.c_str(), strBase.c_str()));
1334
1335 Guid id;
1336 bool fDirectoryIncludesUUID = false;
1337 if (!aCreateFlags.isEmpty())
1338 {
1339 size_t uPos = 0;
1340 do {
1341
1342 com::Utf8Str strKey, strValue;
1343 uPos = aCreateFlags.parseKeyValue(strKey, strValue, uPos);
1344
1345 if (strKey == "UUID")
1346 id = strValue.c_str();
1347 else if (strKey == "directoryIncludesUUID")
1348 fDirectoryIncludesUUID = (strValue == "1");
1349
1350 } while (uPos != com::Utf8Str::npos);
1351 }
1352
1353 if (id.isZero())
1354 fDirectoryIncludesUUID = false;
1355 else if (!id.isValid())
1356 {
1357 /* do something else */
1358 return setError(E_INVALIDARG,
1359 tr("'%s' is not a valid Guid"),
1360 id.toStringCurly().c_str());
1361 }
1362
1363 Utf8Str strGroup(aGroup);
1364 if (strGroup.isEmpty())
1365 strGroup = "/";
1366 HRESULT rc = i_validateMachineGroup(strGroup, true);
1367 if (FAILED(rc))
1368 return rc;
1369
1370 /* Compose the settings file name using the following scheme:
1371 *
1372 * <base_folder><group>/<machine_name>/<machine_name>.xml
1373 *
1374 * If a non-null and non-empty base folder is specified, the default
1375 * machine folder will be used as a base folder.
1376 * We sanitise the machine name to a safe white list of characters before
1377 * using it.
1378 */
1379 Utf8Str strDirName(strName);
1380 if (fDirectoryIncludesUUID)
1381 strDirName += Utf8StrFmt(" (%RTuuid)", id.raw());
1382 sanitiseMachineFilename(strName);
1383 sanitiseMachineFilename(strDirName);
1384
1385 if (strBase.isEmpty())
1386 /* we use the non-full folder value below to keep the path relative */
1387 i_getDefaultMachineFolder(strBase);
1388
1389 i_calculateFullPath(strBase, strBase);
1390
1391 /* eliminate toplevel group to avoid // in the result */
1392 if (strGroup == "/")
1393 strGroup.setNull();
1394 aFile = com::Utf8StrFmt("%s%s%c%s%c%s.vbox",
1395 strBase.c_str(),
1396 strGroup.c_str(),
1397 RTPATH_DELIMITER,
1398 strDirName.c_str(),
1399 RTPATH_DELIMITER,
1400 strName.c_str());
1401 return S_OK;
1402}
1403
1404/**
1405 * Remove characters from a machine file name which can be problematic on
1406 * particular systems.
1407 * @param strName The file name to sanitise.
1408 */
1409void sanitiseMachineFilename(Utf8Str &strName)
1410{
1411 if (strName.isEmpty())
1412 return;
1413
1414 /* Set of characters which should be safe for use in filenames: some basic
1415 * ASCII, Unicode from Latin-1 alphabetic to the end of Hangul. We try to
1416 * skip anything that could count as a control character in Windows or
1417 * *nix, or be otherwise difficult for shells to handle (I would have
1418 * preferred to remove the space and brackets too). We also remove all
1419 * characters which need UTF-16 surrogate pairs for Windows's benefit.
1420 */
1421 static RTUNICP const s_uszValidRangePairs[] =
1422 {
1423 ' ', ' ',
1424 '(', ')',
1425 '-', '.',
1426 '0', '9',
1427 'A', 'Z',
1428 'a', 'z',
1429 '_', '_',
1430 0xa0, 0xd7af,
1431 '\0'
1432 };
1433
1434 char *pszName = strName.mutableRaw();
1435 ssize_t cReplacements = RTStrPurgeComplementSet(pszName, s_uszValidRangePairs, '_');
1436 Assert(cReplacements >= 0);
1437 NOREF(cReplacements);
1438
1439 /* No leading dot or dash. */
1440 if (pszName[0] == '.' || pszName[0] == '-')
1441 pszName[0] = '_';
1442
1443 /* No trailing dot. */
1444 if (pszName[strName.length() - 1] == '.')
1445 pszName[strName.length() - 1] = '_';
1446
1447 /* Mangle leading and trailing spaces. */
1448 for (size_t i = 0; pszName[i] == ' '; ++i)
1449 pszName[i] = '_';
1450 for (size_t i = strName.length() - 1; i && pszName[i] == ' '; --i)
1451 pszName[i] = '_';
1452}
1453
1454#ifdef DEBUG
1455/** Simple unit test/operation examples for sanitiseMachineFilename(). */
1456static unsigned testSanitiseMachineFilename(DECLCALLBACKMEMBER(void, pfnPrintf)(const char *, ...))
1457{
1458 unsigned cErrors = 0;
1459
1460 /** Expected results of sanitising given file names. */
1461 static struct
1462 {
1463 /** The test file name to be sanitised (Utf-8). */
1464 const char *pcszIn;
1465 /** The expected sanitised output (Utf-8). */
1466 const char *pcszOutExpected;
1467 } aTest[] =
1468 {
1469 { "OS/2 2.1", "OS_2 2.1" },
1470 { "-!My VM!-", "__My VM_-" },
1471 { "\xF0\x90\x8C\xB0", "____" },
1472 { " My VM ", "__My VM__" },
1473 { ".My VM.", "_My VM_" },
1474 { "My VM", "My VM" }
1475 };
1476 for (unsigned i = 0; i < RT_ELEMENTS(aTest); ++i)
1477 {
1478 Utf8Str str(aTest[i].pcszIn);
1479 sanitiseMachineFilename(str);
1480 if (str.compare(aTest[i].pcszOutExpected))
1481 {
1482 ++cErrors;
1483 pfnPrintf("%s: line %d, expected %s, actual %s\n",
1484 __PRETTY_FUNCTION__, i, aTest[i].pcszOutExpected,
1485 str.c_str());
1486 }
1487 }
1488 return cErrors;
1489}
1490
1491/** @todo Proper testcase. */
1492/** @todo Do we have a better method of doing init functions? */
1493namespace
1494{
1495 class TestSanitiseMachineFilename
1496 {
1497 public:
1498 TestSanitiseMachineFilename(void)
1499 {
1500 Assert(!testSanitiseMachineFilename(RTAssertMsg2));
1501 }
1502 };
1503 TestSanitiseMachineFilename s_TestSanitiseMachineFilename;
1504}
1505#endif
1506
1507/** @note Locks mSystemProperties object for reading. */
1508HRESULT VirtualBox::createMachine(const com::Utf8Str &aSettingsFile,
1509 const com::Utf8Str &aName,
1510 const std::vector<com::Utf8Str> &aGroups,
1511 const com::Utf8Str &aOsTypeId,
1512 const com::Utf8Str &aFlags,
1513 ComPtr<IMachine> &aMachine)
1514{
1515 LogFlowThisFuncEnter();
1516 LogFlowThisFunc(("aSettingsFile=\"%s\", aName=\"%s\", aOsTypeId =\"%s\", aCreateFlags=\"%s\"\n",
1517 aSettingsFile.c_str(), aName.c_str(), aOsTypeId.c_str(), aFlags.c_str()));
1518 /** @todo tighten checks on aId? */
1519
1520 StringsList llGroups;
1521 HRESULT rc = i_convertMachineGroups(aGroups, &llGroups);
1522 if (FAILED(rc))
1523 return rc;
1524
1525 Utf8Str strCreateFlags(aFlags);
1526 Guid id;
1527 bool fForceOverwrite = false;
1528 bool fDirectoryIncludesUUID = false;
1529 if (!strCreateFlags.isEmpty())
1530 {
1531 const char *pcszNext = strCreateFlags.c_str();
1532 while (*pcszNext != '\0')
1533 {
1534 Utf8Str strFlag;
1535 const char *pcszComma = RTStrStr(pcszNext, ",");
1536 if (!pcszComma)
1537 strFlag = pcszNext;
1538 else
1539 strFlag = Utf8Str(pcszNext, pcszComma - pcszNext);
1540
1541 const char *pcszEqual = RTStrStr(strFlag.c_str(), "=");
1542 /* skip over everything which doesn't contain '=' */
1543 if (pcszEqual && pcszEqual != strFlag.c_str())
1544 {
1545 Utf8Str strKey(strFlag.c_str(), pcszEqual - strFlag.c_str());
1546 Utf8Str strValue(strFlag.c_str() + (pcszEqual - strFlag.c_str() + 1));
1547
1548 if (strKey == "UUID")
1549 id = strValue.c_str();
1550 else if (strKey == "forceOverwrite")
1551 fForceOverwrite = (strValue == "1");
1552 else if (strKey == "directoryIncludesUUID")
1553 fDirectoryIncludesUUID = (strValue == "1");
1554 }
1555
1556 if (!pcszComma)
1557 pcszNext += strFlag.length();
1558 else
1559 pcszNext += strFlag.length() + 1;
1560 }
1561 }
1562 /* Create UUID if none was specified. */
1563 if (id.isZero())
1564 id.create();
1565 else if (!id.isValid())
1566 {
1567 /* do something else */
1568 return setError(E_INVALIDARG,
1569 tr("'%s' is not a valid Guid"),
1570 id.toStringCurly().c_str());
1571 }
1572
1573 /* NULL settings file means compose automatically */
1574 Utf8Str strSettingsFile(aSettingsFile);
1575 if (strSettingsFile.isEmpty())
1576 {
1577 Utf8Str strNewCreateFlags(Utf8StrFmt("UUID=%RTuuid", id.raw()));
1578 if (fDirectoryIncludesUUID)
1579 strNewCreateFlags += ",directoryIncludesUUID=1";
1580
1581 com::Utf8Str blstr = "";
1582 rc = composeMachineFilename(aName,
1583 llGroups.front(),
1584 strNewCreateFlags,
1585 blstr /* aBaseFolder */,
1586 strSettingsFile);
1587 if (FAILED(rc)) return rc;
1588 }
1589
1590 /* create a new object */
1591 ComObjPtr<Machine> machine;
1592 rc = machine.createObject();
1593 if (FAILED(rc)) return rc;
1594
1595 ComObjPtr<GuestOSType> osType;
1596 if (!aOsTypeId.isEmpty())
1597 {
1598 rc = i_findGuestOSType(aOsTypeId, osType);
1599 if (FAILED(rc)) return rc;
1600 }
1601
1602 /* initialize the machine object */
1603 rc = machine->init(this,
1604 strSettingsFile,
1605 Utf8Str(aName),
1606 llGroups,
1607 osType,
1608 id,
1609 fForceOverwrite,
1610 fDirectoryIncludesUUID);
1611 if (SUCCEEDED(rc))
1612 {
1613 /* set the return value */
1614 machine.queryInterfaceTo(aMachine.asOutParam());
1615 AssertComRC(rc);
1616
1617#ifdef VBOX_WITH_EXTPACK
1618 /* call the extension pack hooks */
1619 m->ptrExtPackManager->i_callAllVmCreatedHooks(machine);
1620#endif
1621 }
1622
1623 LogFlowThisFuncLeave();
1624
1625 return rc;
1626}
1627
1628HRESULT VirtualBox::openMachine(const com::Utf8Str &aSettingsFile,
1629 ComPtr<IMachine> &aMachine)
1630{
1631 HRESULT rc = E_FAIL;
1632
1633 /* create a new object */
1634 ComObjPtr<Machine> machine;
1635 rc = machine.createObject();
1636 if (SUCCEEDED(rc))
1637 {
1638 /* initialize the machine object */
1639 rc = machine->initFromSettings(this,
1640 aSettingsFile,
1641 NULL); /* const Guid *aId */
1642 if (SUCCEEDED(rc))
1643 {
1644 /* set the return value */
1645 machine.queryInterfaceTo(aMachine.asOutParam());
1646 ComAssertComRC(rc);
1647 }
1648 }
1649
1650 return rc;
1651}
1652
1653/** @note Locks objects! */
1654HRESULT VirtualBox::registerMachine(const ComPtr<IMachine> &aMachine)
1655{
1656 HRESULT rc;
1657
1658 Bstr name;
1659 rc = aMachine->COMGETTER(Name)(name.asOutParam());
1660 if (FAILED(rc)) return rc;
1661
1662 /* We can safely cast child to Machine * here because only Machine
1663 * implementations of IMachine can be among our children. */
1664 IMachine *aM = aMachine;
1665 Machine *pMachine = static_cast<Machine*>(aM);
1666
1667 AutoCaller machCaller(pMachine);
1668 ComAssertComRCRetRC(machCaller.rc());
1669
1670 rc = i_registerMachine(pMachine);
1671 /* fire an event */
1672 if (SUCCEEDED(rc))
1673 i_onMachineRegistered(pMachine->i_getId(), TRUE);
1674
1675 return rc;
1676}
1677
1678/** @note Locks this object for reading, then some machine objects for reading. */
1679HRESULT VirtualBox::findMachine(const com::Utf8Str &aSettingsFile,
1680 ComPtr<IMachine> &aMachine)
1681{
1682 LogFlowThisFuncEnter();
1683 LogFlowThisFunc(("aSettingsFile=\"%s\", aMachine={%p}\n", aSettingsFile.c_str(), &aMachine));
1684
1685 /* start with not found */
1686 HRESULT rc = S_OK;
1687 ComObjPtr<Machine> pMachineFound;
1688
1689 Guid id(aSettingsFile);
1690 Utf8Str strFile(aSettingsFile);
1691 if (id.isValid() && !id.isZero())
1692
1693 rc = i_findMachine(id,
1694 true /* fPermitInaccessible */,
1695 true /* setError */,
1696 &pMachineFound);
1697 // returns VBOX_E_OBJECT_NOT_FOUND if not found and sets error
1698 else
1699 {
1700 rc = i_findMachineByName(strFile,
1701 true /* setError */,
1702 &pMachineFound);
1703 // returns VBOX_E_OBJECT_NOT_FOUND if not found and sets error
1704 }
1705
1706 /* this will set (*machine) to NULL if machineObj is null */
1707 pMachineFound.queryInterfaceTo(aMachine.asOutParam());
1708
1709 LogFlowThisFunc(("aName=\"%s\", aMachine=%p, rc=%08X\n", aSettingsFile.c_str(), &aMachine, rc));
1710 LogFlowThisFuncLeave();
1711
1712 return rc;
1713}
1714
1715HRESULT VirtualBox::getMachinesByGroups(const std::vector<com::Utf8Str> &aGroups,
1716 std::vector<ComPtr<IMachine> > &aMachines)
1717{
1718 StringsList llGroups;
1719 HRESULT rc = i_convertMachineGroups(aGroups, &llGroups);
1720 if (FAILED(rc))
1721 return rc;
1722
1723 /* we want to rely on sorted groups during compare, to save time */
1724 llGroups.sort();
1725
1726 /* get copy of all machine references, to avoid holding the list lock */
1727 MachinesOList::MyList allMachines;
1728 AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
1729 allMachines = m->allMachines.getList();
1730
1731 std::vector<ComObjPtr<IMachine> > saMachines;
1732 saMachines.resize(0);
1733 for (MachinesOList::MyList::const_iterator it = allMachines.begin();
1734 it != allMachines.end();
1735 ++it)
1736 {
1737 const ComObjPtr<Machine> &pMachine = *it;
1738 AutoCaller autoMachineCaller(pMachine);
1739 if (FAILED(autoMachineCaller.rc()))
1740 continue;
1741 AutoReadLock mlock(pMachine COMMA_LOCKVAL_SRC_POS);
1742
1743 if (pMachine->i_isAccessible())
1744 {
1745 const StringsList &thisGroups = pMachine->i_getGroups();
1746 for (StringsList::const_iterator it2 = thisGroups.begin();
1747 it2 != thisGroups.end();
1748 ++it2)
1749 {
1750 const Utf8Str &group = *it2;
1751 bool fAppended = false;
1752 for (StringsList::const_iterator it3 = llGroups.begin();
1753 it3 != llGroups.end();
1754 ++it3)
1755 {
1756 int order = it3->compare(group);
1757 if (order == 0)
1758 {
1759 saMachines.push_back(static_cast<IMachine *>(pMachine));
1760 fAppended = true;
1761 break;
1762 }
1763 else if (order > 0)
1764 break;
1765 else
1766 continue;
1767 }
1768 /* avoid duplicates and save time */
1769 if (fAppended)
1770 break;
1771 }
1772 }
1773 }
1774 aMachines.resize(saMachines.size());
1775 size_t i = 0;
1776 for(i = 0; i < saMachines.size(); ++i)
1777 saMachines[i].queryInterfaceTo(aMachines[i].asOutParam());
1778
1779 return S_OK;
1780}
1781
1782HRESULT VirtualBox::getMachineStates(const std::vector<ComPtr<IMachine> > &aMachines,
1783 std::vector<MachineState_T> &aStates)
1784{
1785 com::SafeIfaceArray<IMachine> saMachines(aMachines);
1786 aStates.resize(aMachines.size());
1787 for (size_t i = 0; i < saMachines.size(); i++)
1788 {
1789 ComPtr<IMachine> pMachine = saMachines[i];
1790 MachineState_T state = MachineState_Null;
1791 if (!pMachine.isNull())
1792 {
1793 HRESULT rc = pMachine->COMGETTER(State)(&state);
1794 if (rc == E_ACCESSDENIED)
1795 rc = S_OK;
1796 AssertComRC(rc);
1797 }
1798 aStates[i] = state;
1799 }
1800 return S_OK;
1801}
1802
1803HRESULT VirtualBox::createMedium(const com::Utf8Str &aFormat,
1804 const com::Utf8Str &aLocation,
1805 AccessMode_T aAccessMode,
1806 DeviceType_T aDeviceType,
1807 ComPtr<IMedium> &aMedium)
1808{
1809 NOREF(aAccessMode); /**< @todo r=klaus make use of access mode */
1810
1811 HRESULT rc = S_OK;
1812
1813 ComObjPtr<Medium> medium;
1814 medium.createObject();
1815 com::Utf8Str format = aFormat;
1816
1817 switch (aDeviceType)
1818 {
1819 case DeviceType_HardDisk:
1820 {
1821
1822 /* we don't access non-const data members so no need to lock */
1823 if (format.isEmpty())
1824 i_getDefaultHardDiskFormat(format);
1825
1826 rc = medium->init(this,
1827 format,
1828 aLocation,
1829 Guid::Empty /* media registry: none yet */,
1830 aDeviceType);
1831 }
1832 break;
1833
1834 case DeviceType_DVD:
1835 case DeviceType_Floppy:
1836 {
1837
1838 if (format.isEmpty())
1839 return setError(E_INVALIDARG, "Format must be Valid Type%s", format.c_str());
1840
1841 // enforce read-only for DVDs even if caller specified ReadWrite
1842 if (aDeviceType == DeviceType_DVD)
1843 aAccessMode = AccessMode_ReadOnly;
1844
1845 rc = medium->init(this,
1846 format,
1847 aLocation,
1848 Guid::Empty /* media registry: none yet */,
1849 aDeviceType);
1850
1851 }
1852 break;
1853
1854 default:
1855 return setError(E_INVALIDARG, "Device type must be HardDisk, DVD or Floppy %d", aDeviceType);
1856 }
1857
1858 if (SUCCEEDED(rc))
1859 medium.queryInterfaceTo(aMedium.asOutParam());
1860
1861 return rc;
1862}
1863
1864HRESULT VirtualBox::openMedium(const com::Utf8Str &aLocation,
1865 DeviceType_T aDeviceType,
1866 AccessMode_T aAccessMode,
1867 BOOL aForceNewUuid,
1868 ComPtr<IMedium> &aMedium)
1869{
1870 HRESULT rc = S_OK;
1871 Guid id(aLocation);
1872 ComObjPtr<Medium> pMedium;
1873
1874 // have to get write lock as the whole find/update sequence must be done
1875 // in one critical section, otherwise there are races which can lead to
1876 // multiple Medium objects with the same content
1877 AutoWriteLock treeLock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
1878
1879 // check if the device type is correct, and see if a medium for the
1880 // given path has already initialized; if so, return that
1881 switch (aDeviceType)
1882 {
1883 case DeviceType_HardDisk:
1884 if (id.isValid() && !id.isZero())
1885 rc = i_findHardDiskById(id, false /* setError */, &pMedium);
1886 else
1887 rc = i_findHardDiskByLocation(aLocation,
1888 false, /* aSetError */
1889 &pMedium);
1890 break;
1891
1892 case DeviceType_Floppy:
1893 case DeviceType_DVD:
1894 if (id.isValid() && !id.isZero())
1895 rc = i_findDVDOrFloppyImage(aDeviceType, &id, Utf8Str::Empty,
1896 false /* setError */, &pMedium);
1897 else
1898 rc = i_findDVDOrFloppyImage(aDeviceType, NULL, aLocation,
1899 false /* setError */, &pMedium);
1900
1901 // enforce read-only for DVDs even if caller specified ReadWrite
1902 if (aDeviceType == DeviceType_DVD)
1903 aAccessMode = AccessMode_ReadOnly;
1904 break;
1905
1906 default:
1907 return setError(E_INVALIDARG, "Device type must be HardDisk, DVD or Floppy %d", aDeviceType);
1908 }
1909
1910 if (pMedium.isNull())
1911 {
1912 pMedium.createObject();
1913 treeLock.release();
1914 rc = pMedium->init(this,
1915 aLocation,
1916 (aAccessMode == AccessMode_ReadWrite) ? Medium::OpenReadWrite : Medium::OpenReadOnly,
1917 !!aForceNewUuid,
1918 aDeviceType);
1919 treeLock.acquire();
1920
1921 if (SUCCEEDED(rc))
1922 {
1923 rc = i_registerMedium(pMedium, &pMedium, treeLock);
1924
1925 treeLock.release();
1926
1927 /* Note that it's important to call uninit() on failure to register
1928 * because the differencing hard disk would have been already associated
1929 * with the parent and this association needs to be broken. */
1930
1931 if (FAILED(rc))
1932 {
1933 pMedium->uninit();
1934 rc = VBOX_E_OBJECT_NOT_FOUND;
1935 }
1936 }
1937 else
1938 {
1939 if (rc != VBOX_E_INVALID_OBJECT_STATE)
1940 rc = VBOX_E_OBJECT_NOT_FOUND;
1941 }
1942 }
1943
1944 if (SUCCEEDED(rc))
1945 pMedium.queryInterfaceTo(aMedium.asOutParam());
1946
1947 return rc;
1948}
1949
1950
1951/** @note Locks this object for reading. */
1952HRESULT VirtualBox::getGuestOSType(const com::Utf8Str &aId,
1953 ComPtr<IGuestOSType> &aType)
1954{
1955 ComObjPtr<GuestOSType> pType;
1956 HRESULT rc = i_findGuestOSType(aId, pType);
1957 pType.queryInterfaceTo(aType.asOutParam());
1958 return rc;
1959}
1960
1961HRESULT VirtualBox::createSharedFolder(const com::Utf8Str &aName,
1962 const com::Utf8Str &aHostPath,
1963 BOOL aWritable,
1964 BOOL aAutomount)
1965{
1966 NOREF(aName);
1967 NOREF(aHostPath);
1968 NOREF(aWritable);
1969 NOREF(aAutomount);
1970
1971 return setError(E_NOTIMPL, "Not yet implemented");
1972}
1973
1974HRESULT VirtualBox::removeSharedFolder(const com::Utf8Str &aName)
1975{
1976 NOREF(aName);
1977 return setError(E_NOTIMPL, "Not yet implemented");
1978}
1979
1980/**
1981 * @note Locks this object for reading.
1982 */
1983HRESULT VirtualBox::getExtraDataKeys(std::vector<com::Utf8Str> &aKeys)
1984{
1985 using namespace settings;
1986
1987 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1988
1989 aKeys.resize(m->pMainConfigFile->mapExtraDataItems.size());
1990 size_t i = 0;
1991 for (StringsMap::const_iterator it = m->pMainConfigFile->mapExtraDataItems.begin();
1992 it != m->pMainConfigFile->mapExtraDataItems.end(); ++it, ++i)
1993 aKeys[i] = it->first;
1994
1995 return S_OK;
1996}
1997
1998/**
1999 * @note Locks this object for reading.
2000 */
2001HRESULT VirtualBox::getExtraData(const com::Utf8Str &aKey,
2002 com::Utf8Str &aValue)
2003{
2004 settings::StringsMap::const_iterator it = m->pMainConfigFile->mapExtraDataItems.find(aKey);
2005 if (it != m->pMainConfigFile->mapExtraDataItems.end())
2006 // found:
2007 aValue = it->second; // source is a Utf8Str
2008
2009 /* return the result to caller (may be empty) */
2010
2011 return S_OK;
2012}
2013
2014/**
2015 * @note Locks this object for writing.
2016 */
2017HRESULT VirtualBox::setExtraData(const com::Utf8Str &aKey,
2018 const com::Utf8Str &aValue)
2019{
2020
2021 Utf8Str strKey(aKey);
2022 Utf8Str strValue(aValue);
2023 Utf8Str strOldValue; // empty
2024 HRESULT rc = S_OK;
2025
2026 // locking note: we only hold the read lock briefly to look up the old value,
2027 // then release it and call the onExtraCanChange callbacks. There is a small
2028 // chance of a race insofar as the callback might be called twice if two callers
2029 // change the same key at the same time, but that's a much better solution
2030 // than the deadlock we had here before. The actual changing of the extradata
2031 // is then performed under the write lock and race-free.
2032
2033 // look up the old value first; if nothing has changed then we need not do anything
2034 {
2035 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS); // hold read lock only while looking up
2036 settings::StringsMap::const_iterator it = m->pMainConfigFile->mapExtraDataItems.find(strKey);
2037 if (it != m->pMainConfigFile->mapExtraDataItems.end())
2038 strOldValue = it->second;
2039 }
2040
2041 bool fChanged;
2042 if ((fChanged = (strOldValue != strValue)))
2043 {
2044 // ask for permission from all listeners outside the locks;
2045 // onExtraDataCanChange() only briefly requests the VirtualBox
2046 // lock to copy the list of callbacks to invoke
2047 Bstr error;
2048
2049 if (!i_onExtraDataCanChange(Guid::Empty, Bstr(aKey).raw(), Bstr(aValue).raw(), error))
2050 {
2051 const char *sep = error.isEmpty() ? "" : ": ";
2052 CBSTR err = error.raw();
2053 Log1WarningFunc(("Someone vetoed! Change refused%s%ls\n", sep, err));
2054 return setError(E_ACCESSDENIED,
2055 tr("Could not set extra data because someone refused the requested change of '%s' to '%s'%s%ls"),
2056 strKey.c_str(),
2057 strValue.c_str(),
2058 sep,
2059 err);
2060 }
2061
2062 // data is changing and change not vetoed: then write it out under the lock
2063
2064 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2065
2066 if (strValue.isEmpty())
2067 m->pMainConfigFile->mapExtraDataItems.erase(strKey);
2068 else
2069 m->pMainConfigFile->mapExtraDataItems[strKey] = strValue;
2070 // creates a new key if needed
2071
2072 /* save settings on success */
2073 rc = i_saveSettings();
2074 if (FAILED(rc)) return rc;
2075 }
2076
2077 // fire notification outside the lock
2078 if (fChanged)
2079 i_onExtraDataChange(Guid::Empty, Bstr(aKey).raw(), Bstr(aValue).raw());
2080
2081 return rc;
2082}
2083
2084/**
2085 *
2086 */
2087HRESULT VirtualBox::setSettingsSecret(const com::Utf8Str &aPassword)
2088{
2089 i_storeSettingsKey(aPassword);
2090 i_decryptSettings();
2091 return S_OK;
2092}
2093
2094int VirtualBox::i_decryptMediumSettings(Medium *pMedium)
2095{
2096 Bstr bstrCipher;
2097 HRESULT hrc = pMedium->GetProperty(Bstr("InitiatorSecretEncrypted").raw(),
2098 bstrCipher.asOutParam());
2099 if (SUCCEEDED(hrc))
2100 {
2101 Utf8Str strPlaintext;
2102 int rc = i_decryptSetting(&strPlaintext, bstrCipher);
2103 if (RT_SUCCESS(rc))
2104 pMedium->i_setPropertyDirect("InitiatorSecret", strPlaintext);
2105 else
2106 return rc;
2107 }
2108 return VINF_SUCCESS;
2109}
2110
2111/**
2112 * Decrypt all encrypted settings.
2113 *
2114 * So far we only have encrypted iSCSI initiator secrets so we just go through
2115 * all hard disk mediums and determine the plain 'InitiatorSecret' from
2116 * 'InitiatorSecretEncrypted. The latter is stored as Base64 because medium
2117 * properties need to be null-terminated strings.
2118 */
2119int VirtualBox::i_decryptSettings()
2120{
2121 bool fFailure = false;
2122 AutoReadLock al(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
2123 for (MediaList::const_iterator mt = m->allHardDisks.begin();
2124 mt != m->allHardDisks.end();
2125 ++mt)
2126 {
2127 ComObjPtr<Medium> pMedium = *mt;
2128 AutoCaller medCaller(pMedium);
2129 if (FAILED(medCaller.rc()))
2130 continue;
2131 AutoWriteLock mlock(pMedium COMMA_LOCKVAL_SRC_POS);
2132 int vrc = i_decryptMediumSettings(pMedium);
2133 if (RT_FAILURE(vrc))
2134 fFailure = true;
2135 }
2136 return fFailure ? VERR_INVALID_PARAMETER : VINF_SUCCESS;
2137}
2138
2139/**
2140 * Encode.
2141 *
2142 * @param aPlaintext plaintext to be encrypted
2143 * @param aCiphertext resulting ciphertext (base64-encoded)
2144 */
2145int VirtualBox::i_encryptSetting(const Utf8Str &aPlaintext, Utf8Str *aCiphertext)
2146{
2147 uint8_t abCiphertext[32];
2148 char szCipherBase64[128];
2149 size_t cchCipherBase64;
2150 int rc = i_encryptSettingBytes((uint8_t*)aPlaintext.c_str(), abCiphertext,
2151 aPlaintext.length()+1, sizeof(abCiphertext));
2152 if (RT_SUCCESS(rc))
2153 {
2154 rc = RTBase64Encode(abCiphertext, sizeof(abCiphertext),
2155 szCipherBase64, sizeof(szCipherBase64),
2156 &cchCipherBase64);
2157 if (RT_SUCCESS(rc))
2158 *aCiphertext = szCipherBase64;
2159 }
2160 return rc;
2161}
2162
2163/**
2164 * Decode.
2165 *
2166 * @param aPlaintext resulting plaintext
2167 * @param aCiphertext ciphertext (base64-encoded) to decrypt
2168 */
2169int VirtualBox::i_decryptSetting(Utf8Str *aPlaintext, const Utf8Str &aCiphertext)
2170{
2171 uint8_t abPlaintext[64];
2172 uint8_t abCiphertext[64];
2173 size_t cbCiphertext;
2174 int rc = RTBase64Decode(aCiphertext.c_str(),
2175 abCiphertext, sizeof(abCiphertext),
2176 &cbCiphertext, NULL);
2177 if (RT_SUCCESS(rc))
2178 {
2179 rc = i_decryptSettingBytes(abPlaintext, abCiphertext, cbCiphertext);
2180 if (RT_SUCCESS(rc))
2181 {
2182 for (unsigned i = 0; i < cbCiphertext; i++)
2183 {
2184 /* sanity check: null-terminated string? */
2185 if (abPlaintext[i] == '\0')
2186 {
2187 /* sanity check: valid UTF8 string? */
2188 if (RTStrIsValidEncoding((const char*)abPlaintext))
2189 {
2190 *aPlaintext = Utf8Str((const char*)abPlaintext);
2191 return VINF_SUCCESS;
2192 }
2193 }
2194 }
2195 rc = VERR_INVALID_MAGIC;
2196 }
2197 }
2198 return rc;
2199}
2200
2201/**
2202 * Encrypt secret bytes. Use the m->SettingsCipherKey as key.
2203 *
2204 * @param aPlaintext clear text to be encrypted
2205 * @param aCiphertext resulting encrypted text
2206 * @param aPlaintextSize size of the plaintext
2207 * @param aCiphertextSize size of the ciphertext
2208 */
2209int VirtualBox::i_encryptSettingBytes(const uint8_t *aPlaintext, uint8_t *aCiphertext,
2210 size_t aPlaintextSize, size_t aCiphertextSize) const
2211{
2212 unsigned i, j;
2213 uint8_t aBytes[64];
2214
2215 if (!m->fSettingsCipherKeySet)
2216 return VERR_INVALID_STATE;
2217
2218 if (aCiphertextSize > sizeof(aBytes))
2219 return VERR_BUFFER_OVERFLOW;
2220
2221 if (aCiphertextSize < 32)
2222 return VERR_INVALID_PARAMETER;
2223
2224 AssertCompile(sizeof(m->SettingsCipherKey) >= 32);
2225
2226 /* store the first 8 bytes of the cipherkey for verification */
2227 for (i = 0, j = 0; i < 8; i++, j++)
2228 aCiphertext[i] = m->SettingsCipherKey[j];
2229
2230 for (unsigned k = 0; k < aPlaintextSize && i < aCiphertextSize; i++, k++)
2231 {
2232 aCiphertext[i] = (aPlaintext[k] ^ m->SettingsCipherKey[j]);
2233 if (++j >= sizeof(m->SettingsCipherKey))
2234 j = 0;
2235 }
2236
2237 /* fill with random data to have a minimal length (salt) */
2238 if (i < aCiphertextSize)
2239 {
2240 RTRandBytes(aBytes, aCiphertextSize - i);
2241 for (int k = 0; i < aCiphertextSize; i++, k++)
2242 {
2243 aCiphertext[i] = aBytes[k] ^ m->SettingsCipherKey[j];
2244 if (++j >= sizeof(m->SettingsCipherKey))
2245 j = 0;
2246 }
2247 }
2248
2249 return VINF_SUCCESS;
2250}
2251
2252/**
2253 * Decrypt secret bytes. Use the m->SettingsCipherKey as key.
2254 *
2255 * @param aPlaintext resulting plaintext
2256 * @param aCiphertext ciphertext to be decrypted
2257 * @param aCiphertextSize size of the ciphertext == size of the plaintext
2258 */
2259int VirtualBox::i_decryptSettingBytes(uint8_t *aPlaintext,
2260 const uint8_t *aCiphertext, size_t aCiphertextSize) const
2261{
2262 unsigned i, j;
2263
2264 if (!m->fSettingsCipherKeySet)
2265 return VERR_INVALID_STATE;
2266
2267 if (aCiphertextSize < 32)
2268 return VERR_INVALID_PARAMETER;
2269
2270 /* key verification */
2271 for (i = 0, j = 0; i < 8; i++, j++)
2272 if (aCiphertext[i] != m->SettingsCipherKey[j])
2273 return VERR_INVALID_MAGIC;
2274
2275 /* poison */
2276 memset(aPlaintext, 0xff, aCiphertextSize);
2277 for (int k = 0; i < aCiphertextSize; i++, k++)
2278 {
2279 aPlaintext[k] = aCiphertext[i] ^ m->SettingsCipherKey[j];
2280 if (++j >= sizeof(m->SettingsCipherKey))
2281 j = 0;
2282 }
2283
2284 return VINF_SUCCESS;
2285}
2286
2287/**
2288 * Store a settings key.
2289 *
2290 * @param aKey the key to store
2291 */
2292void VirtualBox::i_storeSettingsKey(const Utf8Str &aKey)
2293{
2294 RTSha512(aKey.c_str(), aKey.length(), m->SettingsCipherKey);
2295 m->fSettingsCipherKeySet = true;
2296}
2297
2298// public methods only for internal purposes
2299/////////////////////////////////////////////////////////////////////////////
2300
2301#ifdef DEBUG
2302void VirtualBox::i_dumpAllBackRefs()
2303{
2304 {
2305 AutoReadLock al(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
2306 for (MediaList::const_iterator mt = m->allHardDisks.begin();
2307 mt != m->allHardDisks.end();
2308 ++mt)
2309 {
2310 ComObjPtr<Medium> pMedium = *mt;
2311 pMedium->i_dumpBackRefs();
2312 }
2313 }
2314 {
2315 AutoReadLock al(m->allDVDImages.getLockHandle() COMMA_LOCKVAL_SRC_POS);
2316 for (MediaList::const_iterator mt = m->allDVDImages.begin();
2317 mt != m->allDVDImages.end();
2318 ++mt)
2319 {
2320 ComObjPtr<Medium> pMedium = *mt;
2321 pMedium->i_dumpBackRefs();
2322 }
2323 }
2324}
2325#endif
2326
2327/**
2328 * Posts an event to the event queue that is processed asynchronously
2329 * on a dedicated thread.
2330 *
2331 * Posting events to the dedicated event queue is useful to perform secondary
2332 * actions outside any object locks -- for example, to iterate over a list
2333 * of callbacks and inform them about some change caused by some object's
2334 * method call.
2335 *
2336 * @param event event to post; must have been allocated using |new|, will
2337 * be deleted automatically by the event thread after processing
2338 *
2339 * @note Doesn't lock any object.
2340 */
2341HRESULT VirtualBox::i_postEvent(Event *event)
2342{
2343 AssertReturn(event, E_FAIL);
2344
2345 HRESULT rc;
2346 AutoCaller autoCaller(this);
2347 if (SUCCEEDED((rc = autoCaller.rc())))
2348 {
2349 if (getObjectState().getState() != ObjectState::Ready)
2350 Log1WarningFunc(("VirtualBox has been uninitialized (state=%d), the event is discarded!\n",
2351 getObjectState().getState()));
2352 // return S_OK
2353 else if ( (m->pAsyncEventQ)
2354 && (m->pAsyncEventQ->postEvent(event))
2355 )
2356 return S_OK;
2357 else
2358 rc = E_FAIL;
2359 }
2360
2361 // in any event of failure, we must clean up here, or we'll leak;
2362 // the caller has allocated the object using new()
2363 delete event;
2364 return rc;
2365}
2366
2367/**
2368 * Adds a progress to the global collection of pending operations.
2369 * Usually gets called upon progress object initialization.
2370 *
2371 * @param aProgress Operation to add to the collection.
2372 *
2373 * @note Doesn't lock objects.
2374 */
2375HRESULT VirtualBox::i_addProgress(IProgress *aProgress)
2376{
2377 CheckComArgNotNull(aProgress);
2378
2379 AutoCaller autoCaller(this);
2380 if (FAILED(autoCaller.rc())) return autoCaller.rc();
2381
2382 Bstr id;
2383 HRESULT rc = aProgress->COMGETTER(Id)(id.asOutParam());
2384 AssertComRCReturnRC(rc);
2385
2386 /* protect mProgressOperations */
2387 AutoWriteLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
2388
2389 m->mapProgressOperations.insert(ProgressMap::value_type(Guid(id), aProgress));
2390 return S_OK;
2391}
2392
2393/**
2394 * Removes the progress from the global collection of pending operations.
2395 * Usually gets called upon progress completion.
2396 *
2397 * @param aId UUID of the progress operation to remove
2398 *
2399 * @note Doesn't lock objects.
2400 */
2401HRESULT VirtualBox::i_removeProgress(IN_GUID aId)
2402{
2403 AutoCaller autoCaller(this);
2404 if (FAILED(autoCaller.rc())) return autoCaller.rc();
2405
2406 ComPtr<IProgress> progress;
2407
2408 /* protect mProgressOperations */
2409 AutoWriteLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
2410
2411 size_t cnt = m->mapProgressOperations.erase(aId);
2412 Assert(cnt == 1);
2413 NOREF(cnt);
2414
2415 return S_OK;
2416}
2417
2418#ifdef RT_OS_WINDOWS
2419
2420class StartSVCHelperClientData : public ThreadTask
2421{
2422public:
2423 StartSVCHelperClientData()
2424 {
2425 LogFlowFuncEnter();
2426 m_strTaskName = "SVCHelper";
2427 threadVoidData = NULL;
2428 initialized = false;
2429 }
2430
2431 virtual ~StartSVCHelperClientData()
2432 {
2433 LogFlowFuncEnter();
2434 if (threadVoidData!=NULL)
2435 {
2436 delete threadVoidData;
2437 threadVoidData=NULL;
2438 }
2439 };
2440
2441 void handler()
2442 {
2443 VirtualBox::i_SVCHelperClientThreadTask(this);
2444 }
2445
2446 const ComPtr<Progress>& GetProgressObject() const {return progress;}
2447
2448 bool init(VirtualBox* aVbox,
2449 Progress* aProgress,
2450 bool aPrivileged,
2451 VirtualBox::SVCHelperClientFunc aFunc,
2452 void *aUser)
2453 {
2454 LogFlowFuncEnter();
2455 that = aVbox;
2456 progress = aProgress;
2457 privileged = aPrivileged;
2458 func = aFunc;
2459 user = aUser;
2460
2461 initThreadVoidData();
2462
2463 initialized = true;
2464
2465 return initialized;
2466 }
2467
2468 bool isOk() const{ return initialized;}
2469
2470 bool initialized;
2471 ComObjPtr<VirtualBox> that;
2472 ComObjPtr<Progress> progress;
2473 bool privileged;
2474 VirtualBox::SVCHelperClientFunc func;
2475 void *user;
2476 ThreadVoidData *threadVoidData;
2477
2478private:
2479 bool initThreadVoidData()
2480 {
2481 LogFlowFuncEnter();
2482 threadVoidData = static_cast<ThreadVoidData*>(user);
2483 return true;
2484 }
2485};
2486
2487/**
2488 * Helper method that starts a worker thread that:
2489 * - creates a pipe communication channel using SVCHlpClient;
2490 * - starts an SVC Helper process that will inherit this channel;
2491 * - executes the supplied function by passing it the created SVCHlpClient
2492 * and opened instance to communicate to the Helper process and the given
2493 * Progress object.
2494 *
2495 * The user function is supposed to communicate to the helper process
2496 * using the \a aClient argument to do the requested job and optionally expose
2497 * the progress through the \a aProgress object. The user function should never
2498 * call notifyComplete() on it: this will be done automatically using the
2499 * result code returned by the function.
2500 *
2501 * Before the user function is started, the communication channel passed to
2502 * the \a aClient argument is fully set up, the function should start using
2503 * its write() and read() methods directly.
2504 *
2505 * The \a aVrc parameter of the user function may be used to return an error
2506 * code if it is related to communication errors (for example, returned by
2507 * the SVCHlpClient members when they fail). In this case, the correct error
2508 * message using this value will be reported to the caller. Note that the
2509 * value of \a aVrc is inspected only if the user function itself returns
2510 * success.
2511 *
2512 * If a failure happens anywhere before the user function would be normally
2513 * called, it will be called anyway in special "cleanup only" mode indicated
2514 * by \a aClient, \a aProgress and \aVrc arguments set to NULL. In this mode,
2515 * all the function is supposed to do is to cleanup its aUser argument if
2516 * necessary (it's assumed that the ownership of this argument is passed to
2517 * the user function once #startSVCHelperClient() returns a success, thus
2518 * making it responsible for the cleanup).
2519 *
2520 * After the user function returns, the thread will send the SVCHlpMsg::Null
2521 * message to indicate a process termination.
2522 *
2523 * @param aPrivileged |true| to start the SVC Helper process as a privileged
2524 * user that can perform administrative tasks
2525 * @param aFunc user function to run
2526 * @param aUser argument to the user function
2527 * @param aProgress progress object that will track operation completion
2528 *
2529 * @note aPrivileged is currently ignored (due to some unsolved problems in
2530 * Vista) and the process will be started as a normal (unprivileged)
2531 * process.
2532 *
2533 * @note Doesn't lock anything.
2534 */
2535HRESULT VirtualBox::i_startSVCHelperClient(bool aPrivileged,
2536 SVCHelperClientFunc aFunc,
2537 void *aUser, Progress *aProgress)
2538{
2539 LogFlowFuncEnter();
2540 AssertReturn(aFunc, E_POINTER);
2541 AssertReturn(aProgress, E_POINTER);
2542
2543 AutoCaller autoCaller(this);
2544 if (FAILED(autoCaller.rc())) return autoCaller.rc();
2545
2546 /* create the i_SVCHelperClientThreadTask() argument */
2547
2548 HRESULT hr = S_OK;
2549 StartSVCHelperClientData *pTask = NULL;
2550 try
2551 {
2552 pTask = new StartSVCHelperClientData();
2553
2554 pTask->init(this, aProgress, aPrivileged, aFunc, aUser);
2555
2556 if (!pTask->isOk())
2557 {
2558 delete pTask;
2559 LogRel(("Could not init StartSVCHelperClientData object \n"));
2560 throw E_FAIL;
2561 }
2562
2563 //this function delete pTask in case of exceptions, so there is no need in the call of delete operator
2564 hr = pTask->createThreadWithType(RTTHREADTYPE_MAIN_WORKER);
2565
2566 }
2567 catch(std::bad_alloc &)
2568 {
2569 hr = setError(E_OUTOFMEMORY);
2570 }
2571 catch(...)
2572 {
2573 LogRel(("Could not create thread for StartSVCHelperClientData \n"));
2574 hr = E_FAIL;
2575 }
2576
2577 return hr;
2578}
2579
2580/**
2581 * Worker thread for startSVCHelperClient().
2582 */
2583/* static */
2584void VirtualBox::i_SVCHelperClientThreadTask(StartSVCHelperClientData *pTask)
2585{
2586 LogFlowFuncEnter();
2587 HRESULT rc = S_OK;
2588 bool userFuncCalled = false;
2589
2590 do
2591 {
2592 AssertBreakStmt(pTask, rc = E_POINTER);
2593 AssertReturnVoid(!pTask->progress.isNull());
2594
2595 /* protect VirtualBox from uninitialization */
2596 AutoCaller autoCaller(pTask->that);
2597 if (!autoCaller.isOk())
2598 {
2599 /* it's too late */
2600 rc = autoCaller.rc();
2601 break;
2602 }
2603
2604 int vrc = VINF_SUCCESS;
2605
2606 Guid id;
2607 id.create();
2608 SVCHlpClient client;
2609 vrc = client.create(Utf8StrFmt("VirtualBox\\SVCHelper\\{%RTuuid}",
2610 id.raw()).c_str());
2611 if (RT_FAILURE(vrc))
2612 {
2613 rc = pTask->that->setError(E_FAIL, tr("Could not create the communication channel (%Rrc)"), vrc);
2614 break;
2615 }
2616
2617 /* get the path to the executable */
2618 char exePathBuf[RTPATH_MAX];
2619 char *exePath = RTProcGetExecutablePath(exePathBuf, RTPATH_MAX);
2620 if (!exePath)
2621 {
2622 rc = pTask->that->setError(E_FAIL, tr("Cannot get executable name"));
2623 break;
2624 }
2625
2626 Utf8Str argsStr = Utf8StrFmt("/Helper %s", client.name().c_str());
2627
2628 LogFlowFunc(("Starting '\"%s\" %s'...\n", exePath, argsStr.c_str()));
2629
2630 RTPROCESS pid = NIL_RTPROCESS;
2631
2632 if (pTask->privileged)
2633 {
2634 /* Attempt to start a privileged process using the Run As dialog */
2635
2636 Bstr file = exePath;
2637 Bstr parameters = argsStr;
2638
2639 SHELLEXECUTEINFO shExecInfo;
2640
2641 shExecInfo.cbSize = sizeof(SHELLEXECUTEINFO);
2642
2643 shExecInfo.fMask = NULL;
2644 shExecInfo.hwnd = NULL;
2645 shExecInfo.lpVerb = L"runas";
2646 shExecInfo.lpFile = file.raw();
2647 shExecInfo.lpParameters = parameters.raw();
2648 shExecInfo.lpDirectory = NULL;
2649 shExecInfo.nShow = SW_NORMAL;
2650 shExecInfo.hInstApp = NULL;
2651
2652 if (!ShellExecuteEx(&shExecInfo))
2653 {
2654 int vrc2 = RTErrConvertFromWin32(GetLastError());
2655 /* hide excessive details in case of a frequent error
2656 * (pressing the Cancel button to close the Run As dialog) */
2657 if (vrc2 == VERR_CANCELLED)
2658 rc = pTask->that->setError(E_FAIL, tr("Operation canceled by the user"));
2659 else
2660 rc = pTask->that->setError(E_FAIL, tr("Could not launch a privileged process '%s' (%Rrc)"), exePath, vrc2);
2661 break;
2662 }
2663 }
2664 else
2665 {
2666 const char *args[] = { exePath, "/Helper", client.name().c_str(), 0 };
2667 vrc = RTProcCreate(exePath, args, RTENV_DEFAULT, 0, &pid);
2668 if (RT_FAILURE(vrc))
2669 {
2670 rc = pTask->that->setError(E_FAIL, tr("Could not launch a process '%s' (%Rrc)"), exePath, vrc);
2671 break;
2672 }
2673 }
2674
2675 /* wait for the client to connect */
2676 vrc = client.connect();
2677 if (RT_SUCCESS(vrc))
2678 {
2679 /* start the user supplied function */
2680 rc = pTask->func(&client, pTask->progress, pTask->user, &vrc);
2681 userFuncCalled = true;
2682 }
2683
2684 /* send the termination signal to the process anyway */
2685 {
2686 int vrc2 = client.write(SVCHlpMsg::Null);
2687 if (RT_SUCCESS(vrc))
2688 vrc = vrc2;
2689 }
2690
2691 if (SUCCEEDED(rc) && RT_FAILURE(vrc))
2692 {
2693 rc = pTask->that->setError(E_FAIL, tr("Could not operate the communication channel (%Rrc)"), vrc);
2694 break;
2695 }
2696 }
2697 while (0);
2698
2699 if (FAILED(rc) && !userFuncCalled)
2700 {
2701 /* call the user function in the "cleanup only" mode
2702 * to let it free resources passed to in aUser */
2703 pTask->func(NULL, NULL, pTask->user, NULL);
2704 }
2705
2706 pTask->progress->i_notifyComplete(rc);
2707
2708 LogFlowFuncLeave();
2709}
2710
2711#endif /* RT_OS_WINDOWS */
2712
2713/**
2714 * Sends a signal to the client watcher to rescan the set of machines
2715 * that have open sessions.
2716 *
2717 * @note Doesn't lock anything.
2718 */
2719void VirtualBox::i_updateClientWatcher()
2720{
2721 AutoCaller autoCaller(this);
2722 AssertComRCReturnVoid(autoCaller.rc());
2723
2724 AssertPtrReturnVoid(m->pClientWatcher);
2725 m->pClientWatcher->update();
2726}
2727
2728/**
2729 * Adds the given child process ID to the list of processes to be reaped.
2730 * This call should be followed by #i_updateClientWatcher() to take the effect.
2731 *
2732 * @note Doesn't lock anything.
2733 */
2734void VirtualBox::i_addProcessToReap(RTPROCESS pid)
2735{
2736 AutoCaller autoCaller(this);
2737 AssertComRCReturnVoid(autoCaller.rc());
2738
2739 AssertPtrReturnVoid(m->pClientWatcher);
2740 m->pClientWatcher->addProcess(pid);
2741}
2742
2743/** Event for onMachineStateChange(), onMachineDataChange(), onMachineRegistered() */
2744struct MachineEvent : public VirtualBox::CallbackEvent
2745{
2746 MachineEvent(VirtualBox *aVB, VBoxEventType_T aWhat, const Guid &aId, BOOL aBool)
2747 : CallbackEvent(aVB, aWhat), id(aId.toUtf16())
2748 , mBool(aBool)
2749 { }
2750
2751 MachineEvent(VirtualBox *aVB, VBoxEventType_T aWhat, const Guid &aId, MachineState_T aState)
2752 : CallbackEvent(aVB, aWhat), id(aId.toUtf16())
2753 , mState(aState)
2754 {}
2755
2756 virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
2757 {
2758 switch (mWhat)
2759 {
2760 case VBoxEventType_OnMachineDataChanged:
2761 aEvDesc.init(aSource, mWhat, id.raw(), mBool);
2762 break;
2763
2764 case VBoxEventType_OnMachineStateChanged:
2765 aEvDesc.init(aSource, mWhat, id.raw(), mState);
2766 break;
2767
2768 case VBoxEventType_OnMachineRegistered:
2769 aEvDesc.init(aSource, mWhat, id.raw(), mBool);
2770 break;
2771
2772 default:
2773 AssertFailedReturn(S_OK);
2774 }
2775 return S_OK;
2776 }
2777
2778 Bstr id;
2779 MachineState_T mState;
2780 BOOL mBool;
2781};
2782
2783
2784/**
2785 * VD plugin load
2786 */
2787int VirtualBox::i_loadVDPlugin(const char *pszPluginLibrary)
2788{
2789 return m->pSystemProperties->i_loadVDPlugin(pszPluginLibrary);
2790}
2791
2792/**
2793 * VD plugin unload
2794 */
2795int VirtualBox::i_unloadVDPlugin(const char *pszPluginLibrary)
2796{
2797 return m->pSystemProperties->i_unloadVDPlugin(pszPluginLibrary);
2798}
2799
2800
2801/**
2802 * @note Doesn't lock any object.
2803 */
2804void VirtualBox::i_onMachineStateChange(const Guid &aId, MachineState_T aState)
2805{
2806 i_postEvent(new MachineEvent(this, VBoxEventType_OnMachineStateChanged, aId, aState));
2807}
2808
2809/**
2810 * @note Doesn't lock any object.
2811 */
2812void VirtualBox::i_onMachineDataChange(const Guid &aId, BOOL aTemporary)
2813{
2814 i_postEvent(new MachineEvent(this, VBoxEventType_OnMachineDataChanged, aId, aTemporary));
2815}
2816
2817/**
2818 * @note Locks this object for reading.
2819 */
2820BOOL VirtualBox::i_onExtraDataCanChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue,
2821 Bstr &aError)
2822{
2823 LogFlowThisFunc(("machine={%s} aKey={%ls} aValue={%ls}\n",
2824 aId.toString().c_str(), aKey, aValue));
2825
2826 AutoCaller autoCaller(this);
2827 AssertComRCReturn(autoCaller.rc(), FALSE);
2828
2829 BOOL allowChange = TRUE;
2830 Bstr id = aId.toUtf16();
2831
2832 VBoxEventDesc evDesc;
2833 evDesc.init(m->pEventSource, VBoxEventType_OnExtraDataCanChange, id.raw(), aKey, aValue);
2834 BOOL fDelivered = evDesc.fire(3000); /* Wait up to 3 secs for delivery */
2835 //Assert(fDelivered);
2836 if (fDelivered)
2837 {
2838 ComPtr<IEvent> aEvent;
2839 evDesc.getEvent(aEvent.asOutParam());
2840 ComPtr<IExtraDataCanChangeEvent> aCanChangeEvent = aEvent;
2841 Assert(aCanChangeEvent);
2842 BOOL fVetoed = FALSE;
2843 aCanChangeEvent->IsVetoed(&fVetoed);
2844 allowChange = !fVetoed;
2845
2846 if (!allowChange)
2847 {
2848 SafeArray<BSTR> aVetos;
2849 aCanChangeEvent->GetVetos(ComSafeArrayAsOutParam(aVetos));
2850 if (aVetos.size() > 0)
2851 aError = aVetos[0];
2852 }
2853 }
2854 else
2855 allowChange = TRUE;
2856
2857 LogFlowThisFunc(("allowChange=%RTbool\n", allowChange));
2858 return allowChange;
2859}
2860
2861/** Event for onExtraDataChange() */
2862struct ExtraDataEvent : public VirtualBox::CallbackEvent
2863{
2864 ExtraDataEvent(VirtualBox *aVB, const Guid &aMachineId,
2865 IN_BSTR aKey, IN_BSTR aVal)
2866 : CallbackEvent(aVB, VBoxEventType_OnExtraDataChanged)
2867 , machineId(aMachineId.toUtf16()), key(aKey), val(aVal)
2868 {}
2869
2870 virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
2871 {
2872 return aEvDesc.init(aSource, VBoxEventType_OnExtraDataChanged, machineId.raw(), key.raw(), val.raw());
2873 }
2874
2875 Bstr machineId, key, val;
2876};
2877
2878/**
2879 * @note Doesn't lock any object.
2880 */
2881void VirtualBox::i_onExtraDataChange(const Guid &aId, IN_BSTR aKey, IN_BSTR aValue)
2882{
2883 i_postEvent(new ExtraDataEvent(this, aId, aKey, aValue));
2884}
2885
2886/**
2887 * @note Doesn't lock any object.
2888 */
2889void VirtualBox::i_onMachineRegistered(const Guid &aId, BOOL aRegistered)
2890{
2891 i_postEvent(new MachineEvent(this, VBoxEventType_OnMachineRegistered, aId, aRegistered));
2892}
2893
2894/** Event for onSessionStateChange() */
2895struct SessionEvent : public VirtualBox::CallbackEvent
2896{
2897 SessionEvent(VirtualBox *aVB, const Guid &aMachineId, SessionState_T aState)
2898 : CallbackEvent(aVB, VBoxEventType_OnSessionStateChanged)
2899 , machineId(aMachineId.toUtf16()), sessionState(aState)
2900 {}
2901
2902 virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
2903 {
2904 return aEvDesc.init(aSource, VBoxEventType_OnSessionStateChanged, machineId.raw(), sessionState);
2905 }
2906 Bstr machineId;
2907 SessionState_T sessionState;
2908};
2909
2910/**
2911 * @note Doesn't lock any object.
2912 */
2913void VirtualBox::i_onSessionStateChange(const Guid &aId, SessionState_T aState)
2914{
2915 i_postEvent(new SessionEvent(this, aId, aState));
2916}
2917
2918/** Event for i_onSnapshotTaken(), i_onSnapshotDeleted(), i_onSnapshotRestored() and i_onSnapshotChange() */
2919struct SnapshotEvent : public VirtualBox::CallbackEvent
2920{
2921 SnapshotEvent(VirtualBox *aVB, const Guid &aMachineId, const Guid &aSnapshotId,
2922 VBoxEventType_T aWhat)
2923 : CallbackEvent(aVB, aWhat)
2924 , machineId(aMachineId), snapshotId(aSnapshotId)
2925 {}
2926
2927 virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
2928 {
2929 return aEvDesc.init(aSource, mWhat, machineId.toUtf16().raw(),
2930 snapshotId.toUtf16().raw());
2931 }
2932
2933 Guid machineId;
2934 Guid snapshotId;
2935};
2936
2937/**
2938 * @note Doesn't lock any object.
2939 */
2940void VirtualBox::i_onSnapshotTaken(const Guid &aMachineId, const Guid &aSnapshotId)
2941{
2942 i_postEvent(new SnapshotEvent(this, aMachineId, aSnapshotId,
2943 VBoxEventType_OnSnapshotTaken));
2944}
2945
2946/**
2947 * @note Doesn't lock any object.
2948 */
2949void VirtualBox::i_onSnapshotDeleted(const Guid &aMachineId, const Guid &aSnapshotId)
2950{
2951 i_postEvent(new SnapshotEvent(this, aMachineId, aSnapshotId,
2952 VBoxEventType_OnSnapshotDeleted));
2953}
2954
2955/**
2956 * @note Doesn't lock any object.
2957 */
2958void VirtualBox::i_onSnapshotRestored(const Guid &aMachineId, const Guid &aSnapshotId)
2959{
2960 i_postEvent(new SnapshotEvent(this, aMachineId, aSnapshotId,
2961 VBoxEventType_OnSnapshotRestored));
2962}
2963
2964/**
2965 * @note Doesn't lock any object.
2966 */
2967void VirtualBox::i_onSnapshotChange(const Guid &aMachineId, const Guid &aSnapshotId)
2968{
2969 i_postEvent(new SnapshotEvent(this, aMachineId, aSnapshotId,
2970 VBoxEventType_OnSnapshotChanged));
2971}
2972
2973/** Event for onGuestPropertyChange() */
2974struct GuestPropertyEvent : public VirtualBox::CallbackEvent
2975{
2976 GuestPropertyEvent(VirtualBox *aVBox, const Guid &aMachineId,
2977 IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags)
2978 : CallbackEvent(aVBox, VBoxEventType_OnGuestPropertyChanged),
2979 machineId(aMachineId),
2980 name(aName),
2981 value(aValue),
2982 flags(aFlags)
2983 {}
2984
2985 virtual HRESULT prepareEventDesc(IEventSource* aSource, VBoxEventDesc& aEvDesc)
2986 {
2987 return aEvDesc.init(aSource, VBoxEventType_OnGuestPropertyChanged,
2988 machineId.toUtf16().raw(), name.raw(), value.raw(), flags.raw());
2989 }
2990
2991 Guid machineId;
2992 Bstr name, value, flags;
2993};
2994
2995/**
2996 * @note Doesn't lock any object.
2997 */
2998void VirtualBox::i_onGuestPropertyChange(const Guid &aMachineId, IN_BSTR aName,
2999 IN_BSTR aValue, IN_BSTR aFlags)
3000{
3001 i_postEvent(new GuestPropertyEvent(this, aMachineId, aName, aValue, aFlags));
3002}
3003
3004/**
3005 * @note Doesn't lock any object.
3006 */
3007void VirtualBox::i_onNatRedirectChange(const Guid &aMachineId, ULONG ulSlot, bool fRemove, IN_BSTR aName,
3008 NATProtocol_T aProto, IN_BSTR aHostIp, uint16_t aHostPort,
3009 IN_BSTR aGuestIp, uint16_t aGuestPort)
3010{
3011 fireNATRedirectEvent(m->pEventSource, aMachineId.toUtf16().raw(), ulSlot, fRemove, aName, aProto, aHostIp,
3012 aHostPort, aGuestIp, aGuestPort);
3013}
3014
3015void VirtualBox::i_onNATNetworkChange(IN_BSTR aName)
3016{
3017 fireNATNetworkChangedEvent(m->pEventSource, aName);
3018}
3019
3020void VirtualBox::i_onNATNetworkStartStop(IN_BSTR aName, BOOL fStart)
3021{
3022 fireNATNetworkStartStopEvent(m->pEventSource, aName, fStart);
3023}
3024
3025void VirtualBox::i_onNATNetworkSetting(IN_BSTR aNetworkName, BOOL aEnabled,
3026 IN_BSTR aNetwork, IN_BSTR aGateway,
3027 BOOL aAdvertiseDefaultIpv6RouteEnabled,
3028 BOOL fNeedDhcpServer)
3029{
3030 fireNATNetworkSettingEvent(m->pEventSource, aNetworkName, aEnabled,
3031 aNetwork, aGateway,
3032 aAdvertiseDefaultIpv6RouteEnabled, fNeedDhcpServer);
3033}
3034
3035void VirtualBox::i_onNATNetworkPortForward(IN_BSTR aNetworkName, BOOL create, BOOL fIpv6,
3036 IN_BSTR aRuleName, NATProtocol_T proto,
3037 IN_BSTR aHostIp, LONG aHostPort,
3038 IN_BSTR aGuestIp, LONG aGuestPort)
3039{
3040 fireNATNetworkPortForwardEvent(m->pEventSource, aNetworkName, create,
3041 fIpv6, aRuleName, proto,
3042 aHostIp, aHostPort,
3043 aGuestIp, aGuestPort);
3044}
3045
3046
3047void VirtualBox::i_onHostNameResolutionConfigurationChange()
3048{
3049 if (m->pEventSource)
3050 fireHostNameResolutionConfigurationChangeEvent(m->pEventSource);
3051}
3052
3053
3054int VirtualBox::i_natNetworkRefInc(const Utf8Str &aNetworkName)
3055{
3056 AutoWriteLock safeLock(*spMtxNatNetworkNameToRefCountLock COMMA_LOCKVAL_SRC_POS);
3057
3058 if (!sNatNetworkNameToRefCount[aNetworkName])
3059 {
3060 ComPtr<INATNetwork> nat;
3061 HRESULT rc = findNATNetworkByName(aNetworkName, nat);
3062 if (FAILED(rc)) return -1;
3063
3064 rc = nat->Start(Bstr("whatever").raw());
3065 if (SUCCEEDED(rc))
3066 LogRel(("Started NAT network '%s'\n", aNetworkName.c_str()));
3067 else
3068 LogRel(("Error %Rhrc starting NAT network '%s'\n", rc, aNetworkName.c_str()));
3069 AssertComRCReturn(rc, -1);
3070 }
3071
3072 sNatNetworkNameToRefCount[aNetworkName]++;
3073
3074 return sNatNetworkNameToRefCount[aNetworkName];
3075}
3076
3077
3078int VirtualBox::i_natNetworkRefDec(const Utf8Str &aNetworkName)
3079{
3080 AutoWriteLock safeLock(*spMtxNatNetworkNameToRefCountLock COMMA_LOCKVAL_SRC_POS);
3081
3082 if (!sNatNetworkNameToRefCount[aNetworkName])
3083 return 0;
3084
3085 sNatNetworkNameToRefCount[aNetworkName]--;
3086
3087 if (!sNatNetworkNameToRefCount[aNetworkName])
3088 {
3089 ComPtr<INATNetwork> nat;
3090 HRESULT rc = findNATNetworkByName(aNetworkName, nat);
3091 if (FAILED(rc)) return -1;
3092
3093 rc = nat->Stop();
3094 if (SUCCEEDED(rc))
3095 LogRel(("Stopped NAT network '%s'\n", aNetworkName.c_str()));
3096 else
3097 LogRel(("Error %Rhrc stopping NAT network '%s'\n", rc, aNetworkName.c_str()));
3098 AssertComRCReturn(rc, -1);
3099 }
3100
3101 return sNatNetworkNameToRefCount[aNetworkName];
3102}
3103
3104
3105/**
3106 * @note Locks the list of other objects for reading.
3107 */
3108ComObjPtr<GuestOSType> VirtualBox::i_getUnknownOSType()
3109{
3110 ComObjPtr<GuestOSType> type;
3111
3112 /* unknown type must always be the first */
3113 ComAssertRet(m->allGuestOSTypes.size() > 0, type);
3114
3115 return m->allGuestOSTypes.front();
3116}
3117
3118/**
3119 * Returns the list of opened machines (machines having VM sessions opened,
3120 * ignoring other sessions) and optionally the list of direct session controls.
3121 *
3122 * @param aMachines Where to put opened machines (will be empty if none).
3123 * @param aControls Where to put direct session controls (optional).
3124 *
3125 * @note The returned lists contain smart pointers. So, clear it as soon as
3126 * it becomes no more necessary to release instances.
3127 *
3128 * @note It can be possible that a session machine from the list has been
3129 * already uninitialized, so do a usual AutoCaller/AutoReadLock sequence
3130 * when accessing unprotected data directly.
3131 *
3132 * @note Locks objects for reading.
3133 */
3134void VirtualBox::i_getOpenedMachines(SessionMachinesList &aMachines,
3135 InternalControlList *aControls /*= NULL*/)
3136{
3137 AutoCaller autoCaller(this);
3138 AssertComRCReturnVoid(autoCaller.rc());
3139
3140 aMachines.clear();
3141 if (aControls)
3142 aControls->clear();
3143
3144 AutoReadLock alock(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
3145
3146 for (MachinesOList::iterator it = m->allMachines.begin();
3147 it != m->allMachines.end();
3148 ++it)
3149 {
3150 ComObjPtr<SessionMachine> sm;
3151 ComPtr<IInternalSessionControl> ctl;
3152 if ((*it)->i_isSessionOpenVM(sm, &ctl))
3153 {
3154 aMachines.push_back(sm);
3155 if (aControls)
3156 aControls->push_back(ctl);
3157 }
3158 }
3159}
3160
3161/**
3162 * Gets a reference to the machine list. This is the real thing, not a copy,
3163 * so bad things will happen if the caller doesn't hold the necessary lock.
3164 *
3165 * @returns reference to machine list
3166 *
3167 * @note Caller must hold the VirtualBox object lock at least for reading.
3168 */
3169VirtualBox::MachinesOList &VirtualBox::i_getMachinesList(void)
3170{
3171 return m->allMachines;
3172}
3173
3174/**
3175 * Searches for a machine object with the given ID in the collection
3176 * of registered machines.
3177 *
3178 * @param aId Machine UUID to look for.
3179 * @param fPermitInaccessible If true, inaccessible machines will be found;
3180 * if false, this will fail if the given machine is inaccessible.
3181 * @param aSetError If true, set errorinfo if the machine is not found.
3182 * @param aMachine Returned machine, if found.
3183 * @return
3184 */
3185HRESULT VirtualBox::i_findMachine(const Guid &aId,
3186 bool fPermitInaccessible,
3187 bool aSetError,
3188 ComObjPtr<Machine> *aMachine /* = NULL */)
3189{
3190 HRESULT rc = VBOX_E_OBJECT_NOT_FOUND;
3191
3192 AutoCaller autoCaller(this);
3193 AssertComRCReturnRC(autoCaller.rc());
3194
3195 {
3196 AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
3197
3198 for (MachinesOList::iterator it = m->allMachines.begin();
3199 it != m->allMachines.end();
3200 ++it)
3201 {
3202 ComObjPtr<Machine> pMachine = *it;
3203
3204 if (!fPermitInaccessible)
3205 {
3206 // skip inaccessible machines
3207 AutoCaller machCaller(pMachine);
3208 if (FAILED(machCaller.rc()))
3209 continue;
3210 }
3211
3212 if (pMachine->i_getId() == aId)
3213 {
3214 rc = S_OK;
3215 if (aMachine)
3216 *aMachine = pMachine;
3217 break;
3218 }
3219 }
3220 }
3221
3222 if (aSetError && FAILED(rc))
3223 rc = setError(rc,
3224 tr("Could not find a registered machine with UUID {%RTuuid}"),
3225 aId.raw());
3226
3227 return rc;
3228}
3229
3230/**
3231 * Searches for a machine object with the given name or location in the
3232 * collection of registered machines.
3233 *
3234 * @param aName Machine name or location to look for.
3235 * @param aSetError If true, set errorinfo if the machine is not found.
3236 * @param aMachine Returned machine, if found.
3237 * @return
3238 */
3239HRESULT VirtualBox::i_findMachineByName(const Utf8Str &aName,
3240 bool aSetError,
3241 ComObjPtr<Machine> *aMachine /* = NULL */)
3242{
3243 HRESULT rc = VBOX_E_OBJECT_NOT_FOUND;
3244
3245 AutoReadLock al(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
3246 for (MachinesOList::iterator it = m->allMachines.begin();
3247 it != m->allMachines.end();
3248 ++it)
3249 {
3250 ComObjPtr<Machine> &pMachine = *it;
3251 AutoCaller machCaller(pMachine);
3252 if (machCaller.rc())
3253 continue; // we can't ask inaccessible machines for their names
3254
3255 AutoReadLock machLock(pMachine COMMA_LOCKVAL_SRC_POS);
3256 if (pMachine->i_getName() == aName)
3257 {
3258 rc = S_OK;
3259 if (aMachine)
3260 *aMachine = pMachine;
3261 break;
3262 }
3263 if (!RTPathCompare(pMachine->i_getSettingsFileFull().c_str(), aName.c_str()))
3264 {
3265 rc = S_OK;
3266 if (aMachine)
3267 *aMachine = pMachine;
3268 break;
3269 }
3270 }
3271
3272 if (aSetError && FAILED(rc))
3273 rc = setError(rc,
3274 tr("Could not find a registered machine named '%s'"), aName.c_str());
3275
3276 return rc;
3277}
3278
3279static HRESULT i_validateMachineGroupHelper(const Utf8Str &aGroup, bool fPrimary, VirtualBox *pVirtualBox)
3280{
3281 /* empty strings are invalid */
3282 if (aGroup.isEmpty())
3283 return E_INVALIDARG;
3284 /* the toplevel group is valid */
3285 if (aGroup == "/")
3286 return S_OK;
3287 /* any other strings of length 1 are invalid */
3288 if (aGroup.length() == 1)
3289 return E_INVALIDARG;
3290 /* must start with a slash */
3291 if (aGroup.c_str()[0] != '/')
3292 return E_INVALIDARG;
3293 /* must not end with a slash */
3294 if (aGroup.c_str()[aGroup.length() - 1] == '/')
3295 return E_INVALIDARG;
3296 /* check the group components */
3297 const char *pStr = aGroup.c_str() + 1; /* first char is /, skip it */
3298 while (pStr)
3299 {
3300 char *pSlash = RTStrStr(pStr, "/");
3301 if (pSlash)
3302 {
3303 /* no empty components (or // sequences in other words) */
3304 if (pSlash == pStr)
3305 return E_INVALIDARG;
3306 /* check if the machine name rules are violated, because that means
3307 * the group components are too close to the limits. */
3308 Utf8Str tmp((const char *)pStr, (size_t)(pSlash - pStr));
3309 Utf8Str tmp2(tmp);
3310 sanitiseMachineFilename(tmp);
3311 if (tmp != tmp2)
3312 return E_INVALIDARG;
3313 if (fPrimary)
3314 {
3315 HRESULT rc = pVirtualBox->i_findMachineByName(tmp,
3316 false /* aSetError */);
3317 if (SUCCEEDED(rc))
3318 return VBOX_E_VM_ERROR;
3319 }
3320 pStr = pSlash + 1;
3321 }
3322 else
3323 {
3324 /* check if the machine name rules are violated, because that means
3325 * the group components is too close to the limits. */
3326 Utf8Str tmp(pStr);
3327 Utf8Str tmp2(tmp);
3328 sanitiseMachineFilename(tmp);
3329 if (tmp != tmp2)
3330 return E_INVALIDARG;
3331 pStr = NULL;
3332 }
3333 }
3334 return S_OK;
3335}
3336
3337/**
3338 * Validates a machine group.
3339 *
3340 * @param aGroup Machine group.
3341 * @param fPrimary Set if this is the primary group.
3342 *
3343 * @return S_OK or E_INVALIDARG
3344 */
3345HRESULT VirtualBox::i_validateMachineGroup(const Utf8Str &aGroup, bool fPrimary)
3346{
3347 HRESULT rc = i_validateMachineGroupHelper(aGroup, fPrimary, this);
3348 if (FAILED(rc))
3349 {
3350 if (rc == VBOX_E_VM_ERROR)
3351 rc = setError(E_INVALIDARG,
3352 tr("Machine group '%s' conflicts with a virtual machine name"),
3353 aGroup.c_str());
3354 else
3355 rc = setError(rc,
3356 tr("Invalid machine group '%s'"),
3357 aGroup.c_str());
3358 }
3359 return rc;
3360}
3361
3362/**
3363 * Takes a list of machine groups, and sanitizes/validates it.
3364 *
3365 * @param aMachineGroups Array with the machine groups.
3366 * @param pllMachineGroups Pointer to list of strings for the result.
3367 *
3368 * @return S_OK or E_INVALIDARG
3369 */
3370HRESULT VirtualBox::i_convertMachineGroups(const std::vector<com::Utf8Str> aMachineGroups, StringsList *pllMachineGroups)
3371{
3372 pllMachineGroups->clear();
3373 if (aMachineGroups.size())
3374 {
3375 for (size_t i = 0; i < aMachineGroups.size(); i++)
3376 {
3377 Utf8Str group(aMachineGroups[i]);
3378 if (group.length() == 0)
3379 group = "/";
3380
3381 HRESULT rc = i_validateMachineGroup(group, i == 0);
3382 if (FAILED(rc))
3383 return rc;
3384
3385 /* no duplicates please */
3386 if ( find(pllMachineGroups->begin(), pllMachineGroups->end(), group)
3387 == pllMachineGroups->end())
3388 pllMachineGroups->push_back(group);
3389 }
3390 if (pllMachineGroups->size() == 0)
3391 pllMachineGroups->push_back("/");
3392 }
3393 else
3394 pllMachineGroups->push_back("/");
3395
3396 return S_OK;
3397}
3398
3399/**
3400 * Searches for a Medium object with the given ID in the list of registered
3401 * hard disks.
3402 *
3403 * @param aId ID of the hard disk. Must not be empty.
3404 * @param aSetError If @c true , the appropriate error info is set in case
3405 * when the hard disk is not found.
3406 * @param aHardDisk Where to store the found hard disk object (can be NULL).
3407 *
3408 * @return S_OK, E_INVALIDARG or VBOX_E_OBJECT_NOT_FOUND when not found.
3409 *
3410 * @note Locks the media tree for reading.
3411 */
3412HRESULT VirtualBox::i_findHardDiskById(const Guid &aId,
3413 bool aSetError,
3414 ComObjPtr<Medium> *aHardDisk /*= NULL*/)
3415{
3416 AssertReturn(!aId.isZero(), E_INVALIDARG);
3417
3418 // we use the hard disks map, but it is protected by the
3419 // hard disk _list_ lock handle
3420 AutoReadLock alock(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
3421
3422 HardDiskMap::const_iterator it = m->mapHardDisks.find(aId);
3423 if (it != m->mapHardDisks.end())
3424 {
3425 if (aHardDisk)
3426 *aHardDisk = (*it).second;
3427 return S_OK;
3428 }
3429
3430 if (aSetError)
3431 return setError(VBOX_E_OBJECT_NOT_FOUND,
3432 tr("Could not find an open hard disk with UUID {%RTuuid}"),
3433 aId.raw());
3434
3435 return VBOX_E_OBJECT_NOT_FOUND;
3436}
3437
3438/**
3439 * Searches for a Medium object with the given ID or location in the list of
3440 * registered hard disks. If both ID and location are specified, the first
3441 * object that matches either of them (not necessarily both) is returned.
3442 *
3443 * @param strLocation Full location specification. Must not be empty.
3444 * @param aSetError If @c true , the appropriate error info is set in case
3445 * when the hard disk is not found.
3446 * @param aHardDisk Where to store the found hard disk object (can be NULL).
3447 *
3448 * @return S_OK, E_INVALIDARG or VBOX_E_OBJECT_NOT_FOUND when not found.
3449 *
3450 * @note Locks the media tree for reading.
3451 */
3452HRESULT VirtualBox::i_findHardDiskByLocation(const Utf8Str &strLocation,
3453 bool aSetError,
3454 ComObjPtr<Medium> *aHardDisk /*= NULL*/)
3455{
3456 AssertReturn(!strLocation.isEmpty(), E_INVALIDARG);
3457
3458 // we use the hard disks map, but it is protected by the
3459 // hard disk _list_ lock handle
3460 AutoReadLock alock(m->allHardDisks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
3461
3462 for (HardDiskMap::const_iterator it = m->mapHardDisks.begin();
3463 it != m->mapHardDisks.end();
3464 ++it)
3465 {
3466 const ComObjPtr<Medium> &pHD = (*it).second;
3467
3468 AutoCaller autoCaller(pHD);
3469 if (FAILED(autoCaller.rc())) return autoCaller.rc();
3470 AutoWriteLock mlock(pHD COMMA_LOCKVAL_SRC_POS);
3471
3472 Utf8Str strLocationFull = pHD->i_getLocationFull();
3473
3474 if (0 == RTPathCompare(strLocationFull.c_str(), strLocation.c_str()))
3475 {
3476 if (aHardDisk)
3477 *aHardDisk = pHD;
3478 return S_OK;
3479 }
3480 }
3481
3482 if (aSetError)
3483 return setError(VBOX_E_OBJECT_NOT_FOUND,
3484 tr("Could not find an open hard disk with location '%s'"),
3485 strLocation.c_str());
3486
3487 return VBOX_E_OBJECT_NOT_FOUND;
3488}
3489
3490/**
3491 * Searches for a Medium object with the given ID or location in the list of
3492 * registered DVD or floppy images, depending on the @a mediumType argument.
3493 * If both ID and file path are specified, the first object that matches either
3494 * of them (not necessarily both) is returned.
3495 *
3496 * @param mediumType Must be either DeviceType_DVD or DeviceType_Floppy.
3497 * @param aId ID of the image file (unused when NULL).
3498 * @param aLocation Full path to the image file (unused when NULL).
3499 * @param aSetError If @c true, the appropriate error info is set in case when
3500 * the image is not found.
3501 * @param aImage Where to store the found image object (can be NULL).
3502 *
3503 * @return S_OK when found or E_INVALIDARG or VBOX_E_OBJECT_NOT_FOUND when not found.
3504 *
3505 * @note Locks the media tree for reading.
3506 */
3507HRESULT VirtualBox::i_findDVDOrFloppyImage(DeviceType_T mediumType,
3508 const Guid *aId,
3509 const Utf8Str &aLocation,
3510 bool aSetError,
3511 ComObjPtr<Medium> *aImage /* = NULL */)
3512{
3513 AssertReturn(aId || !aLocation.isEmpty(), E_INVALIDARG);
3514
3515 Utf8Str location;
3516 if (!aLocation.isEmpty())
3517 {
3518 int vrc = i_calculateFullPath(aLocation, location);
3519 if (RT_FAILURE(vrc))
3520 return setError(VBOX_E_FILE_ERROR,
3521 tr("Invalid image file location '%s' (%Rrc)"),
3522 aLocation.c_str(),
3523 vrc);
3524 }
3525
3526 MediaOList *pMediaList;
3527
3528 switch (mediumType)
3529 {
3530 case DeviceType_DVD:
3531 pMediaList = &m->allDVDImages;
3532 break;
3533
3534 case DeviceType_Floppy:
3535 pMediaList = &m->allFloppyImages;
3536 break;
3537
3538 default:
3539 return E_INVALIDARG;
3540 }
3541
3542 AutoReadLock alock(pMediaList->getLockHandle() COMMA_LOCKVAL_SRC_POS);
3543
3544 bool found = false;
3545
3546 for (MediaList::const_iterator it = pMediaList->begin();
3547 it != pMediaList->end();
3548 ++it)
3549 {
3550 // no AutoCaller, registered image life time is bound to this
3551 Medium *pMedium = *it;
3552 AutoReadLock imageLock(pMedium COMMA_LOCKVAL_SRC_POS);
3553 const Utf8Str &strLocationFull = pMedium->i_getLocationFull();
3554
3555 found = ( aId
3556 && pMedium->i_getId() == *aId)
3557 || ( !aLocation.isEmpty()
3558 && RTPathCompare(location.c_str(),
3559 strLocationFull.c_str()) == 0);
3560 if (found)
3561 {
3562 if (pMedium->i_getDeviceType() != mediumType)
3563 {
3564 if (mediumType == DeviceType_DVD)
3565 return setError(E_INVALIDARG,
3566 "Cannot mount DVD medium '%s' as floppy", strLocationFull.c_str());
3567 else
3568 return setError(E_INVALIDARG,
3569 "Cannot mount floppy medium '%s' as DVD", strLocationFull.c_str());
3570 }
3571
3572 if (aImage)
3573 *aImage = pMedium;
3574 break;
3575 }
3576 }
3577
3578 HRESULT rc = found ? S_OK : VBOX_E_OBJECT_NOT_FOUND;
3579
3580 if (aSetError && !found)
3581 {
3582 if (aId)
3583 setError(rc,
3584 tr("Could not find an image file with UUID {%RTuuid} in the media registry ('%s')"),
3585 aId->raw(),
3586 m->strSettingsFilePath.c_str());
3587 else
3588 setError(rc,
3589 tr("Could not find an image file with location '%s' in the media registry ('%s')"),
3590 aLocation.c_str(),
3591 m->strSettingsFilePath.c_str());
3592 }
3593
3594 return rc;
3595}
3596
3597/**
3598 * Searches for an IMedium object that represents the given UUID.
3599 *
3600 * If the UUID is empty (indicating an empty drive), this sets pMedium
3601 * to NULL and returns S_OK.
3602 *
3603 * If the UUID refers to a host drive of the given device type, this
3604 * sets pMedium to the object from the list in IHost and returns S_OK.
3605 *
3606 * If the UUID is an image file, this sets pMedium to the object that
3607 * findDVDOrFloppyImage() returned.
3608 *
3609 * If none of the above apply, this returns VBOX_E_OBJECT_NOT_FOUND.
3610 *
3611 * @param mediumType Must be DeviceType_DVD or DeviceType_Floppy.
3612 * @param uuid UUID to search for; must refer to a host drive or an image file or be null.
3613 * @param fRefresh Whether to refresh the list of host drives in IHost (see Host::getDrives())
3614 * @param aSetError
3615 * @param pMedium out: IMedium object found.
3616 * @return
3617 */
3618HRESULT VirtualBox::i_findRemoveableMedium(DeviceType_T mediumType,
3619 const Guid &uuid,
3620 bool fRefresh,
3621 bool aSetError,
3622 ComObjPtr<Medium> &pMedium)
3623{
3624 if (uuid.isZero())
3625 {
3626 // that's easy
3627 pMedium.setNull();
3628 return S_OK;
3629 }
3630 else if (!uuid.isValid())
3631 {
3632 /* handling of case invalid GUID */
3633 return setError(VBOX_E_OBJECT_NOT_FOUND,
3634 tr("Guid '%s' is invalid"),
3635 uuid.toString().c_str());
3636 }
3637
3638 // first search for host drive with that UUID
3639 HRESULT rc = m->pHost->i_findHostDriveById(mediumType,
3640 uuid,
3641 fRefresh,
3642 pMedium);
3643 if (rc == VBOX_E_OBJECT_NOT_FOUND)
3644 // then search for an image with that UUID
3645 rc = i_findDVDOrFloppyImage(mediumType, &uuid, Utf8Str::Empty, aSetError, &pMedium);
3646
3647 return rc;
3648}
3649
3650/* Look for a GuestOSType object */
3651HRESULT VirtualBox::i_findGuestOSType(const Utf8Str &strOSType,
3652 ComObjPtr<GuestOSType> &guestOSType)
3653{
3654 guestOSType.setNull();
3655
3656 AssertMsg(m->allGuestOSTypes.size() != 0,
3657 ("Guest OS types array must be filled"));
3658
3659 AutoReadLock alock(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
3660 for (GuestOSTypesOList::const_iterator it = m->allGuestOSTypes.begin();
3661 it != m->allGuestOSTypes.end();
3662 ++it)
3663 {
3664 const Utf8Str &typeId = (*it)->i_id();
3665 AssertMsg(!typeId.isEmpty(), ("ID must not be NULL"));
3666 if (strOSType.compare(typeId, Utf8Str::CaseInsensitive) == 0)
3667 {
3668 guestOSType = *it;
3669 return S_OK;
3670 }
3671 }
3672
3673 return setError(VBOX_E_OBJECT_NOT_FOUND,
3674 tr("'%s' is not a valid Guest OS type"),
3675 strOSType.c_str());
3676}
3677
3678/**
3679 * Returns the constant pseudo-machine UUID that is used to identify the
3680 * global media registry.
3681 *
3682 * Starting with VirtualBox 4.0 each medium remembers in its instance data
3683 * in which media registry it is saved (if any): this can either be a machine
3684 * UUID, if it's in a per-machine media registry, or this global ID.
3685 *
3686 * This UUID is only used to identify the VirtualBox object while VirtualBox
3687 * is running. It is a compile-time constant and not saved anywhere.
3688 *
3689 * @return
3690 */
3691const Guid& VirtualBox::i_getGlobalRegistryId() const
3692{
3693 return m->uuidMediaRegistry;
3694}
3695
3696const ComObjPtr<Host>& VirtualBox::i_host() const
3697{
3698 return m->pHost;
3699}
3700
3701SystemProperties* VirtualBox::i_getSystemProperties() const
3702{
3703 return m->pSystemProperties;
3704}
3705
3706#ifdef VBOX_WITH_EXTPACK
3707/**
3708 * Getter that SystemProperties and others can use to talk to the extension
3709 * pack manager.
3710 */
3711ExtPackManager* VirtualBox::i_getExtPackManager() const
3712{
3713 return m->ptrExtPackManager;
3714}
3715#endif
3716
3717/**
3718 * Getter that machines can talk to the autostart database.
3719 */
3720AutostartDb* VirtualBox::i_getAutostartDb() const
3721{
3722 return m->pAutostartDb;
3723}
3724
3725#ifdef VBOX_WITH_RESOURCE_USAGE_API
3726const ComObjPtr<PerformanceCollector>& VirtualBox::i_performanceCollector() const
3727{
3728 return m->pPerformanceCollector;
3729}
3730#endif /* VBOX_WITH_RESOURCE_USAGE_API */
3731
3732/**
3733 * Returns the default machine folder from the system properties
3734 * with proper locking.
3735 * @return
3736 */
3737void VirtualBox::i_getDefaultMachineFolder(Utf8Str &str) const
3738{
3739 AutoReadLock propsLock(m->pSystemProperties COMMA_LOCKVAL_SRC_POS);
3740 str = m->pSystemProperties->m->strDefaultMachineFolder;
3741}
3742
3743/**
3744 * Returns the default hard disk format from the system properties
3745 * with proper locking.
3746 * @return
3747 */
3748void VirtualBox::i_getDefaultHardDiskFormat(Utf8Str &str) const
3749{
3750 AutoReadLock propsLock(m->pSystemProperties COMMA_LOCKVAL_SRC_POS);
3751 str = m->pSystemProperties->m->strDefaultHardDiskFormat;
3752}
3753
3754const Utf8Str& VirtualBox::i_homeDir() const
3755{
3756 return m->strHomeDir;
3757}
3758
3759/**
3760 * Calculates the absolute path of the given path taking the VirtualBox home
3761 * directory as the current directory.
3762 *
3763 * @param strPath Path to calculate the absolute path for.
3764 * @param aResult Where to put the result (used only on success, can be the
3765 * same Utf8Str instance as passed in @a aPath).
3766 * @return IPRT result.
3767 *
3768 * @note Doesn't lock any object.
3769 */
3770int VirtualBox::i_calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult)
3771{
3772 AutoCaller autoCaller(this);
3773 AssertComRCReturn(autoCaller.rc(), VERR_GENERAL_FAILURE);
3774
3775 /* no need to lock since mHomeDir is const */
3776
3777 char folder[RTPATH_MAX];
3778 int vrc = RTPathAbsEx(m->strHomeDir.c_str(),
3779 strPath.c_str(),
3780 folder,
3781 sizeof(folder));
3782 if (RT_SUCCESS(vrc))
3783 aResult = folder;
3784
3785 return vrc;
3786}
3787
3788/**
3789 * Copies strSource to strTarget, making it relative to the VirtualBox config folder
3790 * if it is a subdirectory thereof, or simply copying it otherwise.
3791 *
3792 * @param strSource Path to evalue and copy.
3793 * @param strTarget Buffer to receive target path.
3794 */
3795void VirtualBox::i_copyPathRelativeToConfig(const Utf8Str &strSource,
3796 Utf8Str &strTarget)
3797{
3798 AutoCaller autoCaller(this);
3799 AssertComRCReturnVoid(autoCaller.rc());
3800
3801 // no need to lock since mHomeDir is const
3802
3803 // use strTarget as a temporary buffer to hold the machine settings dir
3804 strTarget = m->strHomeDir;
3805 if (RTPathStartsWith(strSource.c_str(), strTarget.c_str()))
3806 // is relative: then append what's left
3807 strTarget.append(strSource.c_str() + strTarget.length()); // include '/'
3808 else
3809 // is not relative: then overwrite
3810 strTarget = strSource;
3811}
3812
3813// private methods
3814/////////////////////////////////////////////////////////////////////////////
3815
3816/**
3817 * Checks if there is a hard disk, DVD or floppy image with the given ID or
3818 * location already registered.
3819 *
3820 * On return, sets @a aConflict to the string describing the conflicting medium,
3821 * or sets it to @c Null if no conflicting media is found. Returns S_OK in
3822 * either case. A failure is unexpected.
3823 *
3824 * @param aId UUID to check.
3825 * @param aLocation Location to check.
3826 * @param aConflict Where to return parameters of the conflicting medium.
3827 * @param ppMedium Medium reference in case this is simply a duplicate.
3828 *
3829 * @note Locks the media tree and media objects for reading.
3830 */
3831HRESULT VirtualBox::i_checkMediaForConflicts(const Guid &aId,
3832 const Utf8Str &aLocation,
3833 Utf8Str &aConflict,
3834 ComObjPtr<Medium> *ppMedium)
3835{
3836 AssertReturn(!aId.isZero() && !aLocation.isEmpty(), E_FAIL);
3837 AssertReturn(ppMedium, E_INVALIDARG);
3838
3839 aConflict.setNull();
3840 ppMedium->setNull();
3841
3842 AutoReadLock alock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
3843
3844 HRESULT rc = S_OK;
3845
3846 ComObjPtr<Medium> pMediumFound;
3847 const char *pcszType = NULL;
3848
3849 if (aId.isValid() && !aId.isZero())
3850 rc = i_findHardDiskById(aId, false /* aSetError */, &pMediumFound);
3851 if (FAILED(rc) && !aLocation.isEmpty())
3852 rc = i_findHardDiskByLocation(aLocation, false /* aSetError */, &pMediumFound);
3853 if (SUCCEEDED(rc))
3854 pcszType = tr("hard disk");
3855
3856 if (!pcszType)
3857 {
3858 rc = i_findDVDOrFloppyImage(DeviceType_DVD, &aId, aLocation, false /* aSetError */, &pMediumFound);
3859 if (SUCCEEDED(rc))
3860 pcszType = tr("CD/DVD image");
3861 }
3862
3863 if (!pcszType)
3864 {
3865 rc = i_findDVDOrFloppyImage(DeviceType_Floppy, &aId, aLocation, false /* aSetError */, &pMediumFound);
3866 if (SUCCEEDED(rc))
3867 pcszType = tr("floppy image");
3868 }
3869
3870 if (pcszType && pMediumFound)
3871 {
3872 /* Note: no AutoCaller since bound to this */
3873 AutoReadLock mlock(pMediumFound COMMA_LOCKVAL_SRC_POS);
3874
3875 Utf8Str strLocFound = pMediumFound->i_getLocationFull();
3876 Guid idFound = pMediumFound->i_getId();
3877
3878 if ( (RTPathCompare(strLocFound.c_str(), aLocation.c_str()) == 0)
3879 && (idFound == aId)
3880 )
3881 *ppMedium = pMediumFound;
3882
3883 aConflict = Utf8StrFmt(tr("%s '%s' with UUID {%RTuuid}"),
3884 pcszType,
3885 strLocFound.c_str(),
3886 idFound.raw());
3887 }
3888
3889 return S_OK;
3890}
3891
3892/**
3893 * Checks whether the given UUID is already in use by one medium for the
3894 * given device type.
3895 *
3896 * @returns true if the UUID is already in use
3897 * fale otherwise
3898 * @param aId The UUID to check.
3899 * @param deviceType The device type the UUID is going to be checked for
3900 * conflicts.
3901 */
3902bool VirtualBox::i_isMediaUuidInUse(const Guid &aId, DeviceType_T deviceType)
3903{
3904 /* A zero UUID is invalid here, always claim that it is already used. */
3905 AssertReturn(!aId.isZero(), true);
3906
3907 AutoReadLock alock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
3908
3909 HRESULT rc = S_OK;
3910 bool fInUse = false;
3911
3912 ComObjPtr<Medium> pMediumFound;
3913
3914 switch (deviceType)
3915 {
3916 case DeviceType_HardDisk:
3917 rc = i_findHardDiskById(aId, false /* aSetError */, &pMediumFound);
3918 break;
3919 case DeviceType_DVD:
3920 rc = i_findDVDOrFloppyImage(DeviceType_DVD, &aId, Utf8Str::Empty, false /* aSetError */, &pMediumFound);
3921 break;
3922 case DeviceType_Floppy:
3923 rc = i_findDVDOrFloppyImage(DeviceType_Floppy, &aId, Utf8Str::Empty, false /* aSetError */, &pMediumFound);
3924 break;
3925 default:
3926 AssertMsgFailed(("Invalid device type %d\n", deviceType));
3927 }
3928
3929 if (SUCCEEDED(rc) && pMediumFound)
3930 fInUse = true;
3931
3932 return fInUse;
3933}
3934
3935/**
3936 * Called from Machine::prepareSaveSettings() when it has detected
3937 * that a machine has been renamed. Such renames will require
3938 * updating the global media registry during the
3939 * VirtualBox::saveSettings() that follows later.
3940*
3941 * When a machine is renamed, there may well be media (in particular,
3942 * diff images for snapshots) in the global registry that will need
3943 * to have their paths updated. Before 3.2, Machine::saveSettings
3944 * used to call VirtualBox::saveSettings implicitly, which was both
3945 * unintuitive and caused locking order problems. Now, we remember
3946 * such pending name changes with this method so that
3947 * VirtualBox::saveSettings() can process them properly.
3948 */
3949void VirtualBox::i_rememberMachineNameChangeForMedia(const Utf8Str &strOldConfigDir,
3950 const Utf8Str &strNewConfigDir)
3951{
3952 AutoWriteLock mediaLock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
3953
3954 Data::PendingMachineRename pmr;
3955 pmr.strConfigDirOld = strOldConfigDir;
3956 pmr.strConfigDirNew = strNewConfigDir;
3957 m->llPendingMachineRenames.push_back(pmr);
3958}
3959
3960static DECLCALLBACK(int) fntSaveMediaRegistries(void *pvUser);
3961
3962class SaveMediaRegistriesDesc : public ThreadTask
3963{
3964
3965public:
3966 SaveMediaRegistriesDesc()
3967 {
3968 m_strTaskName = "SaveMediaReg";
3969 }
3970 virtual ~SaveMediaRegistriesDesc(void) { }
3971
3972private:
3973 void handler()
3974 {
3975 try
3976 {
3977 fntSaveMediaRegistries(this);
3978 }
3979 catch(...)
3980 {
3981 LogRel(("Exception in the function fntSaveMediaRegistries()\n"));
3982 }
3983 }
3984
3985 MediaList llMedia;
3986 ComObjPtr<VirtualBox> pVirtualBox;
3987
3988 friend DECLCALLBACK(int) fntSaveMediaRegistries(void *pvUser);
3989 friend void VirtualBox::i_saveMediaRegistry(settings::MediaRegistry &mediaRegistry,
3990 const Guid &uuidRegistry,
3991 const Utf8Str &strMachineFolder);
3992};
3993
3994DECLCALLBACK(int) fntSaveMediaRegistries(void *pvUser)
3995{
3996 SaveMediaRegistriesDesc *pDesc = (SaveMediaRegistriesDesc *)pvUser;
3997 if (!pDesc)
3998 {
3999 LogRelFunc(("Thread for saving media registries lacks parameters\n"));
4000 return VERR_INVALID_PARAMETER;
4001 }
4002
4003 for (MediaList::const_iterator it = pDesc->llMedia.begin();
4004 it != pDesc->llMedia.end();
4005 ++it)
4006 {
4007 Medium *pMedium = *it;
4008 pMedium->i_markRegistriesModified();
4009 }
4010
4011 pDesc->pVirtualBox->i_saveModifiedRegistries();
4012
4013 pDesc->llMedia.clear();
4014 pDesc->pVirtualBox.setNull();
4015
4016 return VINF_SUCCESS;
4017}
4018
4019/**
4020 * Goes through all known media (hard disks, floppies and DVDs) and saves
4021 * those into the given settings::MediaRegistry structures whose registry
4022 * ID match the given UUID.
4023 *
4024 * Before actually writing to the structures, all media paths (not just the
4025 * ones for the given registry) are updated if machines have been renamed
4026 * since the last call.
4027 *
4028 * This gets called from two contexts:
4029 *
4030 * -- VirtualBox::saveSettings() with the UUID of the global registry
4031 * (VirtualBox::Data.uuidRegistry); this will save those media
4032 * which had been loaded from the global registry or have been
4033 * attached to a "legacy" machine which can't save its own registry;
4034 *
4035 * -- Machine::saveSettings() with the UUID of a machine, if a medium
4036 * has been attached to a machine created with VirtualBox 4.0 or later.
4037 *
4038 * Media which have only been temporarily opened without having been
4039 * attached to a machine have a NULL registry UUID and therefore don't
4040 * get saved.
4041 *
4042 * This locks the media tree. Throws HRESULT on errors!
4043 *
4044 * @param mediaRegistry Settings structure to fill.
4045 * @param uuidRegistry The UUID of the media registry; either a machine UUID
4046 * (if machine registry) or the UUID of the global registry.
4047 * @param strMachineFolder The machine folder for relative paths, if machine registry, or an empty string otherwise.
4048 */
4049void VirtualBox::i_saveMediaRegistry(settings::MediaRegistry &mediaRegistry,
4050 const Guid &uuidRegistry,
4051 const Utf8Str &strMachineFolder)
4052{
4053 // lock all media for the following; use a write lock because we're
4054 // modifying the PendingMachineRenamesList, which is protected by this
4055 AutoWriteLock mediaLock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
4056
4057 // if a machine was renamed, then we'll need to refresh media paths
4058 if (m->llPendingMachineRenames.size())
4059 {
4060 // make a single list from the three media lists so we don't need three loops
4061 MediaList llAllMedia;
4062 // with hard disks, we must use the map, not the list, because the list only has base images
4063 for (HardDiskMap::iterator it = m->mapHardDisks.begin(); it != m->mapHardDisks.end(); ++it)
4064 llAllMedia.push_back(it->second);
4065 for (MediaList::iterator it = m->allDVDImages.begin(); it != m->allDVDImages.end(); ++it)
4066 llAllMedia.push_back(*it);
4067 for (MediaList::iterator it = m->allFloppyImages.begin(); it != m->allFloppyImages.end(); ++it)
4068 llAllMedia.push_back(*it);
4069
4070 SaveMediaRegistriesDesc *pDesc = new SaveMediaRegistriesDesc();
4071 for (MediaList::iterator it = llAllMedia.begin();
4072 it != llAllMedia.end();
4073 ++it)
4074 {
4075 Medium *pMedium = *it;
4076 for (Data::PendingMachineRenamesList::iterator it2 = m->llPendingMachineRenames.begin();
4077 it2 != m->llPendingMachineRenames.end();
4078 ++it2)
4079 {
4080 const Data::PendingMachineRename &pmr = *it2;
4081 HRESULT rc = pMedium->i_updatePath(pmr.strConfigDirOld,
4082 pmr.strConfigDirNew);
4083 if (SUCCEEDED(rc))
4084 {
4085 // Remember which medium objects has been changed,
4086 // to trigger saving their registries later.
4087 pDesc->llMedia.push_back(pMedium);
4088 } else if (rc == VBOX_E_FILE_ERROR)
4089 /* nothing */;
4090 else
4091 AssertComRC(rc);
4092 }
4093 }
4094 // done, don't do it again until we have more machine renames
4095 m->llPendingMachineRenames.clear();
4096
4097 if (pDesc->llMedia.size())
4098 {
4099 // Handle the media registry saving in a separate thread, to
4100 // avoid giant locking problems and passing up the list many
4101 // levels up to whoever triggered saveSettings, as there are
4102 // lots of places which would need to handle saving more settings.
4103 pDesc->pVirtualBox = this;
4104 HRESULT hr = S_OK;
4105 try
4106 {
4107 //the function createThread() takes ownership of pDesc
4108 //so there is no need to use delete operator for pDesc
4109 //after calling this function
4110 hr = pDesc->createThread();
4111 }
4112 catch(...)
4113 {
4114 hr = E_FAIL;
4115 }
4116
4117 if (FAILED(hr))
4118 {
4119 // failure means that settings aren't saved, but there isn't
4120 // much we can do besides avoiding memory leaks
4121 LogRelFunc(("Failed to create thread for saving media registries (%Rhr)\n", hr));
4122 }
4123 }
4124 else
4125 delete pDesc;
4126 }
4127
4128 struct {
4129 MediaOList &llSource;
4130 settings::MediaList &llTarget;
4131 } s[] =
4132 {
4133 // hard disks
4134 { m->allHardDisks, mediaRegistry.llHardDisks },
4135 // CD/DVD images
4136 { m->allDVDImages, mediaRegistry.llDvdImages },
4137 // floppy images
4138 { m->allFloppyImages, mediaRegistry.llFloppyImages }
4139 };
4140
4141 HRESULT rc;
4142
4143 for (size_t i = 0; i < RT_ELEMENTS(s); ++i)
4144 {
4145 MediaOList &llSource = s[i].llSource;
4146 settings::MediaList &llTarget = s[i].llTarget;
4147 llTarget.clear();
4148 for (MediaList::const_iterator it = llSource.begin();
4149 it != llSource.end();
4150 ++it)
4151 {
4152 Medium *pMedium = *it;
4153 AutoCaller autoCaller(pMedium);
4154 if (FAILED(autoCaller.rc())) throw autoCaller.rc();
4155 AutoReadLock mlock(pMedium COMMA_LOCKVAL_SRC_POS);
4156
4157 if (pMedium->i_isInRegistry(uuidRegistry))
4158 {
4159 llTarget.push_back(settings::Medium::Empty);
4160 rc = pMedium->i_saveSettings(llTarget.back(), strMachineFolder); // this recurses into child hard disks
4161 if (FAILED(rc))
4162 {
4163 llTarget.pop_back();
4164 throw rc;
4165 }
4166 }
4167 }
4168 }
4169}
4170
4171/**
4172 * Helper function which actually writes out VirtualBox.xml, the main configuration file.
4173 * Gets called from the public VirtualBox::SaveSettings() as well as from various other
4174 * places internally when settings need saving.
4175 *
4176 * @note Caller must have locked the VirtualBox object for writing and must not hold any
4177 * other locks since this locks all kinds of member objects and trees temporarily,
4178 * which could cause conflicts.
4179 */
4180HRESULT VirtualBox::i_saveSettings()
4181{
4182 AutoCaller autoCaller(this);
4183 AssertComRCReturnRC(autoCaller.rc());
4184
4185 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
4186 AssertReturn(!m->strSettingsFilePath.isEmpty(), E_FAIL);
4187
4188 i_unmarkRegistryModified(i_getGlobalRegistryId());
4189
4190 HRESULT rc = S_OK;
4191
4192 try
4193 {
4194 // machines
4195 m->pMainConfigFile->llMachines.clear();
4196 {
4197 AutoReadLock machinesLock(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
4198 for (MachinesOList::iterator it = m->allMachines.begin();
4199 it != m->allMachines.end();
4200 ++it)
4201 {
4202 Machine *pMachine = *it;
4203 // save actual machine registry entry
4204 settings::MachineRegistryEntry mre;
4205 rc = pMachine->i_saveRegistryEntry(mre);
4206 m->pMainConfigFile->llMachines.push_back(mre);
4207 }
4208 }
4209
4210 i_saveMediaRegistry(m->pMainConfigFile->mediaRegistry,
4211 m->uuidMediaRegistry, // global media registry ID
4212 Utf8Str::Empty); // strMachineFolder
4213
4214 m->pMainConfigFile->llDhcpServers.clear();
4215 {
4216 AutoReadLock dhcpLock(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
4217 for (DHCPServersOList::const_iterator it = m->allDHCPServers.begin();
4218 it != m->allDHCPServers.end();
4219 ++it)
4220 {
4221 settings::DHCPServer d;
4222 rc = (*it)->i_saveSettings(d);
4223 if (FAILED(rc)) throw rc;
4224 m->pMainConfigFile->llDhcpServers.push_back(d);
4225 }
4226 }
4227
4228#ifdef VBOX_WITH_NAT_SERVICE
4229 /* Saving NAT Network configuration */
4230 m->pMainConfigFile->llNATNetworks.clear();
4231 {
4232 AutoReadLock natNetworkLock(m->allNATNetworks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
4233 for (NATNetworksOList::const_iterator it = m->allNATNetworks.begin();
4234 it != m->allNATNetworks.end();
4235 ++it)
4236 {
4237 settings::NATNetwork n;
4238 rc = (*it)->i_saveSettings(n);
4239 if (FAILED(rc)) throw rc;
4240 m->pMainConfigFile->llNATNetworks.push_back(n);
4241 }
4242 }
4243#endif
4244
4245 // leave extra data alone, it's still in the config file
4246
4247 // host data (USB filters)
4248 rc = m->pHost->i_saveSettings(m->pMainConfigFile->host);
4249 if (FAILED(rc)) throw rc;
4250
4251 rc = m->pSystemProperties->i_saveSettings(m->pMainConfigFile->systemProperties);
4252 if (FAILED(rc)) throw rc;
4253
4254 // and write out the XML, still under the lock
4255 m->pMainConfigFile->write(m->strSettingsFilePath);
4256 }
4257 catch (HRESULT err)
4258 {
4259 /* we assume that error info is set by the thrower */
4260 rc = err;
4261 }
4262 catch (...)
4263 {
4264 rc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
4265 }
4266
4267 return rc;
4268}
4269
4270/**
4271 * Helper to register the machine.
4272 *
4273 * When called during VirtualBox startup, adds the given machine to the
4274 * collection of registered machines. Otherwise tries to mark the machine
4275 * as registered, and, if succeeded, adds it to the collection and
4276 * saves global settings.
4277 *
4278 * @note The caller must have added itself as a caller of the @a aMachine
4279 * object if calls this method not on VirtualBox startup.
4280 *
4281 * @param aMachine machine to register
4282 *
4283 * @note Locks objects!
4284 */
4285HRESULT VirtualBox::i_registerMachine(Machine *aMachine)
4286{
4287 ComAssertRet(aMachine, E_INVALIDARG);
4288
4289 AutoCaller autoCaller(this);
4290 if (FAILED(autoCaller.rc())) return autoCaller.rc();
4291
4292 HRESULT rc = S_OK;
4293
4294 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4295
4296 {
4297 ComObjPtr<Machine> pMachine;
4298 rc = i_findMachine(aMachine->i_getId(),
4299 true /* fPermitInaccessible */,
4300 false /* aDoSetError */,
4301 &pMachine);
4302 if (SUCCEEDED(rc))
4303 {
4304 /* sanity */
4305 AutoLimitedCaller machCaller(pMachine);
4306 AssertComRC(machCaller.rc());
4307
4308 return setError(E_INVALIDARG,
4309 tr("Registered machine with UUID {%RTuuid} ('%s') already exists"),
4310 aMachine->i_getId().raw(),
4311 pMachine->i_getSettingsFileFull().c_str());
4312 }
4313
4314 ComAssertRet(rc == VBOX_E_OBJECT_NOT_FOUND, rc);
4315 rc = S_OK;
4316 }
4317
4318 if (getObjectState().getState() != ObjectState::InInit)
4319 {
4320 rc = aMachine->i_prepareRegister();
4321 if (FAILED(rc)) return rc;
4322 }
4323
4324 /* add to the collection of registered machines */
4325 m->allMachines.addChild(aMachine);
4326
4327 if (getObjectState().getState() != ObjectState::InInit)
4328 rc = i_saveSettings();
4329
4330 return rc;
4331}
4332
4333/**
4334 * Remembers the given medium object by storing it in either the global
4335 * medium registry or a machine one.
4336 *
4337 * @note Caller must hold the media tree lock for writing; in addition, this
4338 * locks @a pMedium for reading
4339 *
4340 * @param pMedium Medium object to remember.
4341 * @param ppMedium Actually stored medium object. Can be different if due
4342 * to an unavoidable race there was a duplicate Medium object
4343 * created.
4344 * @param mediaTreeLock Reference to the AutoWriteLock holding the media tree
4345 * lock, necessary to release it in the right spot.
4346 * @return
4347 */
4348HRESULT VirtualBox::i_registerMedium(const ComObjPtr<Medium> &pMedium,
4349 ComObjPtr<Medium> *ppMedium,
4350 AutoWriteLock &mediaTreeLock)
4351{
4352 AssertReturn(pMedium != NULL, E_INVALIDARG);
4353 AssertReturn(ppMedium != NULL, E_INVALIDARG);
4354
4355 // caller must hold the media tree write lock
4356 Assert(i_getMediaTreeLockHandle().isWriteLockOnCurrentThread());
4357
4358 AutoCaller autoCaller(this);
4359 AssertComRCReturnRC(autoCaller.rc());
4360
4361 AutoCaller mediumCaller(pMedium);
4362 AssertComRCReturnRC(mediumCaller.rc());
4363
4364 const char *pszDevType = NULL;
4365 ObjectsList<Medium> *pall = NULL;
4366 DeviceType_T devType;
4367 {
4368 AutoReadLock mediumLock(pMedium COMMA_LOCKVAL_SRC_POS);
4369 devType = pMedium->i_getDeviceType();
4370 }
4371 switch (devType)
4372 {
4373 case DeviceType_HardDisk:
4374 pall = &m->allHardDisks;
4375 pszDevType = tr("hard disk");
4376 break;
4377 case DeviceType_DVD:
4378 pszDevType = tr("DVD image");
4379 pall = &m->allDVDImages;
4380 break;
4381 case DeviceType_Floppy:
4382 pszDevType = tr("floppy image");
4383 pall = &m->allFloppyImages;
4384 break;
4385 default:
4386 AssertMsgFailedReturn(("invalid device type %d", devType), E_INVALIDARG);
4387 }
4388
4389 Guid id;
4390 Utf8Str strLocationFull;
4391 ComObjPtr<Medium> pParent;
4392 {
4393 AutoReadLock mediumLock(pMedium COMMA_LOCKVAL_SRC_POS);
4394 id = pMedium->i_getId();
4395 strLocationFull = pMedium->i_getLocationFull();
4396 pParent = pMedium->i_getParent();
4397 }
4398
4399 HRESULT rc;
4400
4401 Utf8Str strConflict;
4402 ComObjPtr<Medium> pDupMedium;
4403 rc = i_checkMediaForConflicts(id,
4404 strLocationFull,
4405 strConflict,
4406 &pDupMedium);
4407 if (FAILED(rc)) return rc;
4408
4409 if (pDupMedium.isNull())
4410 {
4411 if (strConflict.length())
4412 return setError(E_INVALIDARG,
4413 tr("Cannot register the %s '%s' {%RTuuid} because a %s already exists"),
4414 pszDevType,
4415 strLocationFull.c_str(),
4416 id.raw(),
4417 strConflict.c_str(),
4418 m->strSettingsFilePath.c_str());
4419
4420 // add to the collection if it is a base medium
4421 if (pParent.isNull())
4422 pall->getList().push_back(pMedium);
4423
4424 // store all hard disks (even differencing images) in the map
4425 if (devType == DeviceType_HardDisk)
4426 m->mapHardDisks[id] = pMedium;
4427
4428 mediumCaller.release();
4429 mediaTreeLock.release();
4430 *ppMedium = pMedium;
4431 }
4432 else
4433 {
4434 // pMedium may be the last reference to the Medium object, and the
4435 // caller may have specified the same ComObjPtr as the output parameter.
4436 // In this case the assignment will uninit the object, and we must not
4437 // have a caller pending.
4438 mediumCaller.release();
4439 // release media tree lock, must not be held at uninit time.
4440 mediaTreeLock.release();
4441 // must not hold the media tree write lock any more
4442 Assert(!i_getMediaTreeLockHandle().isWriteLockOnCurrentThread());
4443 *ppMedium = pDupMedium;
4444 }
4445
4446 // Restore the initial lock state, so that no unexpected lock changes are
4447 // done by this method, which would need adjustments everywhere.
4448 mediaTreeLock.acquire();
4449
4450 return rc;
4451}
4452
4453/**
4454 * Removes the given medium from the respective registry.
4455 *
4456 * @param pMedium Hard disk object to remove.
4457 *
4458 * @note Caller must hold the media tree lock for writing; in addition, this locks @a pMedium for reading
4459 */
4460HRESULT VirtualBox::i_unregisterMedium(Medium *pMedium)
4461{
4462 AssertReturn(pMedium != NULL, E_INVALIDARG);
4463
4464 AutoCaller autoCaller(this);
4465 AssertComRCReturnRC(autoCaller.rc());
4466
4467 AutoCaller mediumCaller(pMedium);
4468 AssertComRCReturnRC(mediumCaller.rc());
4469
4470 // caller must hold the media tree write lock
4471 Assert(i_getMediaTreeLockHandle().isWriteLockOnCurrentThread());
4472
4473 Guid id;
4474 ComObjPtr<Medium> pParent;
4475 DeviceType_T devType;
4476 {
4477 AutoReadLock mediumLock(pMedium COMMA_LOCKVAL_SRC_POS);
4478 id = pMedium->i_getId();
4479 pParent = pMedium->i_getParent();
4480 devType = pMedium->i_getDeviceType();
4481 }
4482
4483 ObjectsList<Medium> *pall = NULL;
4484 switch (devType)
4485 {
4486 case DeviceType_HardDisk:
4487 pall = &m->allHardDisks;
4488 break;
4489 case DeviceType_DVD:
4490 pall = &m->allDVDImages;
4491 break;
4492 case DeviceType_Floppy:
4493 pall = &m->allFloppyImages;
4494 break;
4495 default:
4496 AssertMsgFailedReturn(("invalid device type %d", devType), E_INVALIDARG);
4497 }
4498
4499 // remove from the collection if it is a base medium
4500 if (pParent.isNull())
4501 pall->getList().remove(pMedium);
4502
4503 // remove all hard disks (even differencing images) from map
4504 if (devType == DeviceType_HardDisk)
4505 {
4506 size_t cnt = m->mapHardDisks.erase(id);
4507 Assert(cnt == 1);
4508 NOREF(cnt);
4509 }
4510
4511 return S_OK;
4512}
4513
4514/**
4515 * Little helper called from unregisterMachineMedia() to recursively add media to the given list,
4516 * with children appearing before their parents.
4517 * @param llMedia
4518 * @param pMedium
4519 */
4520void VirtualBox::i_pushMediumToListWithChildren(MediaList &llMedia, Medium *pMedium)
4521{
4522 // recurse first, then add ourselves; this way children end up on the
4523 // list before their parents
4524
4525 const MediaList &llChildren = pMedium->i_getChildren();
4526 for (MediaList::const_iterator it = llChildren.begin();
4527 it != llChildren.end();
4528 ++it)
4529 {
4530 Medium *pChild = *it;
4531 i_pushMediumToListWithChildren(llMedia, pChild);
4532 }
4533
4534 Log(("Pushing medium %RTuuid\n", pMedium->i_getId().raw()));
4535 llMedia.push_back(pMedium);
4536}
4537
4538/**
4539 * Unregisters all Medium objects which belong to the given machine registry.
4540 * Gets called from Machine::uninit() just before the machine object dies
4541 * and must only be called with a machine UUID as the registry ID.
4542 *
4543 * Locks the media tree.
4544 *
4545 * @param uuidMachine Medium registry ID (always a machine UUID)
4546 * @return
4547 */
4548HRESULT VirtualBox::i_unregisterMachineMedia(const Guid &uuidMachine)
4549{
4550 Assert(!uuidMachine.isZero() && uuidMachine.isValid());
4551
4552 LogFlowFuncEnter();
4553
4554 AutoCaller autoCaller(this);
4555 AssertComRCReturnRC(autoCaller.rc());
4556
4557 MediaList llMedia2Close;
4558
4559 {
4560 AutoWriteLock tlock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
4561
4562 for (MediaOList::iterator it = m->allHardDisks.getList().begin();
4563 it != m->allHardDisks.getList().end();
4564 ++it)
4565 {
4566 ComObjPtr<Medium> pMedium = *it;
4567 AutoCaller medCaller(pMedium);
4568 if (FAILED(medCaller.rc())) return medCaller.rc();
4569 AutoReadLock medlock(pMedium COMMA_LOCKVAL_SRC_POS);
4570
4571 if (pMedium->i_isInRegistry(uuidMachine))
4572 // recursively with children first
4573 i_pushMediumToListWithChildren(llMedia2Close, pMedium);
4574 }
4575 }
4576
4577 for (MediaList::iterator it = llMedia2Close.begin();
4578 it != llMedia2Close.end();
4579 ++it)
4580 {
4581 ComObjPtr<Medium> pMedium = *it;
4582 Log(("Closing medium %RTuuid\n", pMedium->i_getId().raw()));
4583 AutoCaller mac(pMedium);
4584 pMedium->i_close(mac);
4585 }
4586
4587 LogFlowFuncLeave();
4588
4589 return S_OK;
4590}
4591
4592/**
4593 * Removes the given machine object from the internal list of registered machines.
4594 * Called from Machine::Unregister().
4595 * @param pMachine
4596 * @param id UUID of the machine. Must be passed by caller because machine may be dead by this time.
4597 * @return
4598 */
4599HRESULT VirtualBox::i_unregisterMachine(Machine *pMachine,
4600 const Guid &id)
4601{
4602 // remove from the collection of registered machines
4603 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4604 m->allMachines.removeChild(pMachine);
4605 // save the global registry
4606 HRESULT rc = i_saveSettings();
4607 alock.release();
4608
4609 /*
4610 * Now go over all known media and checks if they were registered in the
4611 * media registry of the given machine. Each such medium is then moved to
4612 * a different media registry to make sure it doesn't get lost since its
4613 * media registry is about to go away.
4614 *
4615 * This fixes the following use case: Image A.vdi of machine A is also used
4616 * by machine B, but registered in the media registry of machine A. If machine
4617 * A is deleted, A.vdi must be moved to the registry of B, or else B will
4618 * become inaccessible.
4619 */
4620 {
4621 AutoReadLock tlock(i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
4622 // iterate over the list of *base* images
4623 for (MediaOList::iterator it = m->allHardDisks.getList().begin();
4624 it != m->allHardDisks.getList().end();
4625 ++it)
4626 {
4627 ComObjPtr<Medium> &pMedium = *it;
4628 AutoCaller medCaller(pMedium);
4629 if (FAILED(medCaller.rc())) return medCaller.rc();
4630 AutoWriteLock mlock(pMedium COMMA_LOCKVAL_SRC_POS);
4631
4632 if (pMedium->i_removeRegistryRecursive(id))
4633 {
4634 // machine ID was found in base medium's registry list:
4635 // move this base image and all its children to another registry then
4636 // 1) first, find a better registry to add things to
4637 const Guid *puuidBetter = pMedium->i_getAnyMachineBackref();
4638 if (puuidBetter)
4639 {
4640 // 2) better registry found: then use that
4641 pMedium->i_addRegistryRecursive(*puuidBetter);
4642 // 3) and make sure the registry is saved below
4643 mlock.release();
4644 tlock.release();
4645 i_markRegistryModified(*puuidBetter);
4646 tlock.acquire();
4647 mlock.acquire();
4648 }
4649 }
4650 }
4651 }
4652
4653 i_saveModifiedRegistries();
4654
4655 /* fire an event */
4656 i_onMachineRegistered(id, FALSE);
4657
4658 return rc;
4659}
4660
4661/**
4662 * Marks the registry for @a uuid as modified, so that it's saved in a later
4663 * call to saveModifiedRegistries().
4664 *
4665 * @param uuid
4666 */
4667void VirtualBox::i_markRegistryModified(const Guid &uuid)
4668{
4669 if (uuid == i_getGlobalRegistryId())
4670 ASMAtomicIncU64(&m->uRegistryNeedsSaving);
4671 else
4672 {
4673 ComObjPtr<Machine> pMachine;
4674 HRESULT rc = i_findMachine(uuid,
4675 false /* fPermitInaccessible */,
4676 false /* aSetError */,
4677 &pMachine);
4678 if (SUCCEEDED(rc))
4679 {
4680 AutoCaller machineCaller(pMachine);
4681 if (SUCCEEDED(machineCaller.rc()))
4682 ASMAtomicIncU64(&pMachine->uRegistryNeedsSaving);
4683 }
4684 }
4685}
4686
4687/**
4688 * Marks the registry for @a uuid as unmodified, so that it's not saved in
4689 * a later call to saveModifiedRegistries().
4690 *
4691 * @param uuid
4692 */
4693void VirtualBox::i_unmarkRegistryModified(const Guid &uuid)
4694{
4695 uint64_t uOld;
4696 if (uuid == i_getGlobalRegistryId())
4697 {
4698 for (;;)
4699 {
4700 uOld = ASMAtomicReadU64(&m->uRegistryNeedsSaving);
4701 if (!uOld)
4702 break;
4703 if (ASMAtomicCmpXchgU64(&m->uRegistryNeedsSaving, 0, uOld))
4704 break;
4705 ASMNopPause();
4706 }
4707 }
4708 else
4709 {
4710 ComObjPtr<Machine> pMachine;
4711 HRESULT rc = i_findMachine(uuid,
4712 false /* fPermitInaccessible */,
4713 false /* aSetError */,
4714 &pMachine);
4715 if (SUCCEEDED(rc))
4716 {
4717 AutoCaller machineCaller(pMachine);
4718 if (SUCCEEDED(machineCaller.rc()))
4719 {
4720 for (;;)
4721 {
4722 uOld = ASMAtomicReadU64(&pMachine->uRegistryNeedsSaving);
4723 if (!uOld)
4724 break;
4725 if (ASMAtomicCmpXchgU64(&pMachine->uRegistryNeedsSaving, 0, uOld))
4726 break;
4727 ASMNopPause();
4728 }
4729 }
4730 }
4731 }
4732}
4733
4734/**
4735 * Saves all settings files according to the modified flags in the Machine
4736 * objects and in the VirtualBox object.
4737 *
4738 * This locks machines and the VirtualBox object as necessary, so better not
4739 * hold any locks before calling this.
4740 *
4741 * @return
4742 */
4743void VirtualBox::i_saveModifiedRegistries()
4744{
4745 HRESULT rc = S_OK;
4746 bool fNeedsGlobalSettings = false;
4747 uint64_t uOld;
4748
4749 {
4750 AutoReadLock alock(m->allMachines.getLockHandle() COMMA_LOCKVAL_SRC_POS);
4751 for (MachinesOList::iterator it = m->allMachines.begin();
4752 it != m->allMachines.end();
4753 ++it)
4754 {
4755 const ComObjPtr<Machine> &pMachine = *it;
4756
4757 for (;;)
4758 {
4759 uOld = ASMAtomicReadU64(&pMachine->uRegistryNeedsSaving);
4760 if (!uOld)
4761 break;
4762 if (ASMAtomicCmpXchgU64(&pMachine->uRegistryNeedsSaving, 0, uOld))
4763 break;
4764 ASMNopPause();
4765 }
4766 if (uOld)
4767 {
4768 AutoCaller autoCaller(pMachine);
4769 if (FAILED(autoCaller.rc()))
4770 continue;
4771 /* object is already dead, no point in saving settings */
4772 if (getObjectState().getState() != ObjectState::Ready)
4773 continue;
4774 AutoWriteLock mlock(pMachine COMMA_LOCKVAL_SRC_POS);
4775 rc = pMachine->i_saveSettings(&fNeedsGlobalSettings,
4776 Machine::SaveS_Force); // caller said save, so stop arguing
4777 }
4778 }
4779 }
4780
4781 for (;;)
4782 {
4783 uOld = ASMAtomicReadU64(&m->uRegistryNeedsSaving);
4784 if (!uOld)
4785 break;
4786 if (ASMAtomicCmpXchgU64(&m->uRegistryNeedsSaving, 0, uOld))
4787 break;
4788 ASMNopPause();
4789 }
4790 if (uOld || fNeedsGlobalSettings)
4791 {
4792 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4793 rc = i_saveSettings();
4794 }
4795 NOREF(rc); /* XXX */
4796}
4797
4798
4799/* static */
4800const com::Utf8Str &VirtualBox::i_getVersionNormalized()
4801{
4802 return sVersionNormalized;
4803}
4804
4805/**
4806 * Checks if the path to the specified file exists, according to the path
4807 * information present in the file name. Optionally the path is created.
4808 *
4809 * Note that the given file name must contain the full path otherwise the
4810 * extracted relative path will be created based on the current working
4811 * directory which is normally unknown.
4812 *
4813 * @param strFileName Full file name which path is checked/created.
4814 * @param fCreate Flag if the path should be created if it doesn't exist.
4815 *
4816 * @return Extended error information on failure to check/create the path.
4817 */
4818/* static */
4819HRESULT VirtualBox::i_ensureFilePathExists(const Utf8Str &strFileName, bool fCreate)
4820{
4821 Utf8Str strDir(strFileName);
4822 strDir.stripFilename();
4823 if (!RTDirExists(strDir.c_str()))
4824 {
4825 if (fCreate)
4826 {
4827 int vrc = RTDirCreateFullPath(strDir.c_str(), 0700);
4828 if (RT_FAILURE(vrc))
4829 return i_setErrorStatic(VBOX_E_IPRT_ERROR,
4830 Utf8StrFmt(tr("Could not create the directory '%s' (%Rrc)"),
4831 strDir.c_str(),
4832 vrc));
4833 }
4834 else
4835 return i_setErrorStatic(VBOX_E_IPRT_ERROR,
4836 Utf8StrFmt(tr("Directory '%s' does not exist"),
4837 strDir.c_str()));
4838 }
4839
4840 return S_OK;
4841}
4842
4843const Utf8Str& VirtualBox::i_settingsFilePath()
4844{
4845 return m->strSettingsFilePath;
4846}
4847
4848/**
4849 * Returns the lock handle which protects the machines list. As opposed
4850 * to version 3.1 and earlier, these lists are no longer protected by the
4851 * VirtualBox lock, but by this more specialized lock. Mind the locking
4852 * order: always request this lock after the VirtualBox object lock but
4853 * before the locks of any machine object. See AutoLock.h.
4854 */
4855RWLockHandle& VirtualBox::i_getMachinesListLockHandle()
4856{
4857 return m->lockMachines;
4858}
4859
4860/**
4861 * Returns the lock handle which protects the media trees (hard disks,
4862 * DVDs, floppies). As opposed to version 3.1 and earlier, these lists
4863 * are no longer protected by the VirtualBox lock, but by this more
4864 * specialized lock. Mind the locking order: always request this lock
4865 * after the VirtualBox object lock but before the locks of the media
4866 * objects contained in these lists. See AutoLock.h.
4867 */
4868RWLockHandle& VirtualBox::i_getMediaTreeLockHandle()
4869{
4870 return m->lockMedia;
4871}
4872
4873/**
4874 * Thread function that handles custom events posted using #i_postEvent().
4875 */
4876// static
4877DECLCALLBACK(int) VirtualBox::AsyncEventHandler(RTTHREAD thread, void *pvUser)
4878{
4879 LogFlowFuncEnter();
4880
4881 AssertReturn(pvUser, VERR_INVALID_POINTER);
4882
4883 HRESULT hr = com::Initialize();
4884 if (FAILED(hr))
4885 return VERR_COM_UNEXPECTED;
4886
4887 int rc = VINF_SUCCESS;
4888
4889 try
4890 {
4891 /* Create an event queue for the current thread. */
4892 EventQueue *pEventQueue = new EventQueue();
4893 AssertPtr(pEventQueue);
4894
4895 /* Return the queue to the one who created this thread. */
4896 *(static_cast <EventQueue **>(pvUser)) = pEventQueue;
4897
4898 /* signal that we're ready. */
4899 RTThreadUserSignal(thread);
4900
4901 /*
4902 * In case of spurious wakeups causing VERR_TIMEOUTs and/or other return codes
4903 * we must not stop processing events and delete the pEventQueue object. This must
4904 * be done ONLY when we stop this loop via interruptEventQueueProcessing().
4905 * See @bugref{5724}.
4906 */
4907 for (;;)
4908 {
4909 rc = pEventQueue->processEventQueue(RT_INDEFINITE_WAIT);
4910 if (rc == VERR_INTERRUPTED)
4911 {
4912 LogFlow(("Event queue processing ended with rc=%Rrc\n", rc));
4913 rc = VINF_SUCCESS; /* Set success when exiting. */
4914 break;
4915 }
4916 }
4917
4918 delete pEventQueue;
4919 }
4920 catch (std::bad_alloc &ba)
4921 {
4922 rc = VERR_NO_MEMORY;
4923 NOREF(ba);
4924 }
4925
4926 com::Shutdown();
4927
4928 LogFlowFuncLeaveRC(rc);
4929 return rc;
4930}
4931
4932
4933////////////////////////////////////////////////////////////////////////////////
4934
4935/**
4936 * Prepare the event using the overwritten #prepareEventDesc method and fire.
4937 *
4938 * @note Locks the managed VirtualBox object for reading but leaves the lock
4939 * before iterating over callbacks and calling their methods.
4940 */
4941void *VirtualBox::CallbackEvent::handler()
4942{
4943 if (!mVirtualBox)
4944 return NULL;
4945
4946 AutoCaller autoCaller(mVirtualBox);
4947 if (!autoCaller.isOk())
4948 {
4949 Log1WarningFunc(("VirtualBox has been uninitialized (state=%d), the callback event is discarded!\n",
4950 mVirtualBox->getObjectState().getState()));
4951 /* We don't need mVirtualBox any more, so release it */
4952 mVirtualBox = NULL;
4953 return NULL;
4954 }
4955
4956 {
4957 VBoxEventDesc evDesc;
4958 prepareEventDesc(mVirtualBox->m->pEventSource, evDesc);
4959
4960 evDesc.fire(/* don't wait for delivery */0);
4961 }
4962
4963 mVirtualBox = NULL; /* Not needed any longer. Still make sense to do this? */
4964 return NULL;
4965}
4966
4967//STDMETHODIMP VirtualBox::CreateDHCPServerForInterface(/*IHostNetworkInterface * aIinterface,*/ IDHCPServer ** aServer)
4968//{
4969// return E_NOTIMPL;
4970//}
4971
4972HRESULT VirtualBox::createDHCPServer(const com::Utf8Str &aName,
4973 ComPtr<IDHCPServer> &aServer)
4974{
4975 ComObjPtr<DHCPServer> dhcpServer;
4976 dhcpServer.createObject();
4977 HRESULT rc = dhcpServer->init(this, aName);
4978 if (FAILED(rc)) return rc;
4979
4980 rc = i_registerDHCPServer(dhcpServer, true);
4981 if (FAILED(rc)) return rc;
4982
4983 dhcpServer.queryInterfaceTo(aServer.asOutParam());
4984
4985 return rc;
4986}
4987
4988HRESULT VirtualBox::findDHCPServerByNetworkName(const com::Utf8Str &aName,
4989 ComPtr<IDHCPServer> &aServer)
4990{
4991 HRESULT rc = S_OK;
4992 ComPtr<DHCPServer> found;
4993
4994 AutoReadLock alock(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
4995
4996 for (DHCPServersOList::const_iterator it = m->allDHCPServers.begin();
4997 it != m->allDHCPServers.end();
4998 ++it)
4999 {
5000 Bstr bstrNetworkName;
5001 rc = (*it)->COMGETTER(NetworkName)(bstrNetworkName.asOutParam());
5002 if (FAILED(rc)) return rc;
5003
5004 if (Utf8Str(bstrNetworkName) == aName)
5005 {
5006 found = *it;
5007 break;
5008 }
5009 }
5010
5011 if (!found)
5012 return E_INVALIDARG;
5013
5014 rc = found.queryInterfaceTo(aServer.asOutParam());
5015
5016 return rc;
5017}
5018
5019HRESULT VirtualBox::removeDHCPServer(const ComPtr<IDHCPServer> &aServer)
5020{
5021 IDHCPServer *aP = aServer;
5022
5023 HRESULT rc = i_unregisterDHCPServer(static_cast<DHCPServer *>(aP));
5024
5025 return rc;
5026}
5027
5028/**
5029 * Remembers the given DHCP server in the settings.
5030 *
5031 * @param aDHCPServer DHCP server object to remember.
5032 * @param aSaveSettings @c true to save settings to disk (default).
5033 *
5034 * When @a aSaveSettings is @c true, this operation may fail because of the
5035 * failed #i_saveSettings() method it calls. In this case, the dhcp server object
5036 * will not be remembered. It is therefore the responsibility of the caller to
5037 * call this method as the last step of some action that requires registration
5038 * in order to make sure that only fully functional dhcp server objects get
5039 * registered.
5040 *
5041 * @note Locks this object for writing and @a aDHCPServer for reading.
5042 */
5043HRESULT VirtualBox::i_registerDHCPServer(DHCPServer *aDHCPServer,
5044 bool aSaveSettings /*= true*/)
5045{
5046 AssertReturn(aDHCPServer != NULL, E_INVALIDARG);
5047
5048 AutoCaller autoCaller(this);
5049 AssertComRCReturnRC(autoCaller.rc());
5050
5051 // Acquire a lock on the VirtualBox object early to avoid lock order issues
5052 // when we call i_saveSettings() later on.
5053 AutoWriteLock vboxLock(this COMMA_LOCKVAL_SRC_POS);
5054 // need it below, in findDHCPServerByNetworkName (reading) and in
5055 // m->allDHCPServers.addChild, so need to get it here to avoid lock
5056 // order trouble with dhcpServerCaller
5057 AutoWriteLock alock(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
5058
5059 AutoCaller dhcpServerCaller(aDHCPServer);
5060 AssertComRCReturnRC(dhcpServerCaller.rc());
5061
5062 Bstr bstrNetworkName;
5063 HRESULT rc = S_OK;
5064 rc = aDHCPServer->COMGETTER(NetworkName)(bstrNetworkName.asOutParam());
5065 if (FAILED(rc)) return rc;
5066
5067 ComPtr<IDHCPServer> existing;
5068 rc = findDHCPServerByNetworkName(Utf8Str(bstrNetworkName), existing);
5069 if (SUCCEEDED(rc))
5070 return E_INVALIDARG;
5071 rc = S_OK;
5072
5073 m->allDHCPServers.addChild(aDHCPServer);
5074 // we need to release the list lock before we attempt to acquire locks
5075 // on other objects in i_saveSettings (see @bugref{7500})
5076 alock.release();
5077
5078 if (aSaveSettings)
5079 {
5080 // we acquired the lock on 'this' earlier to avoid lock order issues
5081 rc = i_saveSettings();
5082
5083 if (FAILED(rc))
5084 {
5085 alock.acquire();
5086 m->allDHCPServers.removeChild(aDHCPServer);
5087 }
5088 }
5089
5090 return rc;
5091}
5092
5093/**
5094 * Removes the given DHCP server from the settings.
5095 *
5096 * @param aDHCPServer DHCP server object to remove.
5097 *
5098 * This operation may fail because of the failed #i_saveSettings() method it
5099 * calls. In this case, the DHCP server will NOT be removed from the settings
5100 * when this method returns.
5101 *
5102 * @note Locks this object for writing.
5103 */
5104HRESULT VirtualBox::i_unregisterDHCPServer(DHCPServer *aDHCPServer)
5105{
5106 AssertReturn(aDHCPServer != NULL, E_INVALIDARG);
5107
5108 AutoCaller autoCaller(this);
5109 AssertComRCReturnRC(autoCaller.rc());
5110
5111 AutoCaller dhcpServerCaller(aDHCPServer);
5112 AssertComRCReturnRC(dhcpServerCaller.rc());
5113
5114 AutoWriteLock vboxLock(this COMMA_LOCKVAL_SRC_POS);
5115 AutoWriteLock alock(m->allDHCPServers.getLockHandle() COMMA_LOCKVAL_SRC_POS);
5116 m->allDHCPServers.removeChild(aDHCPServer);
5117 // we need to release the list lock before we attempt to acquire locks
5118 // on other objects in i_saveSettings (see @bugref{7500})
5119 alock.release();
5120
5121 HRESULT rc = i_saveSettings();
5122
5123 // undo the changes if we failed to save them
5124 if (FAILED(rc))
5125 {
5126 alock.acquire();
5127 m->allDHCPServers.addChild(aDHCPServer);
5128 }
5129
5130 return rc;
5131}
5132
5133
5134/**
5135 * NAT Network
5136 */
5137HRESULT VirtualBox::createNATNetwork(const com::Utf8Str &aNetworkName,
5138 ComPtr<INATNetwork> &aNetwork)
5139{
5140#ifdef VBOX_WITH_NAT_SERVICE
5141 ComObjPtr<NATNetwork> natNetwork;
5142 natNetwork.createObject();
5143 HRESULT rc = natNetwork->init(this, aNetworkName);
5144 if (FAILED(rc)) return rc;
5145
5146 rc = i_registerNATNetwork(natNetwork, true);
5147 if (FAILED(rc)) return rc;
5148
5149 natNetwork.queryInterfaceTo(aNetwork.asOutParam());
5150
5151 fireNATNetworkCreationDeletionEvent(m->pEventSource, Bstr(aNetworkName).raw(), TRUE);
5152
5153 return rc;
5154#else
5155 NOREF(aName);
5156 NOREF(aNatNetwork);
5157 return E_NOTIMPL;
5158#endif
5159}
5160
5161HRESULT VirtualBox::findNATNetworkByName(const com::Utf8Str &aNetworkName,
5162 ComPtr<INATNetwork> &aNetwork)
5163{
5164#ifdef VBOX_WITH_NAT_SERVICE
5165
5166 HRESULT rc = S_OK;
5167 ComPtr<NATNetwork> found;
5168
5169 AutoReadLock alock(m->allNATNetworks.getLockHandle() COMMA_LOCKVAL_SRC_POS);
5170
5171 for (NATNetworksOList::const_iterator it = m->allNATNetworks.begin();
5172 it != m->allNATNetworks.end();
5173 ++it)
5174 {
5175 Bstr bstrNATNetworkName;
5176 rc = (*it)->COMGETTER(NetworkName)(bstrNATNetworkName.asOutParam());
5177 if (FAILED(rc)) return rc;
5178
5179 if (Utf8Str(bstrNATNetworkName) == aNetworkName)
5180 {
5181 found = *it;
5182 break;
5183 }
5184 }
5185
5186 if (!found)
5187 return E_INVALIDARG;
5188 found.queryInterfaceTo(aNetwork.asOutParam());
5189 return rc;
5190#else
5191 NOREF(aName);
5192 NOREF(aNetworkName);
5193 return E_NOTIMPL;
5194#endif
5195}
5196
5197HRESULT VirtualBox::removeNATNetwork(const ComPtr<INATNetwork> &aNetwork)
5198{
5199#ifdef VBOX_WITH_NAT_SERVICE
5200 Bstr name;
5201 HRESULT rc = aNetwork->COMGETTER(NetworkName)(name.asOutParam());
5202 if (FAILED(rc))
5203 return rc;
5204 INATNetwork *p = aNetwork;
5205 NATNetwork *network = static_cast<NATNetwork *>(p);
5206 rc = i_unregisterNATNetwork(network, true);
5207 fireNATNetworkCreationDeletionEvent(m->pEventSource, name.raw(), FALSE);
5208 return rc;
5209#else
5210 NOREF(aNetwork);
5211 return E_NOTIMPL;
5212#endif
5213
5214}
5215/**
5216 * Remembers the given NAT network in the settings.
5217 *
5218 * @param aNATNetwork NAT Network object to remember.
5219 * @param aSaveSettings @c true to save settings to disk (default).
5220 *
5221 *
5222 * @note Locks this object for writing and @a aNATNetwork for reading.
5223 */
5224HRESULT VirtualBox::i_registerNATNetwork(NATNetwork *aNATNetwork,
5225 bool aSaveSettings /*= true*/)
5226{
5227#ifdef VBOX_WITH_NAT_SERVICE
5228 AssertReturn(aNATNetwork != NULL, E_INVALIDARG);
5229
5230 AutoCaller autoCaller(this);
5231 AssertComRCReturnRC(autoCaller.rc());
5232
5233 AutoCaller natNetworkCaller(aNATNetwork);
5234 AssertComRCReturnRC(natNetworkCaller.rc());
5235
5236 Bstr name;
5237 HRESULT rc;
5238 rc = aNATNetwork->COMGETTER(NetworkName)(name.asOutParam());
5239 AssertComRCReturnRC(rc);
5240
5241 /* returned value isn't 0 and aSaveSettings is true
5242 * means that we create duplicate, otherwise we just load settings.
5243 */
5244 if ( sNatNetworkNameToRefCount[name]
5245 && aSaveSettings)
5246 AssertComRCReturnRC(E_INVALIDARG);
5247
5248 rc = S_OK;
5249
5250 sNatNetworkNameToRefCount[name] = 0;
5251
5252 m->allNATNetworks.addChild(aNATNetwork);
5253
5254 if (aSaveSettings)
5255 {
5256 AutoWriteLock vboxLock(this COMMA_LOCKVAL_SRC_POS);
5257 rc = i_saveSettings();
5258 vboxLock.release();
5259
5260 if (FAILED(rc))
5261 i_unregisterNATNetwork(aNATNetwork, false /* aSaveSettings */);
5262 }
5263
5264 return rc;
5265#else
5266 NOREF(aNATNetwork);
5267 NOREF(aSaveSettings);
5268 /* No panic please (silently ignore) */
5269 return S_OK;
5270#endif
5271}
5272
5273/**
5274 * Removes the given NAT network from the settings.
5275 *
5276 * @param aNATNetwork NAT network object to remove.
5277 * @param aSaveSettings @c true to save settings to disk (default).
5278 *
5279 * When @a aSaveSettings is @c true, this operation may fail because of the
5280 * failed #i_saveSettings() method it calls. In this case, the DHCP server
5281 * will NOT be removed from the settingsi when this method returns.
5282 *
5283 * @note Locks this object for writing.
5284 */
5285HRESULT VirtualBox::i_unregisterNATNetwork(NATNetwork *aNATNetwork,
5286 bool aSaveSettings /*= true*/)
5287{
5288#ifdef VBOX_WITH_NAT_SERVICE
5289 AssertReturn(aNATNetwork != NULL, E_INVALIDARG);
5290
5291 AutoCaller autoCaller(this);
5292 AssertComRCReturnRC(autoCaller.rc());
5293
5294 AutoCaller natNetworkCaller(aNATNetwork);
5295 AssertComRCReturnRC(natNetworkCaller.rc());
5296
5297 Bstr name;
5298 HRESULT rc = aNATNetwork->COMGETTER(NetworkName)(name.asOutParam());
5299 /* Hm, there're still running clients. */
5300 if (FAILED(rc) || sNatNetworkNameToRefCount[name])
5301 AssertComRCReturnRC(E_INVALIDARG);
5302
5303 m->allNATNetworks.removeChild(aNATNetwork);
5304
5305 if (aSaveSettings)
5306 {
5307 AutoWriteLock vboxLock(this COMMA_LOCKVAL_SRC_POS);
5308 rc = i_saveSettings();
5309 vboxLock.release();
5310
5311 if (FAILED(rc))
5312 i_registerNATNetwork(aNATNetwork, false /* aSaveSettings */);
5313 }
5314
5315 return rc;
5316#else
5317 NOREF(aNATNetwork);
5318 NOREF(aSaveSettings);
5319 return E_NOTIMPL;
5320#endif
5321}
5322
5323
5324#ifdef RT_OS_WINDOWS
5325#include <psapi.h>
5326
5327/**
5328 * Report versions of installed drivers to release log.
5329 */
5330void VirtualBox::i_reportDriverVersions()
5331{
5332 /** @todo r=klaus this code is very confusing, as it uses TCHAR (and
5333 * randomly also _TCHAR, which sounds to me like asking for trouble),
5334 * the "sz" variable prefix but "%ls" for the format string - so the whole
5335 * thing is better compiled with UNICODE and _UNICODE defined. Would be
5336 * far easier to read if it would be coded explicitly for the unicode
5337 * case, as it won't work otherwise. */
5338 DWORD err;
5339 HRESULT hrc;
5340 LPVOID aDrivers[1024];
5341 LPVOID *pDrivers = aDrivers;
5342 UINT cNeeded = 0;
5343 TCHAR szSystemRoot[MAX_PATH];
5344 TCHAR *pszSystemRoot = szSystemRoot;
5345 LPVOID pVerInfo = NULL;
5346 DWORD cbVerInfo = 0;
5347
5348 do
5349 {
5350 cNeeded = GetWindowsDirectory(szSystemRoot, RT_ELEMENTS(szSystemRoot));
5351 if (cNeeded == 0)
5352 {
5353 err = GetLastError();
5354 hrc = HRESULT_FROM_WIN32(err);
5355 AssertLogRelMsgFailed(("GetWindowsDirectory failed, hr=%Rhrc (0x%x) err=%u\n",
5356 hrc, hrc, err));
5357 break;
5358 }
5359 else if (cNeeded > RT_ELEMENTS(szSystemRoot))
5360 {
5361 /* The buffer is too small, allocate big one. */
5362 pszSystemRoot = (TCHAR *)RTMemTmpAlloc(cNeeded * sizeof(_TCHAR));
5363 if (!pszSystemRoot)
5364 {
5365 AssertLogRelMsgFailed(("RTMemTmpAlloc failed to allocate %d bytes\n", cNeeded));
5366 break;
5367 }
5368 if (GetWindowsDirectory(pszSystemRoot, cNeeded) == 0)
5369 {
5370 err = GetLastError();
5371 hrc = HRESULT_FROM_WIN32(err);
5372 AssertLogRelMsgFailed(("GetWindowsDirectory failed, hr=%Rhrc (0x%x) err=%u\n",
5373 hrc, hrc, err));
5374 break;
5375 }
5376 }
5377
5378 DWORD cbNeeded = 0;
5379 if (!EnumDeviceDrivers(aDrivers, sizeof(aDrivers), &cbNeeded) || cbNeeded > sizeof(aDrivers))
5380 {
5381 pDrivers = (LPVOID *)RTMemTmpAlloc(cbNeeded);
5382 if (!EnumDeviceDrivers(pDrivers, cbNeeded, &cbNeeded))
5383 {
5384 err = GetLastError();
5385 hrc = HRESULT_FROM_WIN32(err);
5386 AssertLogRelMsgFailed(("EnumDeviceDrivers failed, hr=%Rhrc (0x%x) err=%u\n",
5387 hrc, hrc, err));
5388 break;
5389 }
5390 }
5391
5392 LogRel(("Installed Drivers:\n"));
5393
5394 TCHAR szDriver[1024];
5395 int cDrivers = cbNeeded / sizeof(pDrivers[0]);
5396 for (int i = 0; i < cDrivers; i++)
5397 {
5398 if (GetDeviceDriverBaseName(pDrivers[i], szDriver, sizeof(szDriver) / sizeof(szDriver[0])))
5399 {
5400 if (_tcsnicmp(TEXT("vbox"), szDriver, 4))
5401 continue;
5402 }
5403 else
5404 continue;
5405 if (GetDeviceDriverFileName(pDrivers[i], szDriver, sizeof(szDriver) / sizeof(szDriver[0])))
5406 {
5407 _TCHAR szTmpDrv[1024];
5408 _TCHAR *pszDrv = szDriver;
5409 if (!_tcsncmp(TEXT("\\SystemRoot"), szDriver, 11))
5410 {
5411 _tcscpy_s(szTmpDrv, pszSystemRoot);
5412 _tcsncat_s(szTmpDrv, szDriver + 11, sizeof(szTmpDrv) / sizeof(szTmpDrv[0]) - _tclen(pszSystemRoot));
5413 pszDrv = szTmpDrv;
5414 }
5415 else if (!_tcsncmp(TEXT("\\??\\"), szDriver, 4))
5416 pszDrv = szDriver + 4;
5417
5418 /* Allocate a buffer for version info. Reuse if large enough. */
5419 DWORD cbNewVerInfo = GetFileVersionInfoSize(pszDrv, NULL);
5420 if (cbNewVerInfo > cbVerInfo)
5421 {
5422 if (pVerInfo)
5423 RTMemTmpFree(pVerInfo);
5424 cbVerInfo = cbNewVerInfo;
5425 pVerInfo = RTMemTmpAlloc(cbVerInfo);
5426 if (!pVerInfo)
5427 {
5428 AssertLogRelMsgFailed(("RTMemTmpAlloc failed to allocate %d bytes\n", cbVerInfo));
5429 break;
5430 }
5431 }
5432
5433 if (GetFileVersionInfo(pszDrv, NULL, cbVerInfo, pVerInfo))
5434 {
5435 UINT cbSize = 0;
5436 LPBYTE lpBuffer = NULL;
5437 if (VerQueryValue(pVerInfo, TEXT("\\"), (VOID FAR* FAR*)&lpBuffer, &cbSize))
5438 {
5439 if (cbSize)
5440 {
5441 VS_FIXEDFILEINFO *pFileInfo = (VS_FIXEDFILEINFO *)lpBuffer;
5442 if (pFileInfo->dwSignature == 0xfeef04bd)
5443 {
5444 LogRel((" %ls (Version: %d.%d.%d.%d)\n", pszDrv,
5445 (pFileInfo->dwFileVersionMS >> 16) & 0xffff,
5446 (pFileInfo->dwFileVersionMS >> 0) & 0xffff,
5447 (pFileInfo->dwFileVersionLS >> 16) & 0xffff,
5448 (pFileInfo->dwFileVersionLS >> 0) & 0xffff));
5449 }
5450 }
5451 }
5452 }
5453 }
5454 }
5455
5456 }
5457 while (0);
5458
5459 if (pVerInfo)
5460 RTMemTmpFree(pVerInfo);
5461
5462 if (pDrivers != aDrivers)
5463 RTMemTmpFree(pDrivers);
5464
5465 if (pszSystemRoot != szSystemRoot)
5466 RTMemTmpFree(pszSystemRoot);
5467}
5468#else /* !RT_OS_WINDOWS */
5469void VirtualBox::i_reportDriverVersions(void)
5470{
5471}
5472#endif /* !RT_OS_WINDOWS */
5473
5474/* vi: set tabstop=4 shiftwidth=4 expandtab: */
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