VirtualBox

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

Last change on this file since 44353 was 44353, checked in by vboxsync, 12 years ago

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