VirtualBox

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

Last change on this file since 60786 was 60786, checked in by vboxsync, 9 years ago

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

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