VirtualBox

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

Last change on this file since 50384 was 50384, checked in by vboxsync, 11 years ago

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