VirtualBox

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

Last change on this file since 40685 was 40633, checked in by vboxsync, 13 years ago

several warnings

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