MachineImpl.cpp@ 21077

Last change on this file since 21077 was 21077, checked in by vboxsync, 15 years ago
back out r49329, r49331, will start over
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 374.2 KB

Line
1	/* $Id: MachineImpl.cpp 21077 2009-06-30 15:19:12Z vboxsync $ */
2
3	/** @file
4	* Implementation of IMachine in VBoxSVC.
5	*/
6
7	/*
8	* Copyright (C) 2006-2009 Sun Microsystems, Inc.
9	*
10	* This file is part of VirtualBox Open Source Edition (OSE), as
11	* available from http://www.virtualbox.org. This file is free software;
12	* you can redistribute it and/or modify it under the terms of the GNU
13	* General Public License (GPL) as published by the Free Software
14	* Foundation, in version 2 as it comes in the "COPYING" file of the
15	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17	*
18	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
19	* Clara, CA 95054 USA or visit http://www.sun.com if you need
20	* additional information or have any questions.
21	*/
22
23	/* Make sure all the stdint.h macros are included - must come first! */
24	#ifndef __STDC_LIMIT_MACROS
25	# define __STDC_LIMIT_MACROS
26	#endif
27	#ifndef __STDC_CONSTANT_MACROS
28	# define __STDC_CONSTANT_MACROS
29	#endif
30
31	#ifdef VBOX_WITH_SYS_V_IPC_SESSION_WATCHER
32	# include <errno.h>
33	# include <sys/types.h>
34	# include <sys/stat.h>
35	# include <sys/ipc.h>
36	# include <sys/sem.h>
37	#endif
38
39	#include "VirtualBoxImpl.h"
40	#include "MachineImpl.h"
41	#include "ProgressImpl.h"
42	#include "HardDiskAttachmentImpl.h"
43	#include "USBControllerImpl.h"
44	#include "HostImpl.h"
45	#include "SystemPropertiesImpl.h"
46	#include "SharedFolderImpl.h"
47	#include "GuestOSTypeImpl.h"
48	#include "VirtualBoxErrorInfoImpl.h"
49	#include "GuestImpl.h"
50	#include "StorageControllerImpl.h"
51
52	#ifdef VBOX_WITH_USB
53	# include "USBProxyService.h"
54	#endif
55
56	#include "VirtualBoxXMLUtil.h"
57
58	#include "Logging.h"
59	#include "Performance.h"
60
61	#include <stdio.h>
62	#include <stdlib.h>
63
64	#include <iprt/path.h>
65	#include <iprt/dir.h>
66	#include <iprt/asm.h>
67	#include <iprt/process.h>
68	#include <iprt/cpputils.h>
69	#include <iprt/env.h>
70	#include <iprt/string.h>
71
72	#include <VBox/com/array.h>
73
74	#include <VBox/err.h>
75	#include <VBox/param.h>
76	#include <VBox/settings.h>
77
78	#ifdef VBOX_WITH_GUEST_PROPS
79	# include <VBox/HostServices/GuestPropertySvc.h>
80	# include <VBox/com/array.h>
81	#endif
82
83	#include <algorithm>
84
85	#include <typeinfo>
86
87	#if defined(RT_OS_WINDOWS) \|\| defined(RT_OS_OS2)
88	#define HOSTSUFF_EXE ".exe"
89	#else /* !RT_OS_WINDOWS */
90	#define HOSTSUFF_EXE ""
91	#endif /* !RT_OS_WINDOWS */
92
93	// defines / prototypes
94	/////////////////////////////////////////////////////////////////////////////
95
96	// globals
97	/////////////////////////////////////////////////////////////////////////////
98
99	/**
100	* @note The template is NOT completely valid according to VBOX_XML_SCHEMA
101	* (when loading a newly created settings file, validation will be turned off)
102	*/
103	static const char gDefaultMachineConfig[] =
104	{
105	"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>" RTFILE_LINEFEED
106	"<!-- Sun VirtualBox Machine Configuration -->" RTFILE_LINEFEED
107	"<VirtualBox xmlns=\"" VBOX_XML_NAMESPACE "\" "
108	"version=\"" VBOX_XML_VERSION_FULL "\">" RTFILE_LINEFEED
109	"</VirtualBox>" RTFILE_LINEFEED
110	};
111
112	/**
113	* Progress callback handler for lengthy operations
114	* (corresponds to the FNRTPROGRESS typedef).
115	*
116	* @param uPercentage Completetion precentage (0-100).
117	* @param pvUser Pointer to the Progress instance.
118	*/
119	static DECLCALLBACK(int) progressCallback (unsigned uPercentage, void *pvUser)
120	{
121	Progress progress = static_cast<Progress>(pvUser);
122
123	/* update the progress object */
124	if (progress)
125	progress->setCurrentOperationProgress(uPercentage);
126
127	return VINF_SUCCESS;
128	}
129
130	/////////////////////////////////////////////////////////////////////////////
131	// Machine::Data structure
132	/////////////////////////////////////////////////////////////////////////////
133
134	Machine::Data::Data()
135	{
136	mRegistered = FALSE;
137	mAccessible = FALSE;
138	/* mUuid is initialized in Machine::init() */
139
140	mMachineState = MachineState_PoweredOff;
141	RTTimeNow (&mLastStateChange);
142
143	mMachineStateDeps = 0;
144	mMachineStateDepsSem = NIL_RTSEMEVENTMULTI;
145	mMachineStateChangePending = 0;
146
147	mCurrentStateModified = TRUE;
148	mHandleCfgFile = NIL_RTFILE;
149
150	mSession.mPid = NIL_RTPROCESS;
151	mSession.mState = SessionState_Closed;
152	}
153
154	Machine::Data::~Data()
155	{
156	if (mMachineStateDepsSem != NIL_RTSEMEVENTMULTI)
157	{
158	RTSemEventMultiDestroy (mMachineStateDepsSem);
159	mMachineStateDepsSem = NIL_RTSEMEVENTMULTI;
160	}
161	}
162
163	/////////////////////////////////////////////////////////////////////////////
164	// Machine::UserData structure
165	/////////////////////////////////////////////////////////////////////////////
166
167	Machine::UserData::UserData()
168	{
169	/* default values for a newly created machine */
170
171	mNameSync = TRUE;
172
173	/* mName, mOSTypeId, mSnapshotFolder, mSnapshotFolderFull are initialized in
174	* Machine::init() */
175	}
176
177	Machine::UserData::~UserData()
178	{
179	}
180
181	/////////////////////////////////////////////////////////////////////////////
182	// Machine::HWData structure
183	/////////////////////////////////////////////////////////////////////////////
184
185	Machine::HWData::HWData()
186	{
187	/* default values for a newly created machine */
188	mHWVersion = "2"; /** @todo get the default from the schema if that is possible. */
189	mMemorySize = 128;
190	mCPUCount = 1;
191	mMemoryBalloonSize = 0;
192	mStatisticsUpdateInterval = 0;
193	mVRAMSize = 8;
194	mAccelerate3DEnabled = false;
195	mMonitorCount = 1;
196	mHWVirtExEnabled = TSBool_False;
197	mHWVirtExNestedPagingEnabled = false;
198	mHWVirtExVPIDEnabled = false;
199	mPAEEnabled = false;
200	mPropertyServiceActive = false;
201
202	/* default boot order: floppy - DVD - HDD */
203	mBootOrder [0] = DeviceType_Floppy;
204	mBootOrder [1] = DeviceType_DVD;
205	mBootOrder [2] = DeviceType_HardDisk;
206	for (size_t i = 3; i < RT_ELEMENTS (mBootOrder); i++)
207	mBootOrder [i] = DeviceType_Null;
208
209	mClipboardMode = ClipboardMode_Bidirectional;
210	mGuestPropertyNotificationPatterns = "";
211	}
212
213	Machine::HWData::~HWData()
214	{
215	}
216
217	bool Machine::HWData::operator== (const HWData &that) const
218	{
219	if (this == &that)
220	return true;
221
222	if (mHWVersion != that.mHWVersion \|\|
223	mMemorySize != that.mMemorySize \|\|
224	mMemoryBalloonSize != that.mMemoryBalloonSize \|\|
225	mStatisticsUpdateInterval != that.mStatisticsUpdateInterval \|\|
226	mVRAMSize != that.mVRAMSize \|\|
227	mAccelerate3DEnabled != that.mAccelerate3DEnabled \|\|
228	mMonitorCount != that.mMonitorCount \|\|
229	mHWVirtExEnabled != that.mHWVirtExEnabled \|\|
230	mHWVirtExNestedPagingEnabled != that.mHWVirtExNestedPagingEnabled \|\|
231	mHWVirtExVPIDEnabled != that.mHWVirtExVPIDEnabled \|\|
232	mPAEEnabled != that.mPAEEnabled \|\|
233	mCPUCount != that.mCPUCount \|\|
234	mClipboardMode != that.mClipboardMode)
235	return false;
236
237	for (size_t i = 0; i < RT_ELEMENTS (mBootOrder); ++ i)
238	if (mBootOrder [i] != that.mBootOrder [i])
239	return false;
240
241	if (mSharedFolders.size() != that.mSharedFolders.size())
242	return false;
243
244	if (mSharedFolders.size() == 0)
245	return true;
246
247	/* Make copies to speed up comparison */
248	SharedFolderList folders = mSharedFolders;
249	SharedFolderList thatFolders = that.mSharedFolders;
250
251	SharedFolderList::iterator it = folders.begin();
252	while (it != folders.end())
253	{
254	bool found = false;
255	SharedFolderList::iterator thatIt = thatFolders.begin();
256	while (thatIt != thatFolders.end())
257	{
258	if ((it)->name() == (thatIt)->name() &&
259	RTPathCompare (Utf8Str ((*it)->hostPath()),
260	Utf8Str ((*thatIt)->hostPath())) == 0)
261	{
262	thatFolders.erase (thatIt);
263	found = true;
264	break;
265	}
266	else
267	++ thatIt;
268	}
269	if (found)
270	it = folders.erase (it);
271	else
272	return false;
273	}
274
275	Assert (folders.size() == 0 && thatFolders.size() == 0);
276
277	return true;
278	}
279
280	/////////////////////////////////////////////////////////////////////////////
281	// Machine::HDData structure
282	/////////////////////////////////////////////////////////////////////////////
283
284	Machine::HDData::HDData()
285	{
286	}
287
288	Machine::HDData::~HDData()
289	{
290	}
291
292	bool Machine::HDData::operator== (const HDData &that) const
293	{
294	if (this == &that)
295	return true;
296
297	if (mAttachments.size() != that.mAttachments.size())
298	return false;
299
300	if (mAttachments.size() == 0)
301	return true;
302
303	/* Make copies to speed up comparison */
304	AttachmentList atts = mAttachments;
305	AttachmentList thatAtts = that.mAttachments;
306
307	AttachmentList::iterator it = atts.begin();
308	while (it != atts.end())
309	{
310	bool found = false;
311	AttachmentList::iterator thatIt = thatAtts.begin();
312	while (thatIt != thatAtts.end())
313	{
314	if ((it)->controller() == (thatIt)->controller() &&
315	(it)->port() == (thatIt)->port() &&
316	(it)->device() == (thatIt)->device() &&
317	(it)->hardDisk().equalsTo ((thatIt)->hardDisk()))
318	{
319	thatAtts.erase (thatIt);
320	found = true;
321	break;
322	}
323	else
324	++ thatIt;
325	}
326	if (found)
327	it = atts.erase (it);
328	else
329	return false;
330	}
331
332	Assert (atts.size() == 0 && thatAtts.size() == 0);
333
334	return true;
335	}
336
337	/////////////////////////////////////////////////////////////////////////////
338	// Machine class
339	/////////////////////////////////////////////////////////////////////////////
340
341	// constructor / destructor
342	/////////////////////////////////////////////////////////////////////////////
343
344	Machine::Machine() : mType (IsMachine) {}
345
346	Machine::~Machine() {}
347
348	HRESULT Machine::FinalConstruct()
349	{
350	LogFlowThisFunc (("\n"));
351	return S_OK;
352	}
353
354	void Machine::FinalRelease()
355	{
356	LogFlowThisFunc (("\n"));
357	uninit();
358	}
359
360	/**
361	* Initializes the instance.
362	*
363	* @param aParent Associated parent object
364	* @param aConfigFile Local file system path to the VM settings file (can
365	* be relative to the VirtualBox config directory).
366	* @param aMode Init_New, Init_Existing or Init_Registered
367	* @param aName name for the machine when aMode is Init_New
368	* (ignored otherwise)
369	* @param aOsType OS Type of this machine
370	* @param aNameSync \|TRUE\| to automatically sync settings dir and file
371	* name with the machine name. \|FALSE\| is used for legacy
372	* machines where the file name is specified by the
373	* user and should never change. Used only in Init_New
374	* mode (ignored otherwise).
375	* @param aId UUID of the machine. Required for aMode==Init_Registered
376	* and optional for aMode==Init_New. Used for consistency
377	* check when aMode is Init_Registered; must match UUID
378	* stored in the settings file. Used for predefining the
379	* UUID of a VM when aMode is Init_New.
380	*
381	* @return Success indicator. if not S_OK, the machine object is invalid
382	*/
383	HRESULT Machine::init (VirtualBox *aParent, CBSTR aConfigFile,
384	InitMode aMode, CBSTR aName /* = NULL */,
385	GuestOSType aOsType / = NULL */,
386	BOOL aNameSync /* = TRUE */,
387	const Guid aId / = NULL */)
388	{
389	LogFlowThisFuncEnter();
390	LogFlowThisFunc (("aConfigFile='%ls', aMode=%d\n", aConfigFile, aMode));
391
392	AssertReturn (aParent, E_INVALIDARG);
393	AssertReturn (aConfigFile, E_INVALIDARG);
394	AssertReturn (aMode != Init_New \|\| (aName != NULL && *aName != '\0'),
395	E_INVALIDARG);
396	AssertReturn (aMode != Init_Registered \|\| aId != NULL, E_FAIL);
397
398	/* Enclose the state transition NotReady->InInit->Ready */
399	AutoInitSpan autoInitSpan (this);
400	AssertReturn (autoInitSpan.isOk(), E_FAIL);
401
402	HRESULT rc = S_OK;
403
404	/* share the parent weakly */
405	unconst (mParent) = aParent;
406
407	/* register with parent early, since uninit() will unconditionally
408	* unregister on failure */
409	mParent->addDependentChild (this);
410
411	/* allocate the essential machine data structure (the rest will be
412	* allocated later by initDataAndChildObjects() */
413	mData.allocate();
414
415	/* memorize the config file name (as provided) */
416	mData->mConfigFile = aConfigFile;
417
418	/* get the full file name */
419	Utf8Str configFileFull;
420	int vrc = mParent->calculateFullPath (Utf8Str (aConfigFile), configFileFull);
421	if (RT_FAILURE (vrc))
422	return setError (VBOX_E_FILE_ERROR,
423	tr ("Invalid machine settings file name '%ls' (%Rrc)"),
424	aConfigFile, vrc);
425
426	mData->mConfigFileFull = configFileFull;
427
428	if (aMode == Init_Registered)
429	{
430	mData->mRegistered = TRUE;
431
432	/* store the supplied UUID (will be used to check for UUID consistency
433	* in loadSettings() */
434	unconst (mData->mUuid) = *aId;
435	rc = registeredInit();
436	}
437	else
438	{
439	if (aMode == Init_Existing)
440	{
441	/* lock the settings file */
442	rc = lockConfig();
443	}
444	else if (aMode == Init_New)
445	{
446	/* check for the file existence */
447	RTFILE f = NIL_RTFILE;
448	int vrc = RTFileOpen (&f, configFileFull, RTFILE_O_READ);
449	if (RT_SUCCESS (vrc) \|\| vrc == VERR_SHARING_VIOLATION)
450	{
451	rc = setError (VBOX_E_FILE_ERROR,
452	tr ("Machine settings file '%s' already exists"),
453	configFileFull.raw());
454	if (RT_SUCCESS (vrc))
455	RTFileClose (f);
456	}
457	else
458	{
459	if (vrc != VERR_FILE_NOT_FOUND && vrc != VERR_PATH_NOT_FOUND)
460	rc = setError (VBOX_E_FILE_ERROR,
461	tr ("Invalid machine settings file name '%ls' (%Rrc)"),
462	mData->mConfigFileFull.raw(), vrc);
463	}
464	}
465	else
466	AssertFailed();
467
468	if (SUCCEEDED (rc))
469	rc = initDataAndChildObjects();
470
471	if (SUCCEEDED (rc))
472	{
473	/* set to true now to cause uninit() to call
474	* uninitDataAndChildObjects() on failure */
475	mData->mAccessible = TRUE;
476
477	if (aMode != Init_New)
478	{
479	rc = loadSettings (false /* aRegistered */);
480	}
481	else
482	{
483	/* create the machine UUID */
484	if (aId)
485	unconst (mData->mUuid) = *aId;
486	else
487	unconst (mData->mUuid).create();
488
489	/* memorize the provided new machine's name */
490	mUserData->mName = aName;
491	mUserData->mNameSync = aNameSync;
492
493	/* initialize the default snapshots folder
494	* (note: depends on the name value set above!) */
495	rc = COMSETTER(SnapshotFolder) (NULL);
496	AssertComRC (rc);
497
498	if (aOsType)
499	{
500	/* Store OS type */
501	mUserData->mOSTypeId = aOsType->id();
502
503	/* Apply HWVirtEx default; always true (used to rely on aOsType->recommendedVirtEx()) */
504	mHWData->mHWVirtExEnabled = TSBool_True;
505
506	/* Apply BIOS defaults */
507	mBIOSSettings->applyDefaults (aOsType);
508
509	/* Apply network adapters defaults */
510	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); ++ slot)
511	mNetworkAdapters [slot]->applyDefaults (aOsType);
512	}
513
514	/* The default is that the VM has at least one IDE controller
515	* which can't be disabled (because of the DVD stuff which is
516	* not in the StorageDevice implementation at the moment)
517	*/
518	ComPtr<IStorageController> pController;
519	rc = AddStorageController(Bstr("IDE"), StorageBus_IDE, pController.asOutParam());
520	CheckComRCReturnRC(rc);
521	ComObjPtr<StorageController> ctl;
522	rc = getStorageControllerByName(Bstr("IDE"), ctl, true);
523	CheckComRCReturnRC(rc);
524	ctl->COMSETTER(ControllerType)(StorageControllerType_PIIX4);
525	}
526
527	/* commit all changes made during the initialization */
528	if (SUCCEEDED (rc))
529	commit();
530	}
531	}
532
533	/* Confirm a successful initialization when it's the case */
534	if (SUCCEEDED (rc))
535	{
536	if (mData->mAccessible)
537	autoInitSpan.setSucceeded();
538	else
539	autoInitSpan.setLimited();
540	}
541
542	LogFlowThisFunc (("mName='%ls', mRegistered=%RTbool, mAccessible=%RTbool "
543	"rc=%08X\n",
544	!!mUserData ? mUserData->mName.raw() : NULL,
545	mData->mRegistered, mData->mAccessible, rc));
546
547	LogFlowThisFuncLeave();
548
549	return rc;
550	}
551
552	/**
553	* Initializes the registered machine by loading the settings file.
554	* This method is separated from #init() in order to make it possible to
555	* retry the operation after VirtualBox startup instead of refusing to
556	* startup the whole VirtualBox server in case if the settings file of some
557	* registered VM is invalid or inaccessible.
558	*
559	* @note Must be always called from this object's write lock
560	* (unless called from #init() that doesn't need any locking).
561	* @note Locks the mUSBController method for writing.
562	* @note Subclasses must not call this method.
563	*/
564	HRESULT Machine::registeredInit()
565	{
566	AssertReturn (mType == IsMachine, E_FAIL);
567	AssertReturn (!mData->mUuid.isEmpty(), E_FAIL);
568	AssertReturn (!mData->mAccessible, E_FAIL);
569
570	HRESULT rc = lockConfig();
571
572	if (SUCCEEDED (rc))
573	rc = initDataAndChildObjects();
574
575	if (SUCCEEDED (rc))
576	{
577	/* Temporarily reset the registered flag in order to let setters
578	* potentially called from loadSettings() succeed (isMutable() used in
579	* all setters will return FALSE for a Machine instance if mRegistered
580	* is TRUE). */
581	mData->mRegistered = FALSE;
582
583	rc = loadSettings (true /* aRegistered */);
584
585	/* Restore the registered flag (even on failure) */
586	mData->mRegistered = TRUE;
587
588	if (FAILED (rc))
589	unlockConfig();
590	}
591
592	if (SUCCEEDED (rc))
593	{
594	/* Set mAccessible to TRUE only if we successfully locked and loaded
595	* the settings file */
596	mData->mAccessible = TRUE;
597
598	/* commit all changes made during loading the settings file */
599	commit();
600	}
601	else
602	{
603	/* If the machine is registered, then, instead of returning a
604	* failure, we mark it as inaccessible and set the result to
605	* success to give it a try later */
606
607	/* fetch the current error info */
608	mData->mAccessError = com::ErrorInfo();
609	LogWarning (("Machine {%RTuuid} is inaccessible! [%ls]\n",
610	mData->mUuid.raw(),
611	mData->mAccessError.getText().raw()));
612
613	/* rollback all changes */
614	rollback (false /* aNotify */);
615
616	/* uninitialize the common part to make sure all data is reset to
617	* default (null) values */
618	uninitDataAndChildObjects();
619
620	rc = S_OK;
621	}
622
623	return rc;
624	}
625
626	/**
627	* Uninitializes the instance.
628	* Called either from FinalRelease() or by the parent when it gets destroyed.
629	*
630	* @note The caller of this method must make sure that this object
631	* a) doesn't have active callers on the current thread and b) is not locked
632	* by the current thread; otherwise uninit() will hang either a) due to
633	* AutoUninitSpan waiting for a number of calls to drop to zero or b) due to
634	* a dead-lock caused by this thread waiting for all callers on the other
635	* threads are done but preventing them from doing so by holding a lock.
636	*/
637	void Machine::uninit()
638	{
639	LogFlowThisFuncEnter();
640
641	Assert (!isWriteLockOnCurrentThread());
642
643	/* Enclose the state transition Ready->InUninit->NotReady */
644	AutoUninitSpan autoUninitSpan (this);
645	if (autoUninitSpan.uninitDone())
646	return;
647
648	Assert (mType == IsMachine);
649	Assert (!!mData);
650
651	LogFlowThisFunc (("initFailed()=%d\n", autoUninitSpan.initFailed()));
652	LogFlowThisFunc (("mRegistered=%d\n", mData->mRegistered));
653
654	/* Enter this object lock because there may be a SessionMachine instance
655	* somewhere around, that shares our data and lock but doesn't use our
656	* addCaller()/removeCaller(), and it may be also accessing the same data
657	* members. mParent lock is necessary as well because of
658	* SessionMachine::uninit(), etc.
659	*/
660	AutoMultiWriteLock2 alock (mParent, this);
661
662	if (!mData->mSession.mMachine.isNull())
663	{
664	/* Theoretically, this can only happen if the VirtualBox server has been
665	* terminated while there were clients running that owned open direct
666	* sessions. Since in this case we are definitely called by
667	* VirtualBox::uninit(), we may be sure that SessionMachine::uninit()
668	* won't happen on the client watcher thread (because it does
669	* VirtualBox::addCaller() for the duration of the
670	* SessionMachine::checkForDeath() call, so that VirtualBox::uninit()
671	* cannot happen until the VirtualBox caller is released). This is
672	* important, because SessionMachine::uninit() cannot correctly operate
673	* after we return from this method (it expects the Machine instance is
674	* still valid). We'll call it ourselves below.
675	*/
676	LogWarningThisFunc (("Session machine is not NULL (%p), "
677	"the direct session is still open!\n",
678	(SessionMachine *) mData->mSession.mMachine));
679
680	if (Global::IsOnlineOrTransient (mData->mMachineState))
681	{
682	LogWarningThisFunc (("Setting state to Aborted!\n"));
683	/* set machine state using SessionMachine reimplementation */
684	static_cast <Machine *> (mData->mSession.mMachine)
685	->setMachineState (MachineState_Aborted);
686	}
687
688	/*
689	* Uninitialize SessionMachine using public uninit() to indicate
690	* an unexpected uninitialization.
691	*/
692	mData->mSession.mMachine->uninit();
693	/* SessionMachine::uninit() must set mSession.mMachine to null */
694	Assert (mData->mSession.mMachine.isNull());
695	}
696
697	/* the lock is no more necessary (SessionMachine is uninitialized) */
698	alock.leave();
699
700	/* make sure the configuration is unlocked */
701	unlockConfig();
702
703	if (isModified())
704	{
705	LogWarningThisFunc (("Discarding unsaved settings changes!\n"));
706	rollback (false /* aNotify */);
707	}
708
709	if (mData->mAccessible)
710	uninitDataAndChildObjects();
711
712	/* free the essential data structure last */
713	mData.free();
714
715	mParent->removeDependentChild (this);
716
717	LogFlowThisFuncLeave();
718	}
719
720	// IMachine properties
721	/////////////////////////////////////////////////////////////////////////////
722
723	STDMETHODIMP Machine::COMGETTER(Parent) (IVirtualBox **aParent)
724	{
725	CheckComArgOutPointerValid (aParent);
726
727	AutoLimitedCaller autoCaller (this);
728	CheckComRCReturnRC (autoCaller.rc());
729
730	/* mParent is constant during life time, no need to lock */
731	mParent.queryInterfaceTo (aParent);
732
733	return S_OK;
734	}
735
736	STDMETHODIMP Machine::COMGETTER(Accessible) (BOOL *aAccessible)
737	{
738	CheckComArgOutPointerValid (aAccessible);
739
740	AutoLimitedCaller autoCaller (this);
741	CheckComRCReturnRC (autoCaller.rc());
742
743	AutoWriteLock alock (this);
744
745	HRESULT rc = S_OK;
746
747	if (!mData->mAccessible)
748	{
749	/* try to initialize the VM once more if not accessible */
750
751	AutoReinitSpan autoReinitSpan (this);
752	AssertReturn (autoReinitSpan.isOk(), E_FAIL);
753
754	rc = registeredInit();
755
756	if (SUCCEEDED (rc) && mData->mAccessible)
757	{
758	autoReinitSpan.setSucceeded();
759
760	/* make sure interesting parties will notice the accessibility
761	* state change */
762	mParent->onMachineStateChange (mData->mUuid, mData->mMachineState);
763	mParent->onMachineDataChange (mData->mUuid);
764	}
765	}
766
767	if (SUCCEEDED (rc))
768	*aAccessible = mData->mAccessible;
769
770	return rc;
771	}
772
773	STDMETHODIMP Machine::COMGETTER(AccessError) (IVirtualBoxErrorInfo **aAccessError)
774	{
775	CheckComArgOutPointerValid (aAccessError);
776
777	AutoLimitedCaller autoCaller (this);
778	CheckComRCReturnRC (autoCaller.rc());
779
780	AutoReadLock alock (this);
781
782	if (mData->mAccessible \|\| !mData->mAccessError.isBasicAvailable())
783	{
784	/* return shortly */
785	aAccessError = NULL;
786	return S_OK;
787	}
788
789	HRESULT rc = S_OK;
790
791	ComObjPtr <VirtualBoxErrorInfo> errorInfo;
792	rc = errorInfo.createObject();
793	if (SUCCEEDED (rc))
794	{
795	errorInfo->init (mData->mAccessError.getResultCode(),
796	mData->mAccessError.getInterfaceID(),
797	mData->mAccessError.getComponent(),
798	mData->mAccessError.getText());
799	rc = errorInfo.queryInterfaceTo (aAccessError);
800	}
801
802	return rc;
803	}
804
805	STDMETHODIMP Machine::COMGETTER(Name) (BSTR *aName)
806	{
807	CheckComArgOutPointerValid (aName);
808
809	AutoCaller autoCaller (this);
810	CheckComRCReturnRC (autoCaller.rc());
811
812	AutoReadLock alock (this);
813
814	mUserData->mName.cloneTo (aName);
815
816	return S_OK;
817	}
818
819	STDMETHODIMP Machine::COMSETTER(Name) (IN_BSTR aName)
820	{
821	CheckComArgNotNull (aName);
822
823	if (!*aName)
824	return setError (E_INVALIDARG,
825	tr ("Machine name cannot be empty"));
826
827	AutoCaller autoCaller (this);
828	CheckComRCReturnRC (autoCaller.rc());
829
830	AutoWriteLock alock (this);
831
832	HRESULT rc = checkStateDependency (MutableStateDep);
833	CheckComRCReturnRC (rc);
834
835	mUserData.backup();
836	mUserData->mName = aName;
837
838	return S_OK;
839	}
840
841	STDMETHODIMP Machine::COMGETTER(Description) (BSTR *aDescription)
842	{
843	CheckComArgOutPointerValid (aDescription);
844
845	AutoCaller autoCaller (this);
846	CheckComRCReturnRC (autoCaller.rc());
847
848	AutoReadLock alock (this);
849
850	mUserData->mDescription.cloneTo (aDescription);
851
852	return S_OK;
853	}
854
855	STDMETHODIMP Machine::COMSETTER(Description) (IN_BSTR aDescription)
856	{
857	AutoCaller autoCaller (this);
858	CheckComRCReturnRC (autoCaller.rc());
859
860	AutoWriteLock alock (this);
861
862	HRESULT rc = checkStateDependency (MutableStateDep);
863	CheckComRCReturnRC (rc);
864
865	mUserData.backup();
866	mUserData->mDescription = aDescription;
867
868	return S_OK;
869	}
870
871	STDMETHODIMP Machine::COMGETTER(Id) (BSTR *aId)
872	{
873	CheckComArgOutPointerValid (aId);
874
875	AutoLimitedCaller autoCaller (this);
876	CheckComRCReturnRC (autoCaller.rc());
877
878	AutoReadLock alock (this);
879
880	mData->mUuid.toUtf16().cloneTo (aId);
881
882	return S_OK;
883	}
884
885	STDMETHODIMP Machine::COMGETTER(OSTypeId) (BSTR *aOSTypeId)
886	{
887	CheckComArgOutPointerValid (aOSTypeId);
888
889	AutoCaller autoCaller (this);
890	CheckComRCReturnRC (autoCaller.rc());
891
892	AutoReadLock alock (this);
893
894	mUserData->mOSTypeId.cloneTo (aOSTypeId);
895
896	return S_OK;
897	}
898
899	STDMETHODIMP Machine::COMSETTER(OSTypeId) (IN_BSTR aOSTypeId)
900	{
901	CheckComArgNotNull (aOSTypeId);
902
903	AutoCaller autoCaller (this);
904	CheckComRCReturnRC (autoCaller.rc());
905
906	/* look up the object by Id to check it is valid */
907	ComPtr <IGuestOSType> guestOSType;
908	HRESULT rc = mParent->GetGuestOSType (aOSTypeId,
909	guestOSType.asOutParam());
910	CheckComRCReturnRC (rc);
911
912	/* when setting, always use the "etalon" value for consistency -- lookup
913	* by ID is case-insensitive and the input value may have different case */
914	Bstr osTypeId;
915	rc = guestOSType->COMGETTER(Id) (osTypeId.asOutParam());
916	CheckComRCReturnRC (rc);
917
918	AutoWriteLock alock (this);
919
920	rc = checkStateDependency (MutableStateDep);
921	CheckComRCReturnRC (rc);
922
923	mUserData.backup();
924	mUserData->mOSTypeId = osTypeId;
925
926	return S_OK;
927	}
928
929	STDMETHODIMP Machine::COMGETTER(HardwareVersion) (BSTR *aHWVersion)
930	{
931	if (!aHWVersion)
932	return E_POINTER;
933
934	AutoCaller autoCaller (this);
935	CheckComRCReturnRC (autoCaller.rc());
936
937	AutoReadLock alock (this);
938
939	mHWData->mHWVersion.cloneTo (aHWVersion);
940
941	return S_OK;
942	}
943
944	STDMETHODIMP Machine::COMSETTER(HardwareVersion) (IN_BSTR aHWVersion)
945	{
946	/* check known version */
947	Utf8Str hwVersion = aHWVersion;
948	if ( hwVersion.compare ("1") != 0
949	&& hwVersion.compare ("2") != 0)
950	return setError (E_INVALIDARG,
951	tr ("Invalid hardware version: %ls\n"), aHWVersion);
952
953	AutoCaller autoCaller (this);
954	CheckComRCReturnRC (autoCaller.rc());
955
956	AutoWriteLock alock (this);
957
958	HRESULT rc = checkStateDependency (MutableStateDep);
959	CheckComRCReturnRC (rc);
960
961	mHWData.backup();
962	mHWData->mHWVersion = hwVersion;
963
964	return S_OK;
965	}
966
967	STDMETHODIMP Machine::COMGETTER(MemorySize) (ULONG *memorySize)
968	{
969	if (!memorySize)
970	return E_POINTER;
971
972	AutoCaller autoCaller (this);
973	CheckComRCReturnRC (autoCaller.rc());
974
975	AutoReadLock alock (this);
976
977	*memorySize = mHWData->mMemorySize;
978
979	return S_OK;
980	}
981
982	STDMETHODIMP Machine::COMSETTER(MemorySize) (ULONG memorySize)
983	{
984	/* check RAM limits */
985	if (memorySize < MM_RAM_MIN_IN_MB \|\|
986	memorySize > MM_RAM_MAX_IN_MB)
987	return setError (E_INVALIDARG,
988	tr ("Invalid RAM size: %lu MB (must be in range [%lu, %lu] MB)"),
989	memorySize, MM_RAM_MIN_IN_MB, MM_RAM_MAX_IN_MB);
990
991	AutoCaller autoCaller (this);
992	CheckComRCReturnRC (autoCaller.rc());
993
994	AutoWriteLock alock (this);
995
996	HRESULT rc = checkStateDependency (MutableStateDep);
997	CheckComRCReturnRC (rc);
998
999	mHWData.backup();
1000	mHWData->mMemorySize = memorySize;
1001
1002	return S_OK;
1003	}
1004
1005	STDMETHODIMP Machine::COMGETTER(CPUCount) (ULONG *CPUCount)
1006	{
1007	if (!CPUCount)
1008	return E_POINTER;
1009
1010	AutoCaller autoCaller (this);
1011	CheckComRCReturnRC (autoCaller.rc());
1012
1013	AutoReadLock alock (this);
1014
1015	*CPUCount = mHWData->mCPUCount;
1016
1017	return S_OK;
1018	}
1019
1020	STDMETHODIMP Machine::COMSETTER(CPUCount) (ULONG CPUCount)
1021	{
1022	/* check RAM limits */
1023	if (CPUCount < SchemaDefs::MinCPUCount \|\|
1024	CPUCount > SchemaDefs::MaxCPUCount)
1025	return setError (E_INVALIDARG,
1026	tr ("Invalid virtual CPU count: %lu (must be in range [%lu, %lu])"),
1027	CPUCount, SchemaDefs::MinCPUCount, SchemaDefs::MaxCPUCount);
1028
1029	AutoCaller autoCaller (this);
1030	CheckComRCReturnRC (autoCaller.rc());
1031
1032	AutoWriteLock alock (this);
1033
1034	HRESULT rc = checkStateDependency (MutableStateDep);
1035	CheckComRCReturnRC (rc);
1036
1037	mHWData.backup();
1038	mHWData->mCPUCount = CPUCount;
1039
1040	return S_OK;
1041	}
1042
1043	STDMETHODIMP Machine::COMGETTER(VRAMSize) (ULONG *memorySize)
1044	{
1045	if (!memorySize)
1046	return E_POINTER;
1047
1048	AutoCaller autoCaller (this);
1049	CheckComRCReturnRC (autoCaller.rc());
1050
1051	AutoReadLock alock (this);
1052
1053	*memorySize = mHWData->mVRAMSize;
1054
1055	return S_OK;
1056	}
1057
1058	STDMETHODIMP Machine::COMSETTER(VRAMSize) (ULONG memorySize)
1059	{
1060	/* check VRAM limits */
1061	if (memorySize < SchemaDefs::MinGuestVRAM \|\|
1062	memorySize > SchemaDefs::MaxGuestVRAM)
1063	return setError (E_INVALIDARG,
1064	tr ("Invalid VRAM size: %lu MB (must be in range [%lu, %lu] MB)"),
1065	memorySize, SchemaDefs::MinGuestVRAM, SchemaDefs::MaxGuestVRAM);
1066
1067	AutoCaller autoCaller (this);
1068	CheckComRCReturnRC (autoCaller.rc());
1069
1070	AutoWriteLock alock (this);
1071
1072	HRESULT rc = checkStateDependency (MutableStateDep);
1073	CheckComRCReturnRC (rc);
1074
1075	mHWData.backup();
1076	mHWData->mVRAMSize = memorySize;
1077
1078	return S_OK;
1079	}
1080
1081	/** @todo this method should not be public */
1082	STDMETHODIMP Machine::COMGETTER(MemoryBalloonSize) (ULONG *memoryBalloonSize)
1083	{
1084	if (!memoryBalloonSize)
1085	return E_POINTER;
1086
1087	AutoCaller autoCaller (this);
1088	CheckComRCReturnRC (autoCaller.rc());
1089
1090	AutoReadLock alock (this);
1091
1092	*memoryBalloonSize = mHWData->mMemoryBalloonSize;
1093
1094	return S_OK;
1095	}
1096
1097	/** @todo this method should not be public */
1098	STDMETHODIMP Machine::COMSETTER(MemoryBalloonSize) (ULONG memoryBalloonSize)
1099	{
1100	/* check limits */
1101	if (memoryBalloonSize >= VMMDEV_MAX_MEMORY_BALLOON (mHWData->mMemorySize))
1102	return setError (E_INVALIDARG,
1103	tr ("Invalid memory balloon size: %lu MB (must be in range [%lu, %lu] MB)"),
1104	memoryBalloonSize, 0, VMMDEV_MAX_MEMORY_BALLOON (mHWData->mMemorySize));
1105
1106	AutoCaller autoCaller (this);
1107	CheckComRCReturnRC (autoCaller.rc());
1108
1109	AutoWriteLock alock (this);
1110
1111	HRESULT rc = checkStateDependency (MutableStateDep);
1112	CheckComRCReturnRC (rc);
1113
1114	mHWData.backup();
1115	mHWData->mMemoryBalloonSize = memoryBalloonSize;
1116
1117	return S_OK;
1118	}
1119
1120	/** @todo this method should not be public */
1121	STDMETHODIMP Machine::COMGETTER(StatisticsUpdateInterval) (ULONG *statisticsUpdateInterval)
1122	{
1123	if (!statisticsUpdateInterval)
1124	return E_POINTER;
1125
1126	AutoCaller autoCaller (this);
1127	CheckComRCReturnRC (autoCaller.rc());
1128
1129	AutoReadLock alock (this);
1130
1131	*statisticsUpdateInterval = mHWData->mStatisticsUpdateInterval;
1132
1133	return S_OK;
1134	}
1135
1136	/** @todo this method should not be public */
1137	STDMETHODIMP Machine::COMSETTER(StatisticsUpdateInterval) (ULONG statisticsUpdateInterval)
1138	{
1139	AutoCaller autoCaller (this);
1140	CheckComRCReturnRC (autoCaller.rc());
1141
1142	AutoWriteLock alock (this);
1143
1144	HRESULT rc = checkStateDependency (MutableStateDep);
1145	CheckComRCReturnRC (rc);
1146
1147	mHWData.backup();
1148	mHWData->mStatisticsUpdateInterval = statisticsUpdateInterval;
1149
1150	return S_OK;
1151	}
1152
1153
1154	STDMETHODIMP Machine::COMGETTER(Accelerate3DEnabled)(BOOL *enabled)
1155	{
1156	if (!enabled)
1157	return E_POINTER;
1158
1159	AutoCaller autoCaller (this);
1160	CheckComRCReturnRC (autoCaller.rc());
1161
1162	AutoReadLock alock (this);
1163
1164	*enabled = mHWData->mAccelerate3DEnabled;
1165
1166	return S_OK;
1167	}
1168
1169	STDMETHODIMP Machine::COMSETTER(Accelerate3DEnabled)(BOOL enable)
1170	{
1171	AutoCaller autoCaller (this);
1172	CheckComRCReturnRC (autoCaller.rc());
1173
1174	AutoWriteLock alock (this);
1175
1176	HRESULT rc = checkStateDependency (MutableStateDep);
1177	CheckComRCReturnRC (rc);
1178
1179	/** @todo check validity! */
1180
1181	mHWData.backup();
1182	mHWData->mAccelerate3DEnabled = enable;
1183
1184	return S_OK;
1185	}
1186
1187
1188	STDMETHODIMP Machine::COMGETTER(MonitorCount) (ULONG *monitorCount)
1189	{
1190	if (!monitorCount)
1191	return E_POINTER;
1192
1193	AutoCaller autoCaller (this);
1194	CheckComRCReturnRC (autoCaller.rc());
1195
1196	AutoReadLock alock (this);
1197
1198	*monitorCount = mHWData->mMonitorCount;
1199
1200	return S_OK;
1201	}
1202
1203	STDMETHODIMP Machine::COMSETTER(MonitorCount) (ULONG monitorCount)
1204	{
1205	/* make sure monitor count is a sensible number */
1206	if (monitorCount < 1 \|\| monitorCount > SchemaDefs::MaxGuestMonitors)
1207	return setError (E_INVALIDARG,
1208	tr ("Invalid monitor count: %lu (must be in range [%lu, %lu])"),
1209	monitorCount, 1, SchemaDefs::MaxGuestMonitors);
1210
1211	AutoCaller autoCaller (this);
1212	CheckComRCReturnRC (autoCaller.rc());
1213
1214	AutoWriteLock alock (this);
1215
1216	HRESULT rc = checkStateDependency (MutableStateDep);
1217	CheckComRCReturnRC (rc);
1218
1219	mHWData.backup();
1220	mHWData->mMonitorCount = monitorCount;
1221
1222	return S_OK;
1223	}
1224
1225	STDMETHODIMP Machine::COMGETTER(BIOSSettings)(IBIOSSettings **biosSettings)
1226	{
1227	if (!biosSettings)
1228	return E_POINTER;
1229
1230	AutoCaller autoCaller (this);
1231	CheckComRCReturnRC (autoCaller.rc());
1232
1233	/* mBIOSSettings is constant during life time, no need to lock */
1234	mBIOSSettings.queryInterfaceTo (biosSettings);
1235
1236	return S_OK;
1237	}
1238
1239	STDMETHODIMP Machine::COMGETTER(HWVirtExEnabled)(TSBool_T *enabled)
1240	{
1241	if (!enabled)
1242	return E_POINTER;
1243
1244	AutoCaller autoCaller (this);
1245	CheckComRCReturnRC (autoCaller.rc());
1246
1247	AutoReadLock alock (this);
1248
1249	*enabled = mHWData->mHWVirtExEnabled;
1250
1251	return S_OK;
1252	}
1253
1254	STDMETHODIMP Machine::COMSETTER(HWVirtExEnabled)(TSBool_T enable)
1255	{
1256	AutoCaller autoCaller (this);
1257	CheckComRCReturnRC (autoCaller.rc());
1258
1259	AutoWriteLock alock (this);
1260
1261	HRESULT rc = checkStateDependency (MutableStateDep);
1262	CheckComRCReturnRC (rc);
1263
1264	/** @todo check validity! */
1265
1266	mHWData.backup();
1267	mHWData->mHWVirtExEnabled = enable;
1268
1269	return S_OK;
1270	}
1271
1272	STDMETHODIMP Machine::COMGETTER(HWVirtExNestedPagingEnabled)(BOOL *enabled)
1273	{
1274	if (!enabled)
1275	return E_POINTER;
1276
1277	AutoCaller autoCaller (this);
1278	CheckComRCReturnRC (autoCaller.rc());
1279
1280	AutoReadLock alock (this);
1281
1282	*enabled = mHWData->mHWVirtExNestedPagingEnabled;
1283
1284	return S_OK;
1285	}
1286
1287	STDMETHODIMP Machine::COMSETTER(HWVirtExNestedPagingEnabled)(BOOL enable)
1288	{
1289	AutoCaller autoCaller (this);
1290	CheckComRCReturnRC (autoCaller.rc());
1291
1292	AutoWriteLock alock (this);
1293
1294	HRESULT rc = checkStateDependency (MutableStateDep);
1295	CheckComRCReturnRC (rc);
1296
1297	/** @todo check validity! */
1298
1299	mHWData.backup();
1300	mHWData->mHWVirtExNestedPagingEnabled = enable;
1301
1302	return S_OK;
1303	}
1304
1305	STDMETHODIMP Machine::COMGETTER(HWVirtExVPIDEnabled)(BOOL *enabled)
1306	{
1307	if (!enabled)
1308	return E_POINTER;
1309
1310	AutoCaller autoCaller (this);
1311	CheckComRCReturnRC (autoCaller.rc());
1312
1313	AutoReadLock alock (this);
1314
1315	*enabled = mHWData->mHWVirtExVPIDEnabled;
1316
1317	return S_OK;
1318	}
1319
1320	STDMETHODIMP Machine::COMSETTER(HWVirtExVPIDEnabled)(BOOL enable)
1321	{
1322	AutoCaller autoCaller (this);
1323	CheckComRCReturnRC (autoCaller.rc());
1324
1325	AutoWriteLock alock (this);
1326
1327	HRESULT rc = checkStateDependency (MutableStateDep);
1328	CheckComRCReturnRC (rc);
1329
1330	/** @todo check validity! */
1331
1332	mHWData.backup();
1333	mHWData->mHWVirtExVPIDEnabled = enable;
1334
1335	return S_OK;
1336	}
1337
1338	STDMETHODIMP Machine::COMGETTER(PAEEnabled)(BOOL *enabled)
1339	{
1340	if (!enabled)
1341	return E_POINTER;
1342
1343	AutoCaller autoCaller (this);
1344	CheckComRCReturnRC (autoCaller.rc());
1345
1346	AutoReadLock alock (this);
1347
1348	*enabled = mHWData->mPAEEnabled;
1349
1350	return S_OK;
1351	}
1352
1353	STDMETHODIMP Machine::COMSETTER(PAEEnabled)(BOOL enable)
1354	{
1355	AutoCaller autoCaller (this);
1356	CheckComRCReturnRC (autoCaller.rc());
1357
1358	AutoWriteLock alock (this);
1359
1360	HRESULT rc = checkStateDependency (MutableStateDep);
1361	CheckComRCReturnRC (rc);
1362
1363	/** @todo check validity! */
1364
1365	mHWData.backup();
1366	mHWData->mPAEEnabled = enable;
1367
1368	return S_OK;
1369	}
1370
1371	STDMETHODIMP Machine::COMGETTER(SnapshotFolder) (BSTR *aSnapshotFolder)
1372	{
1373	CheckComArgOutPointerValid (aSnapshotFolder);
1374
1375	AutoCaller autoCaller (this);
1376	CheckComRCReturnRC (autoCaller.rc());
1377
1378	AutoReadLock alock (this);
1379
1380	mUserData->mSnapshotFolderFull.cloneTo (aSnapshotFolder);
1381
1382	return S_OK;
1383	}
1384
1385	STDMETHODIMP Machine::COMSETTER(SnapshotFolder) (IN_BSTR aSnapshotFolder)
1386	{
1387	/* @todo (r=dmik):
1388	* 1. Allow to change the name of the snapshot folder containing snapshots
1389	* 2. Rename the folder on disk instead of just changing the property
1390	* value (to be smart and not to leave garbage). Note that it cannot be
1391	* done here because the change may be rolled back. Thus, the right
1392	* place is #saveSettings().
1393	*/
1394
1395	AutoCaller autoCaller (this);
1396	CheckComRCReturnRC (autoCaller.rc());
1397
1398	AutoWriteLock alock (this);
1399
1400	HRESULT rc = checkStateDependency (MutableStateDep);
1401	CheckComRCReturnRC (rc);
1402
1403	if (!mData->mCurrentSnapshot.isNull())
1404	return setError (E_FAIL,
1405	tr ("The snapshot folder of a machine with snapshots cannot "
1406	"be changed (please discard all snapshots first)"));
1407
1408	Utf8Str snapshotFolder = aSnapshotFolder;
1409
1410	if (snapshotFolder.isEmpty())
1411	{
1412	if (isInOwnDir())
1413	{
1414	/* the default snapshots folder is 'Snapshots' in the machine dir */
1415	snapshotFolder = Utf8Str ("Snapshots");
1416	}
1417	else
1418	{
1419	/* the default snapshots folder is {UUID}, for backwards
1420	* compatibility and to resolve conflicts */
1421	snapshotFolder = Utf8StrFmt ("{%RTuuid}", mData->mUuid.raw());
1422	}
1423	}
1424
1425	int vrc = calculateFullPath (snapshotFolder, snapshotFolder);
1426	if (RT_FAILURE (vrc))
1427	return setError (E_FAIL,
1428	tr ("Invalid snapshot folder '%ls' (%Rrc)"),
1429	aSnapshotFolder, vrc);
1430
1431	mUserData.backup();
1432	mUserData->mSnapshotFolder = aSnapshotFolder;
1433	mUserData->mSnapshotFolderFull = snapshotFolder;
1434
1435	return S_OK;
1436	}
1437
1438	STDMETHODIMP Machine::
1439	COMGETTER(HardDiskAttachments) (ComSafeArrayOut(IHardDiskAttachment *, aAttachments))
1440	{
1441	if (ComSafeArrayOutIsNull (aAttachments))
1442	return E_POINTER;
1443
1444	AutoCaller autoCaller (this);
1445	CheckComRCReturnRC (autoCaller.rc());
1446
1447	AutoReadLock alock (this);
1448
1449	SafeIfaceArray<IHardDiskAttachment> attachments (mHDData->mAttachments);
1450	attachments.detachTo (ComSafeArrayOutArg (aAttachments));
1451
1452	return S_OK;
1453	}
1454
1455	STDMETHODIMP Machine::COMGETTER(VRDPServer)(IVRDPServer **vrdpServer)
1456	{
1457	#ifdef VBOX_WITH_VRDP
1458	if (!vrdpServer)
1459	return E_POINTER;
1460
1461	AutoCaller autoCaller (this);
1462	CheckComRCReturnRC (autoCaller.rc());
1463
1464	AutoReadLock alock (this);
1465
1466	Assert (!!mVRDPServer);
1467	mVRDPServer.queryInterfaceTo (vrdpServer);
1468
1469	return S_OK;
1470	#else
1471	NOREF(vrdpServer);
1472	ReturnComNotImplemented();
1473	#endif
1474	}
1475
1476	STDMETHODIMP Machine::COMGETTER(DVDDrive) (IDVDDrive **dvdDrive)
1477	{
1478	if (!dvdDrive)
1479	return E_POINTER;
1480
1481	AutoCaller autoCaller (this);
1482	CheckComRCReturnRC (autoCaller.rc());
1483
1484	AutoReadLock alock (this);
1485
1486	Assert (!!mDVDDrive);
1487	mDVDDrive.queryInterfaceTo (dvdDrive);
1488	return S_OK;
1489	}
1490
1491	STDMETHODIMP Machine::COMGETTER(FloppyDrive) (IFloppyDrive **floppyDrive)
1492	{
1493	if (!floppyDrive)
1494	return E_POINTER;
1495
1496	AutoCaller autoCaller (this);
1497	CheckComRCReturnRC (autoCaller.rc());
1498
1499	AutoReadLock alock (this);
1500
1501	Assert (!!mFloppyDrive);
1502	mFloppyDrive.queryInterfaceTo (floppyDrive);
1503	return S_OK;
1504	}
1505
1506	STDMETHODIMP Machine::COMGETTER(AudioAdapter)(IAudioAdapter **audioAdapter)
1507	{
1508	if (!audioAdapter)
1509	return E_POINTER;
1510
1511	AutoCaller autoCaller (this);
1512	CheckComRCReturnRC (autoCaller.rc());
1513
1514	AutoReadLock alock (this);
1515
1516	mAudioAdapter.queryInterfaceTo (audioAdapter);
1517	return S_OK;
1518	}
1519
1520	STDMETHODIMP Machine::COMGETTER(USBController) (IUSBController **aUSBController)
1521	{
1522	#ifdef VBOX_WITH_USB
1523	CheckComArgOutPointerValid (aUSBController);
1524
1525	AutoCaller autoCaller (this);
1526	CheckComRCReturnRC (autoCaller.rc());
1527
1528	MultiResult rc = mParent->host()->checkUSBProxyService();
1529	CheckComRCReturnRC (rc);
1530
1531	AutoReadLock alock (this);
1532
1533	return rc = mUSBController.queryInterfaceTo (aUSBController);
1534	#else
1535	/* Note: The GUI depends on this method returning E_NOTIMPL with no
1536	* extended error info to indicate that USB is simply not available
1537	* (w/o treting it as a failure), for example, as in OSE */
1538	NOREF(aUSBController);
1539	ReturnComNotImplemented();
1540	#endif
1541	}
1542
1543	STDMETHODIMP Machine::COMGETTER(SettingsFilePath) (BSTR *aFilePath)
1544	{
1545	CheckComArgOutPointerValid (aFilePath);
1546
1547	AutoLimitedCaller autoCaller (this);
1548	CheckComRCReturnRC (autoCaller.rc());
1549
1550	AutoReadLock alock (this);
1551
1552	mData->mConfigFileFull.cloneTo (aFilePath);
1553	return S_OK;
1554	}
1555
1556	STDMETHODIMP Machine::
1557	COMGETTER(SettingsFileVersion) (BSTR *aSettingsFileVersion)
1558	{
1559	CheckComArgOutPointerValid (aSettingsFileVersion);
1560
1561	AutoCaller autoCaller (this);
1562	CheckComRCReturnRC (autoCaller.rc());
1563
1564	AutoReadLock alock (this);
1565
1566	mData->mSettingsFileVersion.cloneTo (aSettingsFileVersion);
1567	return S_OK;
1568	}
1569
1570	STDMETHODIMP Machine::COMGETTER(SettingsModified) (BOOL *aModified)
1571	{
1572	CheckComArgOutPointerValid (aModified);
1573
1574	AutoCaller autoCaller (this);
1575	CheckComRCReturnRC (autoCaller.rc());
1576
1577	AutoWriteLock alock (this);
1578
1579	HRESULT rc = checkStateDependency (MutableStateDep);
1580	CheckComRCReturnRC (rc);
1581
1582	if (!isConfigLocked())
1583	{
1584	/*
1585	* if we're ready and isConfigLocked() is FALSE then it means
1586	* that no config file exists yet, so always return TRUE
1587	*/
1588	*aModified = TRUE;
1589	}
1590	else
1591	{
1592	*aModified = isModified();
1593	}
1594
1595	return S_OK;
1596	}
1597
1598	STDMETHODIMP Machine::COMGETTER(SessionState) (SessionState_T *aSessionState)
1599	{
1600	CheckComArgOutPointerValid (aSessionState);
1601
1602	AutoCaller autoCaller (this);
1603	CheckComRCReturnRC (autoCaller.rc());
1604
1605	AutoReadLock alock (this);
1606
1607	*aSessionState = mData->mSession.mState;
1608
1609	return S_OK;
1610	}
1611
1612	STDMETHODIMP Machine::COMGETTER(SessionType) (BSTR *aSessionType)
1613	{
1614	CheckComArgOutPointerValid (aSessionType);
1615
1616	AutoCaller autoCaller (this);
1617	CheckComRCReturnRC (autoCaller.rc());
1618
1619	AutoReadLock alock (this);
1620
1621	if (mData->mSession.mType.isNull())
1622	Bstr("").cloneTo(aSessionType);
1623	else
1624	mData->mSession.mType.cloneTo (aSessionType);
1625
1626	return S_OK;
1627	}
1628
1629	STDMETHODIMP Machine::COMGETTER(SessionPid) (ULONG *aSessionPid)
1630	{
1631	CheckComArgOutPointerValid (aSessionPid);
1632
1633	AutoCaller autoCaller (this);
1634	CheckComRCReturnRC (autoCaller.rc());
1635
1636	AutoReadLock alock (this);
1637
1638	*aSessionPid = mData->mSession.mPid;
1639
1640	return S_OK;
1641	}
1642
1643	STDMETHODIMP Machine::COMGETTER(State) (MachineState_T *machineState)
1644	{
1645	if (!machineState)
1646	return E_POINTER;
1647
1648	AutoCaller autoCaller (this);
1649	CheckComRCReturnRC (autoCaller.rc());
1650
1651	AutoReadLock alock (this);
1652
1653	*machineState = mData->mMachineState;
1654
1655	return S_OK;
1656	}
1657
1658	STDMETHODIMP Machine::COMGETTER(LastStateChange) (LONG64 *aLastStateChange)
1659	{
1660	CheckComArgOutPointerValid (aLastStateChange);
1661
1662	AutoCaller autoCaller (this);
1663	CheckComRCReturnRC (autoCaller.rc());
1664
1665	AutoReadLock alock (this);
1666
1667	*aLastStateChange = RTTimeSpecGetMilli (&mData->mLastStateChange);
1668
1669	return S_OK;
1670	}
1671
1672	STDMETHODIMP Machine::COMGETTER(StateFilePath) (BSTR *aStateFilePath)
1673	{
1674	CheckComArgOutPointerValid (aStateFilePath);
1675
1676	AutoCaller autoCaller (this);
1677	CheckComRCReturnRC (autoCaller.rc());
1678
1679	AutoReadLock alock (this);
1680
1681	if (mSSData->mStateFilePath.isEmpty())
1682	Bstr("").cloneTo(aStateFilePath);
1683	else
1684	mSSData->mStateFilePath.cloneTo (aStateFilePath);
1685
1686	return S_OK;
1687	}
1688
1689	STDMETHODIMP Machine::COMGETTER(LogFolder) (BSTR *aLogFolder)
1690	{
1691	CheckComArgOutPointerValid (aLogFolder);
1692
1693	AutoCaller autoCaller (this);
1694	AssertComRCReturnRC (autoCaller.rc());
1695
1696	AutoReadLock alock (this);
1697
1698	Utf8Str logFolder;
1699	getLogFolder (logFolder);
1700
1701	Bstr (logFolder).cloneTo (aLogFolder);
1702
1703	return S_OK;
1704	}
1705
1706	STDMETHODIMP Machine::COMGETTER(CurrentSnapshot) (ISnapshot **aCurrentSnapshot)
1707	{
1708	CheckComArgOutPointerValid (aCurrentSnapshot);
1709
1710	AutoCaller autoCaller (this);
1711	CheckComRCReturnRC (autoCaller.rc());
1712
1713	AutoReadLock alock (this);
1714
1715	mData->mCurrentSnapshot.queryInterfaceTo (aCurrentSnapshot);
1716
1717	return S_OK;
1718	}
1719
1720	STDMETHODIMP Machine::COMGETTER(SnapshotCount) (ULONG *aSnapshotCount)
1721	{
1722	CheckComArgOutPointerValid (aSnapshotCount);
1723
1724	AutoCaller autoCaller (this);
1725	CheckComRCReturnRC (autoCaller.rc());
1726
1727	AutoReadLock alock (this);
1728
1729	*aSnapshotCount = !mData->mFirstSnapshot ? 0 :
1730	mData->mFirstSnapshot->descendantCount() + 1 /* self */;
1731
1732	return S_OK;
1733	}
1734
1735	STDMETHODIMP Machine::COMGETTER(CurrentStateModified) (BOOL *aCurrentStateModified)
1736	{
1737	CheckComArgOutPointerValid (aCurrentStateModified);
1738
1739	AutoCaller autoCaller (this);
1740	CheckComRCReturnRC (autoCaller.rc());
1741
1742	AutoReadLock alock (this);
1743
1744	/* Note: for machines with no snapshots, we always return FALSE
1745	* (mData->mCurrentStateModified will be TRUE in this case, for historical
1746	* reasons :) */
1747
1748	*aCurrentStateModified = !mData->mFirstSnapshot ? FALSE :
1749	mData->mCurrentStateModified;
1750
1751	return S_OK;
1752	}
1753
1754	STDMETHODIMP
1755	Machine::COMGETTER(SharedFolders) (ComSafeArrayOut (ISharedFolder *, aSharedFolders))
1756	{
1757	CheckComArgOutSafeArrayPointerValid (aSharedFolders);
1758
1759	AutoCaller autoCaller (this);
1760	CheckComRCReturnRC (autoCaller.rc());
1761
1762	AutoReadLock alock (this);
1763
1764	SafeIfaceArray <ISharedFolder> folders (mHWData->mSharedFolders);
1765	folders.detachTo (ComSafeArrayOutArg(aSharedFolders));
1766
1767	return S_OK;
1768	}
1769
1770	STDMETHODIMP
1771	Machine::COMGETTER(ClipboardMode) (ClipboardMode_T *aClipboardMode)
1772	{
1773	CheckComArgOutPointerValid (aClipboardMode);
1774
1775	AutoCaller autoCaller (this);
1776	CheckComRCReturnRC (autoCaller.rc());
1777
1778	AutoReadLock alock (this);
1779
1780	*aClipboardMode = mHWData->mClipboardMode;
1781
1782	return S_OK;
1783	}
1784
1785	STDMETHODIMP
1786	Machine::COMSETTER(ClipboardMode) (ClipboardMode_T aClipboardMode)
1787	{
1788	AutoCaller autoCaller (this);
1789	CheckComRCReturnRC (autoCaller.rc());
1790
1791	AutoWriteLock alock (this);
1792
1793	HRESULT rc = checkStateDependency (MutableStateDep);
1794	CheckComRCReturnRC (rc);
1795
1796	mHWData.backup();
1797	mHWData->mClipboardMode = aClipboardMode;
1798
1799	return S_OK;
1800	}
1801
1802	STDMETHODIMP
1803	Machine::COMGETTER(GuestPropertyNotificationPatterns) (BSTR *aPatterns)
1804	{
1805	CheckComArgOutPointerValid (aPatterns);
1806
1807	AutoCaller autoCaller (this);
1808	CheckComRCReturnRC (autoCaller.rc());
1809
1810	AutoReadLock alock (this);
1811
1812	mHWData->mGuestPropertyNotificationPatterns.cloneTo (aPatterns);
1813
1814	return RT_LIKELY (aPatterns != NULL) ? S_OK : E_OUTOFMEMORY;
1815	}
1816
1817	STDMETHODIMP
1818	Machine::COMSETTER(GuestPropertyNotificationPatterns) (IN_BSTR aPatterns)
1819	{
1820	AssertLogRelReturn (VALID_PTR (aPatterns), E_POINTER);
1821	AutoCaller autoCaller (this);
1822	CheckComRCReturnRC (autoCaller.rc());
1823
1824	AutoWriteLock alock (this);
1825
1826	HRESULT rc = checkStateDependency (MutableStateDep);
1827	CheckComRCReturnRC (rc);
1828
1829	mHWData.backup();
1830	mHWData->mGuestPropertyNotificationPatterns = aPatterns;
1831
1832	return RT_LIKELY (!mHWData->mGuestPropertyNotificationPatterns.isNull())
1833	? S_OK : E_OUTOFMEMORY;
1834	}
1835
1836	STDMETHODIMP
1837	Machine::COMGETTER(StorageControllers) (ComSafeArrayOut(IStorageController *, aStorageControllers))
1838	{
1839	CheckComArgOutSafeArrayPointerValid (aStorageControllers);
1840
1841	AutoCaller autoCaller (this);
1842	CheckComRCReturnRC (autoCaller.rc());
1843
1844	AutoReadLock alock (this);
1845
1846	SafeIfaceArray <IStorageController> ctrls (*mStorageControllers.data());
1847	ctrls.detachTo (ComSafeArrayOutArg(aStorageControllers));
1848
1849	return S_OK;
1850	}
1851
1852	// IMachine methods
1853	/////////////////////////////////////////////////////////////////////////////
1854
1855	STDMETHODIMP Machine::SetBootOrder (ULONG aPosition, DeviceType_T aDevice)
1856	{
1857	if (aPosition < 1 \|\| aPosition > SchemaDefs::MaxBootPosition)
1858	return setError (E_INVALIDARG,
1859	tr ("Invalid boot position: %lu (must be in range [1, %lu])"),
1860	aPosition, SchemaDefs::MaxBootPosition);
1861
1862	if (aDevice == DeviceType_USB)
1863	return setError (E_NOTIMPL,
1864	tr ("Booting from USB device is currently not supported"));
1865
1866	AutoCaller autoCaller (this);
1867	CheckComRCReturnRC (autoCaller.rc());
1868
1869	AutoWriteLock alock (this);
1870
1871	HRESULT rc = checkStateDependency (MutableStateDep);
1872	CheckComRCReturnRC (rc);
1873
1874	mHWData.backup();
1875	mHWData->mBootOrder [aPosition - 1] = aDevice;
1876
1877	return S_OK;
1878	}
1879
1880	STDMETHODIMP Machine::GetBootOrder (ULONG aPosition, DeviceType_T *aDevice)
1881	{
1882	if (aPosition < 1 \|\| aPosition > SchemaDefs::MaxBootPosition)
1883	return setError (E_INVALIDARG,
1884	tr ("Invalid boot position: %lu (must be in range [1, %lu])"),
1885	aPosition, SchemaDefs::MaxBootPosition);
1886
1887	AutoCaller autoCaller (this);
1888	CheckComRCReturnRC (autoCaller.rc());
1889
1890	AutoReadLock alock (this);
1891
1892	*aDevice = mHWData->mBootOrder [aPosition - 1];
1893
1894	return S_OK;
1895	}
1896
1897	STDMETHODIMP Machine::AttachHardDisk(IN_BSTR aId,
1898	IN_BSTR aControllerName, LONG aControllerPort,
1899	LONG aDevice)
1900	{
1901	LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld\n",
1902	aControllerName, aControllerPort, aDevice));
1903
1904	AutoCaller autoCaller (this);
1905	CheckComRCReturnRC (autoCaller.rc());
1906
1907	/* VirtualBox::findHardDisk() need read lock; also we want to make sure the
1908	* hard disk object we pick up doesn't get unregistered before we finish. */
1909	AutoReadLock vboxLock (mParent);
1910	AutoWriteLock alock (this);
1911
1912	HRESULT rc = checkStateDependency (MutableStateDep);
1913	CheckComRCReturnRC (rc);
1914
1915	/// @todo NEWMEDIA implicit machine registration
1916	if (!mData->mRegistered)
1917	return setError (VBOX_E_INVALID_OBJECT_STATE,
1918	tr ("Cannot attach hard disks to an unregistered machine"));
1919
1920	AssertReturn (mData->mMachineState != MachineState_Saved, E_FAIL);
1921
1922	if (Global::IsOnlineOrTransient (mData->mMachineState))
1923	return setError (VBOX_E_INVALID_VM_STATE,
1924	tr ("Invalid machine state: %d"), mData->mMachineState);
1925
1926	/* Check for an existing controller. */
1927	ComObjPtr<StorageController> ctl;
1928	rc = getStorageControllerByName(aControllerName, ctl, true /* aSetError */);
1929	CheckComRCReturnRC(rc);
1930
1931	/* check that the port and device are not out of range. */
1932	ULONG portCount;
1933	ULONG devicesPerPort;
1934	rc = ctl->COMGETTER(PortCount)(&portCount);
1935	CheckComRCReturnRC(rc);
1936	rc = ctl->COMGETTER(MaxDevicesPerPortCount)(&devicesPerPort);
1937	CheckComRCReturnRC(rc);
1938
1939	if ( (aControllerPort < 0)
1940	\|\| (aControllerPort >= (LONG)portCount)
1941	\|\| (aDevice < 0)
1942	\|\| (aDevice >= (LONG)devicesPerPort)
1943	)
1944	return setError (E_INVALIDARG,
1945	tr ("The port and/or count parameter are out of range [%lu:%lu]"),
1946	portCount, devicesPerPort);
1947
1948	/* check if the device slot is already busy */
1949	HDData::AttachmentList::const_iterator it =
1950	std::find_if (mHDData->mAttachments.begin(),
1951	mHDData->mAttachments.end(),
1952	HardDiskAttachment::EqualsTo (aControllerName, aControllerPort, aDevice));
1953
1954	if (it != mHDData->mAttachments.end())
1955	{
1956	ComObjPtr<HardDisk> hd = (*it)->hardDisk();
1957	AutoReadLock hdLock (hd);
1958	return setError (VBOX_E_OBJECT_IN_USE,
1959	tr ("Hard disk '%ls' is already attached to device slot %d on "
1960	"port %d of controller '%ls' of this virtual machine"),
1961	hd->locationFull().raw(), aDevice, aControllerPort, aControllerName);
1962	}
1963
1964	Guid id(aId);
1965
1966	/* find a hard disk by UUID */
1967	ComObjPtr<HardDisk> hd;
1968	rc = mParent->findHardDisk(&id, NULL, true /* aSetError */, &hd);
1969	CheckComRCReturnRC (rc);
1970
1971	AutoCaller hdCaller (hd);
1972	CheckComRCReturnRC (hdCaller.rc());
1973
1974	AutoWriteLock hdLock (hd);
1975
1976	if (std::find_if (mHDData->mAttachments.begin(),
1977	mHDData->mAttachments.end(),
1978	HardDiskAttachment::RefersTo (hd)) !=
1979	mHDData->mAttachments.end())
1980	{
1981	return setError (VBOX_E_OBJECT_IN_USE,
1982	tr ("Hard disk '%ls' is already attached to this virtual machine"),
1983	hd->locationFull().raw());
1984	}
1985
1986	bool indirect = hd->isReadOnly();
1987	bool associate = true;
1988
1989	do
1990	{
1991	if (mHDData.isBackedUp())
1992	{
1993	const HDData::AttachmentList &oldAtts =
1994	mHDData.backedUpData()->mAttachments;
1995
1996	/* check if the hard disk was attached to the VM before we started
1997	* changing attachemnts in which case the attachment just needs to
1998	* be restored */
1999	HDData::AttachmentList::const_iterator it =
2000	std::find_if (oldAtts.begin(), oldAtts.end(),
2001	HardDiskAttachment::RefersTo (hd));
2002	if (it != oldAtts.end())
2003	{
2004	AssertReturn (!indirect, E_FAIL);
2005
2006	/* see if it's the same bus/channel/device */
2007	if ((*it)->device() == aDevice &&
2008	(*it)->port() == aControllerPort &&
2009	(*it)->controller() == aControllerName)
2010	{
2011	/* the simplest case: restore the whole attachment
2012	* and return, nothing else to do */
2013	mHDData->mAttachments.push_back (*it);
2014	return S_OK;
2015	}
2016
2017	/* bus/channel/device differ; we need a new attachment object,
2018	* but don't try to associate it again */
2019	associate = false;
2020	break;
2021	}
2022	}
2023
2024	/* go further only if the attachment is to be indirect */
2025	if (!indirect)
2026	break;
2027
2028	/* perform the so called smart attachment logic for indirect
2029	* attachments. Note that smart attachment is only applicable to base
2030	* hard disks. */
2031
2032	if (hd->parent().isNull())
2033	{
2034	/* first, investigate the backup copy of the current hard disk
2035	* attachments to make it possible to re-attach existing diffs to
2036	* another device slot w/o losing their contents */
2037	if (mHDData.isBackedUp())
2038	{
2039	const HDData::AttachmentList &oldAtts =
2040	mHDData.backedUpData()->mAttachments;
2041
2042	HDData::AttachmentList::const_iterator foundIt = oldAtts.end();
2043	uint32_t foundLevel = 0;
2044
2045	for (HDData::AttachmentList::const_iterator
2046	it = oldAtts.begin(); it != oldAtts.end(); ++ it)
2047	{
2048	uint32_t level = 0;
2049	if ((*it)->hardDisk()->root (&level).equalsTo (hd))
2050	{
2051	/* skip the hard disk if its currently attached (we
2052	* cannot attach the same hard disk twice) */
2053	if (std::find_if (mHDData->mAttachments.begin(),
2054	mHDData->mAttachments.end(),
2055	HardDiskAttachment::RefersTo (
2056	(*it)->hardDisk())) !=
2057	mHDData->mAttachments.end())
2058	continue;
2059
2060	/* matched device, channel and bus (i.e. attached to the
2061	* same place) will win and immediately stop the search;
2062	* otherwise the attachment that has the youngest
2063	* descendant of hd will be used
2064	*/
2065	if ((*it)->device() == aDevice &&
2066	(*it)->port() == aControllerPort &&
2067	(*it)->controller() == aControllerName)
2068	{
2069	/* the simplest case: restore the whole attachment
2070	* and return, nothing else to do */
2071	mHDData->mAttachments.push_back (*it);
2072	return S_OK;
2073	}
2074	else
2075	if (foundIt == oldAtts.end() \|\|
2076	level > foundLevel /* prefer younger */)
2077	{
2078	foundIt = it;
2079	foundLevel = level;
2080	}
2081	}
2082	}
2083
2084	if (foundIt != oldAtts.end())
2085	{
2086	/* use the previously attached hard disk */
2087	hd = (*foundIt)->hardDisk();
2088	hdCaller.attach (hd);
2089	CheckComRCReturnRC (hdCaller.rc());
2090	hdLock.attach (hd);
2091	/* not implicit, doesn't require association with this VM */
2092	indirect = false;
2093	associate = false;
2094	/* go right to the HardDiskAttachment creation */
2095	break;
2096	}
2097	}
2098
2099	/* then, search through snapshots for the best diff in the given
2100	* hard disk's chain to base the new diff on */
2101
2102	ComObjPtr<HardDisk> base;
2103	ComObjPtr<Snapshot> snap = mData->mCurrentSnapshot;
2104	while (snap)
2105	{
2106	AutoReadLock snapLock (snap);
2107
2108	const HDData::AttachmentList &snapAtts =
2109	snap->data().mMachine->mHDData->mAttachments;
2110
2111	HDData::AttachmentList::const_iterator foundIt = snapAtts.end();
2112	uint32_t foundLevel = 0;
2113
2114	for (HDData::AttachmentList::const_iterator
2115	it = snapAtts.begin(); it != snapAtts.end(); ++ it)
2116	{
2117	uint32_t level = 0;
2118	if ((*it)->hardDisk()->root (&level).equalsTo (hd))
2119	{
2120	/* matched device, channel and bus (i.e. attached to the
2121	* same place) will win and immediately stop the search;
2122	* otherwise the attachment that has the youngest
2123	* descendant of hd will be used
2124	*/
2125	if ((*it)->device() == aDevice &&
2126	(*it)->port() == aControllerPort &&
2127	(*it)->controller() == aControllerName)
2128	{
2129	foundIt = it;
2130	break;
2131	}
2132	else
2133	if (foundIt == snapAtts.end() \|\|
2134	level > foundLevel /* prefer younger */)
2135	{
2136	foundIt = it;
2137	foundLevel = level;
2138	}
2139	}
2140	}
2141
2142	if (foundIt != snapAtts.end())
2143	{
2144	base = (*foundIt)->hardDisk();
2145	break;
2146	}
2147
2148	snap = snap->parent();
2149	}
2150
2151	/* found a suitable diff, use it as a base */
2152	if (!base.isNull())
2153	{
2154	hd = base;
2155	hdCaller.attach (hd);
2156	CheckComRCReturnRC (hdCaller.rc());
2157	hdLock.attach (hd);
2158	}
2159	}
2160
2161	ComObjPtr<HardDisk> diff;
2162	diff.createObject();
2163	rc = diff->init(mParent,
2164	hd->preferredDiffFormat(),
2165	BstrFmt ("%ls"RTPATH_SLASH_STR,
2166	mUserData->mSnapshotFolderFull.raw()));
2167	CheckComRCReturnRC (rc);
2168
2169	/* make sure the hard disk is not modified before createDiffStorage() */
2170	rc = hd->LockRead (NULL);
2171	CheckComRCReturnRC (rc);
2172
2173	/* will leave the lock before the potentially lengthy operation, so
2174	* protect with the special state */
2175	MachineState_T oldState = mData->mMachineState;
2176	setMachineState (MachineState_SettingUp);
2177
2178	hdLock.leave();
2179	alock.leave();
2180	vboxLock.unlock();
2181
2182	rc = hd->createDiffStorageAndWait (diff, HardDiskVariant_Standard);
2183
2184	alock.enter();
2185	hdLock.enter();
2186
2187	setMachineState (oldState);
2188
2189	hd->UnlockRead (NULL);
2190
2191	CheckComRCReturnRC (rc);
2192
2193	/* use the created diff for the actual attachment */
2194	hd = diff;
2195	hdCaller.attach (hd);
2196	CheckComRCReturnRC (hdCaller.rc());
2197	hdLock.attach (hd);
2198	}
2199	while (0);
2200
2201	ComObjPtr<HardDiskAttachment> attachment;
2202	attachment.createObject();
2203	rc = attachment->init (hd, aControllerName, aControllerPort, aDevice, indirect);
2204	CheckComRCReturnRC (rc);
2205
2206	if (associate)
2207	{
2208	/* as the last step, associate the hard disk to the VM */
2209	rc = hd->attachTo (mData->mUuid);
2210	/* here we can fail because of Deleting, or being in process of
2211	* creating a Diff */
2212	CheckComRCReturnRC (rc);
2213	}
2214
2215	/* sucsess: finally remember the attachment */
2216	mHDData.backup();
2217	mHDData->mAttachments.push_back (attachment);
2218
2219	return rc;
2220	}
2221
2222	STDMETHODIMP Machine::GetHardDisk(IN_BSTR aControllerName, LONG aControllerPort,
2223	LONG aDevice, IHardDisk **aHardDisk)
2224	{
2225	LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld\n",
2226	aControllerName, aControllerPort, aDevice));
2227
2228	CheckComArgNotNull (aControllerName);
2229	CheckComArgOutPointerValid (aHardDisk);
2230
2231	AutoCaller autoCaller (this);
2232	CheckComRCReturnRC (autoCaller.rc());
2233
2234	AutoReadLock alock (this);
2235
2236	*aHardDisk = NULL;
2237
2238	HDData::AttachmentList::const_iterator it =
2239	std::find_if (mHDData->mAttachments.begin(),
2240	mHDData->mAttachments.end(),
2241	HardDiskAttachment::EqualsTo (aControllerName, aControllerPort, aDevice));
2242
2243	if (it == mHDData->mAttachments.end())
2244	return setError (VBOX_E_OBJECT_NOT_FOUND,
2245	tr ("No hard disk attached to device slot %d on port %d of controller '%ls'"),
2246	aDevice, aControllerPort, aControllerName);
2247
2248	(*it)->hardDisk().queryInterfaceTo (aHardDisk);
2249
2250	return S_OK;
2251	}
2252
2253	STDMETHODIMP Machine::DetachHardDisk(IN_BSTR aControllerName, LONG aControllerPort,
2254	LONG aDevice)
2255	{
2256	CheckComArgNotNull (aControllerName);
2257
2258	LogFlowThisFunc(("aControllerName=\"%ls\" aControllerPort=%ld aDevice=%ld\n",
2259	aControllerName, aControllerPort, aDevice));
2260
2261	AutoCaller autoCaller (this);
2262	CheckComRCReturnRC (autoCaller.rc());
2263
2264	AutoWriteLock alock (this);
2265
2266	HRESULT rc = checkStateDependency (MutableStateDep);
2267	CheckComRCReturnRC (rc);
2268
2269	AssertReturn (mData->mMachineState != MachineState_Saved, E_FAIL);
2270
2271	if (Global::IsOnlineOrTransient (mData->mMachineState))
2272	return setError (VBOX_E_INVALID_VM_STATE,
2273	tr ("Invalid machine state: %d"), mData->mMachineState);
2274
2275	HDData::AttachmentList::const_iterator it =
2276	std::find_if (mHDData->mAttachments.begin(),
2277	mHDData->mAttachments.end(),
2278	HardDiskAttachment::EqualsTo (aControllerName, aControllerPort, aDevice));
2279
2280	if (it == mHDData->mAttachments.end())
2281	return setError (VBOX_E_OBJECT_NOT_FOUND,
2282	tr ("No hard disk attached to device slot %d on port %d of controller '%ls'"),
2283	aDevice, aControllerPort, aControllerName);
2284
2285	ComObjPtr<HardDiskAttachment> hda = *it;
2286	ComObjPtr<HardDisk> hd = hda->hardDisk();
2287
2288	if (hda->isImplicit())
2289	{
2290	/* attempt to implicitly delete the implicitly created diff */
2291
2292	/// @todo move the implicit flag from HardDiskAttachment to HardDisk
2293	/// and forbid any hard disk operation when it is implicit. Or maybe
2294	/// a special media state for it to make it even more simple.
2295
2296	Assert (mHDData.isBackedUp());
2297
2298	/* will leave the lock before the potentially lengthy operation, so
2299	* protect with the special state */
2300	MachineState_T oldState = mData->mMachineState;
2301	setMachineState (MachineState_SettingUp);
2302
2303	alock.leave();
2304
2305	rc = hd->deleteStorageAndWait();
2306
2307	alock.enter();
2308
2309	setMachineState (oldState);
2310
2311	CheckComRCReturnRC (rc);
2312	}
2313
2314	mHDData.backup();
2315
2316	/* we cannot use erase (it) below because backup() above will create
2317	* a copy of the list and make this copy active, but the iterator
2318	* still refers to the original and is not valid for the copy */
2319	mHDData->mAttachments.remove (hda);
2320
2321	return S_OK;
2322	}
2323
2324	STDMETHODIMP Machine::GetSerialPort (ULONG slot, ISerialPort **port)
2325	{
2326	CheckComArgOutPointerValid (port);
2327	CheckComArgExpr (slot, slot < RT_ELEMENTS (mSerialPorts));
2328
2329	AutoCaller autoCaller (this);
2330	CheckComRCReturnRC (autoCaller.rc());
2331
2332	AutoReadLock alock (this);
2333
2334	mSerialPorts [slot].queryInterfaceTo (port);
2335
2336	return S_OK;
2337	}
2338
2339	STDMETHODIMP Machine::GetParallelPort (ULONG slot, IParallelPort **port)
2340	{
2341	CheckComArgOutPointerValid (port);
2342	CheckComArgExpr (slot, slot < RT_ELEMENTS (mParallelPorts));
2343
2344	AutoCaller autoCaller (this);
2345	CheckComRCReturnRC (autoCaller.rc());
2346
2347	AutoReadLock alock (this);
2348
2349	mParallelPorts [slot].queryInterfaceTo (port);
2350
2351	return S_OK;
2352	}
2353
2354	STDMETHODIMP Machine::GetNetworkAdapter (ULONG slot, INetworkAdapter **adapter)
2355	{
2356	CheckComArgOutPointerValid (adapter);
2357	CheckComArgExpr (slot, slot < RT_ELEMENTS (mNetworkAdapters));
2358
2359	AutoCaller autoCaller (this);
2360	CheckComRCReturnRC (autoCaller.rc());
2361
2362	AutoReadLock alock (this);
2363
2364	mNetworkAdapters [slot].queryInterfaceTo (adapter);
2365
2366	return S_OK;
2367	}
2368
2369	/**
2370	* @note Locks this object for reading.
2371	*/
2372	STDMETHODIMP Machine::GetNextExtraDataKey (IN_BSTR aKey, BSTR aNextKey, BSTR aNextValue)
2373	{
2374	CheckComArgOutPointerValid (aNextKey);
2375
2376	AutoCaller autoCaller (this);
2377	CheckComRCReturnRC (autoCaller.rc());
2378
2379	/* start with nothing found */
2380	Bstr("").cloneTo(aNextKey);
2381	if (aNextValue)
2382	Bstr("").cloneTo(aNextValue);
2383
2384	/* if we're ready and isConfigLocked() is FALSE then it means
2385	* that no config file exists yet, so return shortly */
2386	if (!isConfigLocked())
2387	return S_OK;
2388
2389	HRESULT rc = S_OK;
2390
2391	Bstr bstrInKey(aKey);
2392
2393	/* serialize file access (prevent writes) */
2394	AutoReadLock alock (this);
2395
2396	try
2397	{
2398	using namespace settings;
2399	using namespace xml;
2400
2401	/* load the settings file (we don't reuse the existing handle but
2402	* request a new one to allow for concurrent multithreaded reads) */
2403	File file (File::Mode_Read, Utf8Str (mData->mConfigFileFull));
2404	XmlTreeBackend tree;
2405
2406	rc = VirtualBox::loadSettingsTree_Again (tree, file);
2407	CheckComRCReturnRC (rc);
2408
2409	Key machineNode = tree.rootKey().key ("Machine");
2410	Key extraDataNode = machineNode.findKey ("ExtraData");
2411
2412	if (!extraDataNode.isNull())
2413	{
2414	Key::List items = extraDataNode.keys ("ExtraDataItem");
2415	if (items.size())
2416	{
2417	for (Key::List::const_iterator it = items.begin();
2418	it != items.end(); ++ it)
2419	{
2420	Bstr key = (*it).stringValue ("name");
2421
2422	/* if we're supposed to return the first one */
2423	if (bstrInKey.isEmpty())
2424	{
2425	key.cloneTo (aNextKey);
2426	if (aNextValue)
2427	{
2428	Bstr val = (*it).stringValue ("value");
2429	val.cloneTo (aNextValue);
2430	}
2431	return S_OK;
2432	}
2433
2434	/* did we find the key we're looking for? */
2435	if (key == bstrInKey)
2436	{
2437	++ it;
2438	/* is there another item? */
2439	if (it != items.end())
2440	{
2441	Bstr key = (*it).stringValue ("name");
2442	key.cloneTo (aNextKey);
2443	if (aNextValue)
2444	{
2445	Bstr val = (*it).stringValue ("value");
2446	val.cloneTo (aNextValue);
2447	}
2448	}
2449	/* else it's the last one, arguments are already NULL */
2450	return S_OK;
2451	}
2452	}
2453	}
2454	}
2455
2456	/* Here we are when a) there are no items at all or b) there are items
2457	* but none of them equals the requested non-NULL key. b) is an
2458	* error as well as a) if the key is non-NULL. When the key is NULL
2459	* (which is the case only when there are no items), we just fall
2460	* through to return NULLs and S_OK. */
2461
2462	if (!bstrInKey.isEmpty())
2463	return setError (VBOX_E_OBJECT_NOT_FOUND,
2464	tr ("Could not find the extra data key '%ls'"), bstrInKey.raw());
2465	}
2466	catch (...)
2467	{
2468	rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
2469	}
2470
2471	return rc;
2472	}
2473
2474	/**
2475	* @note Locks this object for reading.
2476	*/
2477	STDMETHODIMP Machine::GetExtraData (IN_BSTR aKey, BSTR *aValue)
2478	{
2479	CheckComArgNotNull (aKey);
2480	CheckComArgOutPointerValid (aValue);
2481
2482	AutoCaller autoCaller (this);
2483	CheckComRCReturnRC (autoCaller.rc());
2484
2485	/* serialize file access (prevent writes) */
2486	AutoReadLock alock (this);
2487
2488	/* start with nothing found */
2489	Bstr("").cloneTo(aValue);
2490
2491	/* if we're ready and isConfigLocked() is FALSE then it means
2492	* that no config file exists yet, so return shortly */
2493	if (!isConfigLocked())
2494	return S_OK;
2495
2496	Utf8Str val;
2497	HRESULT rc = getExtraData(Utf8Str(aKey), val);
2498	if (SUCCEEDED(rc))
2499	val.cloneTo (aValue);
2500
2501	return rc;
2502	}
2503
2504	HRESULT Machine::getExtraData(const Utf8Str &aKey, Utf8Str &aValue)
2505	{
2506	HRESULT rc = S_OK;
2507
2508	try
2509	{
2510	using namespace settings;
2511	using namespace xml;
2512
2513	/* load the settings file (we don't reuse the existing handle but
2514	* request a new one to allow for concurrent multithreaded reads) */
2515	File file (File::Mode_Read, Utf8Str (mData->mConfigFileFull));
2516	XmlTreeBackend tree;
2517
2518	rc = VirtualBox::loadSettingsTree_Again (tree, file);
2519	CheckComRCReturnRC (rc);
2520
2521	Key machineNode = tree.rootKey().key ("Machine");
2522	Key extraDataNode = machineNode.findKey ("ExtraData");
2523
2524	if (!extraDataNode.isNull())
2525	{
2526	/* check if the key exists */
2527	Key::List items = extraDataNode.keys ("ExtraDataItem");
2528	for (Key::List::const_iterator it = items.begin();
2529	it != items.end(); ++ it)
2530	{
2531	if (aKey == (*it).stringValue ("name"))
2532	{
2533	aValue = (*it).stringValue ("value");
2534	break;
2535	}
2536	}
2537	}
2538	}
2539	catch (...)
2540	{
2541	rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
2542	}
2543
2544	return rc;
2545	}
2546
2547	/**
2548	* @note Locks mParent for writing + this object for writing.
2549	*/
2550	STDMETHODIMP Machine::SetExtraData (IN_BSTR aKey, IN_BSTR aValue)
2551	{
2552	CheckComArgNotNull (aKey);
2553
2554	AutoCaller autoCaller (this);
2555	CheckComRCReturnRC (autoCaller.rc());
2556
2557	/* VirtualBox::onExtraDataCanChange() and saveSettings() need mParent
2558	* lock (saveSettings() needs a write one). This object's write lock is
2559	* also necessary to serialize file access (prevent concurrent reads and
2560	* writes). */
2561	AutoMultiWriteLock2 alock (mParent, this);
2562
2563	if (mType == IsSnapshotMachine)
2564	{
2565	HRESULT rc = checkStateDependency (MutableStateDep);
2566	CheckComRCReturnRC (rc);
2567	}
2568
2569	Bstr val;
2570	if (!aValue)
2571	val = (const char *)"";
2572	else
2573	val = aValue;
2574
2575
2576	bool changed = false;
2577	HRESULT rc = S_OK;
2578
2579	/* If we're ready and isConfigLocked() is FALSE then it means that no
2580	* config file exists yet, so call saveSettings() to create one. */
2581	if (!isConfigLocked())
2582	{
2583	rc = saveSettings();
2584	CheckComRCReturnRC (rc);
2585	}
2586
2587	try
2588	{
2589	using namespace settings;
2590	using namespace xml;
2591
2592	/* load the settings file */
2593	File file (mData->mHandleCfgFile, Utf8Str (mData->mConfigFileFull));
2594	XmlTreeBackend tree;
2595
2596	rc = VirtualBox::loadSettingsTree_ForUpdate (tree, file);
2597	CheckComRCReturnRC (rc);
2598
2599	const Utf8Str key = aKey;
2600	Bstr oldVal("");
2601
2602	Key machineNode = tree.rootKey().key ("Machine");
2603	Key extraDataNode = machineNode.createKey ("ExtraData");
2604	Key extraDataItemNode;
2605
2606	Key::List items = extraDataNode.keys ("ExtraDataItem");
2607	for (Key::List::const_iterator it = items.begin();
2608	it != items.end(); ++ it)
2609	{
2610	if (key == (*it).stringValue ("name"))
2611	{
2612	extraDataItemNode = *it;
2613	oldVal = (*it).stringValue ("value");
2614	break;
2615	}
2616	}
2617
2618	/* When no key is found, oldVal is empty string */
2619	changed = oldVal != val;
2620
2621	if (changed)
2622	{
2623	/* ask for permission from all listeners */
2624	Bstr error;
2625	if (!mParent->onExtraDataCanChange (mData->mUuid, aKey, val, error))
2626	{
2627	const char *sep = error.isEmpty() ? "" : ": ";
2628	CBSTR err = error.isNull() ? (CBSTR) L"" : error.raw();
2629	LogWarningFunc (("Someone vetoed! Change refused%s%ls\n",
2630	sep, err));
2631	return setError (E_ACCESSDENIED,
2632	tr ("Could not set extra data because someone refused "
2633	"the requested change of '%ls' to '%ls'%s%ls"),
2634	aKey, val.raw(), sep, err);
2635	}
2636
2637	if (!val.isEmpty())
2638	{
2639	if (extraDataItemNode.isNull())
2640	{
2641	extraDataItemNode = extraDataNode.appendKey ("ExtraDataItem");
2642	extraDataItemNode.setStringValue ("name", key);
2643	}
2644	extraDataItemNode.setStringValue ("value", Utf8Str (aValue));
2645	}
2646	else
2647	{
2648	/* an old value does for sure exist here (XML schema
2649	* guarantees that "value" may not absent in the
2650	* <ExtraDataItem> element) */
2651	Assert (!extraDataItemNode.isNull());
2652	extraDataItemNode.zap();
2653	}
2654
2655	/* save settings on success */
2656	rc = VirtualBox::saveSettingsTree (tree, file,
2657	mData->mSettingsFileVersion);
2658	CheckComRCReturnRC (rc);
2659	}
2660	}
2661	catch (...)
2662	{
2663	rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
2664	}
2665
2666	/* fire a notification */
2667	if (SUCCEEDED (rc) && changed)
2668	mParent->onExtraDataChange (mData->mUuid, aKey, aValue);
2669
2670	return rc;
2671	}
2672
2673	STDMETHODIMP Machine::SaveSettings()
2674	{
2675	AutoCaller autoCaller (this);
2676	CheckComRCReturnRC (autoCaller.rc());
2677
2678	/* saveSettings() needs mParent lock */
2679	AutoMultiWriteLock2 alock (mParent, this);
2680
2681	/* when there was auto-conversion, we want to save the file even if
2682	* the VM is saved */
2683	StateDependency dep = mData->mSettingsFileVersion != VBOX_XML_VERSION_FULL ?
2684	MutableOrSavedStateDep : MutableStateDep;
2685
2686	HRESULT rc = checkStateDependency (dep);
2687	CheckComRCReturnRC (rc);
2688
2689	/* the settings file path may never be null */
2690	ComAssertRet (mData->mConfigFileFull, E_FAIL);
2691
2692	/* save all VM data excluding snapshots */
2693	return saveSettings();
2694	}
2695
2696	STDMETHODIMP Machine::SaveSettingsWithBackup (BSTR *aBakFileName)
2697	{
2698	CheckComArgOutPointerValid (aBakFileName);
2699
2700	AutoCaller autoCaller (this);
2701	CheckComRCReturnRC (autoCaller.rc());
2702
2703	/* saveSettings() needs mParent lock */
2704	AutoMultiWriteLock2 alock (mParent, this);
2705
2706	/* when there was auto-conversion, we want to save the file even if
2707	* the VM is saved */
2708	StateDependency dep = mData->mSettingsFileVersion != VBOX_XML_VERSION_FULL ?
2709	MutableOrSavedStateDep : MutableStateDep;
2710
2711	HRESULT rc = checkStateDependency (dep);
2712	CheckComRCReturnRC (rc);
2713
2714	/* the settings file path may never be null */
2715	ComAssertRet (mData->mConfigFileFull, E_FAIL);
2716
2717	/* perform backup only when there was auto-conversion */
2718	if (mData->mSettingsFileVersion != VBOX_XML_VERSION_FULL)
2719	{
2720	Bstr bakFileName;
2721
2722	HRESULT rc = VirtualBox::backupSettingsFile (mData->mConfigFileFull,
2723	mData->mSettingsFileVersion,
2724	bakFileName);
2725	CheckComRCReturnRC (rc);
2726
2727	bakFileName.cloneTo (aBakFileName);
2728	}
2729
2730	/* save all VM data excluding snapshots */
2731	return saveSettings();
2732	}
2733
2734	STDMETHODIMP Machine::DiscardSettings()
2735	{
2736	AutoCaller autoCaller (this);
2737	CheckComRCReturnRC (autoCaller.rc());
2738
2739	AutoWriteLock alock (this);
2740
2741	HRESULT rc = checkStateDependency (MutableStateDep);
2742	CheckComRCReturnRC (rc);
2743
2744	/*
2745	* during this rollback, the session will be notified if data has
2746	* been actually changed
2747	*/
2748	rollback (true /* aNotify */);
2749
2750	return S_OK;
2751	}
2752
2753	STDMETHODIMP Machine::DeleteSettings()
2754	{
2755	AutoCaller autoCaller (this);
2756	CheckComRCReturnRC (autoCaller.rc());
2757
2758	AutoWriteLock alock (this);
2759
2760	HRESULT rc = checkStateDependency (MutableStateDep);
2761	CheckComRCReturnRC (rc);
2762
2763	if (mData->mRegistered)
2764	return setError (VBOX_E_INVALID_VM_STATE,
2765	tr ("Cannot delete settings of a registered machine"));
2766
2767	/* delete the settings only when the file actually exists */
2768	if (isConfigLocked())
2769	{
2770	unlockConfig();
2771	int vrc = RTFileDelete (Utf8Str (mData->mConfigFileFull));
2772	if (RT_FAILURE (vrc))
2773	return setError (VBOX_E_IPRT_ERROR,
2774	tr ("Could not delete the settings file '%ls' (%Rrc)"),
2775	mData->mConfigFileFull.raw(), vrc);
2776
2777	/* delete the Logs folder, nothing important should be left
2778	* there (we don't check for errors because the user might have
2779	* some private files there that we don't want to delete) */
2780	Utf8Str logFolder;
2781	getLogFolder (logFolder);
2782	Assert (!logFolder.isEmpty());
2783	if (RTDirExists (logFolder))
2784	{
2785	/* Delete all VBox.log[.N] files from the Logs folder
2786	* (this must be in sync with the rotation logic in
2787	* Console::powerUpThread()). Also, delete the VBox.png[.N]
2788	* files that may have been created by the GUI. */
2789	Utf8Str log = Utf8StrFmt ("%s/VBox.log", logFolder.raw());
2790	RTFileDelete (log);
2791	log = Utf8StrFmt ("%s/VBox.png", logFolder.raw());
2792	RTFileDelete (log);
2793	for (int i = 3; i >= 0; i--)
2794	{
2795	log = Utf8StrFmt ("%s/VBox.log.%d", logFolder.raw(), i);
2796	RTFileDelete (log);
2797	log = Utf8StrFmt ("%s/VBox.png.%d", logFolder.raw(), i);
2798	RTFileDelete (log);
2799	}
2800
2801	RTDirRemove (logFolder);
2802	}
2803
2804	/* delete the Snapshots folder, nothing important should be left
2805	* there (we don't check for errors because the user might have
2806	* some private files there that we don't want to delete) */
2807	Utf8Str snapshotFolder = mUserData->mSnapshotFolderFull;
2808	Assert (!snapshotFolder.isEmpty());
2809	if (RTDirExists (snapshotFolder))
2810	RTDirRemove (snapshotFolder);
2811
2812	/* delete the directory that contains the settings file, but only
2813	* if it matches the VM name (i.e. a structure created by default in
2814	* prepareSaveSettings()) */
2815	{
2816	Utf8Str settingsDir;
2817	if (isInOwnDir (&settingsDir))
2818	RTDirRemove (settingsDir);
2819	}
2820	}
2821
2822	return S_OK;
2823	}
2824
2825	STDMETHODIMP Machine::GetSnapshot (IN_BSTR aId, ISnapshot **aSnapshot)
2826	{
2827	CheckComArgOutPointerValid (aSnapshot);
2828
2829	AutoCaller autoCaller (this);
2830	CheckComRCReturnRC (autoCaller.rc());
2831
2832	AutoReadLock alock (this);
2833
2834	Guid id(aId);
2835	ComObjPtr <Snapshot> snapshot;
2836
2837	HRESULT rc = findSnapshot (id, snapshot, true /* aSetError */);
2838	snapshot.queryInterfaceTo (aSnapshot);
2839
2840	return rc;
2841	}
2842
2843	STDMETHODIMP Machine::FindSnapshot (IN_BSTR aName, ISnapshot **aSnapshot)
2844	{
2845	CheckComArgNotNull (aName);
2846	CheckComArgOutPointerValid (aSnapshot);
2847
2848	AutoCaller autoCaller (this);
2849	CheckComRCReturnRC (autoCaller.rc());
2850
2851	AutoReadLock alock (this);
2852
2853	ComObjPtr <Snapshot> snapshot;
2854
2855	HRESULT rc = findSnapshot (aName, snapshot, true /* aSetError */);
2856	snapshot.queryInterfaceTo (aSnapshot);
2857
2858	return rc;
2859	}
2860
2861	STDMETHODIMP Machine::SetCurrentSnapshot (IN_BSTR /* aId */)
2862	{
2863	/// @todo (dmik) don't forget to set
2864	// mData->mCurrentStateModified to FALSE
2865
2866	return setError (E_NOTIMPL, "Not implemented");
2867	}
2868
2869	STDMETHODIMP
2870	Machine::CreateSharedFolder (IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable)
2871	{
2872	CheckComArgNotNull (aName);
2873	CheckComArgNotNull (aHostPath);
2874
2875	AutoCaller autoCaller (this);
2876	CheckComRCReturnRC (autoCaller.rc());
2877
2878	AutoWriteLock alock (this);
2879
2880	HRESULT rc = checkStateDependency (MutableStateDep);
2881	CheckComRCReturnRC (rc);
2882
2883	ComObjPtr <SharedFolder> sharedFolder;
2884	rc = findSharedFolder (aName, sharedFolder, false /* aSetError */);
2885	if (SUCCEEDED (rc))
2886	return setError (VBOX_E_OBJECT_IN_USE,
2887	tr ("Shared folder named '%ls' already exists"), aName);
2888
2889	sharedFolder.createObject();
2890	rc = sharedFolder->init (machine(), aName, aHostPath, aWritable);
2891	CheckComRCReturnRC (rc);
2892
2893	mHWData.backup();
2894	mHWData->mSharedFolders.push_back (sharedFolder);
2895
2896	/* inform the direct session if any */
2897	alock.leave();
2898	onSharedFolderChange();
2899
2900	return S_OK;
2901	}
2902
2903	STDMETHODIMP Machine::RemoveSharedFolder (IN_BSTR aName)
2904	{
2905	CheckComArgNotNull (aName);
2906
2907	AutoCaller autoCaller (this);
2908	CheckComRCReturnRC (autoCaller.rc());
2909
2910	AutoWriteLock alock (this);
2911
2912	HRESULT rc = checkStateDependency (MutableStateDep);
2913	CheckComRCReturnRC (rc);
2914
2915	ComObjPtr <SharedFolder> sharedFolder;
2916	rc = findSharedFolder (aName, sharedFolder, true /* aSetError */);
2917	CheckComRCReturnRC (rc);
2918
2919	mHWData.backup();
2920	mHWData->mSharedFolders.remove (sharedFolder);
2921
2922	/* inform the direct session if any */
2923	alock.leave();
2924	onSharedFolderChange();
2925
2926	return S_OK;
2927	}
2928
2929	STDMETHODIMP Machine::CanShowConsoleWindow (BOOL *aCanShow)
2930	{
2931	CheckComArgOutPointerValid (aCanShow);
2932
2933	/* start with No */
2934	*aCanShow = FALSE;
2935
2936	AutoCaller autoCaller (this);
2937	AssertComRCReturnRC (autoCaller.rc());
2938
2939	ComPtr <IInternalSessionControl> directControl;
2940	{
2941	AutoReadLock alock (this);
2942
2943	if (mData->mSession.mState != SessionState_Open)
2944	return setError (VBOX_E_INVALID_VM_STATE,
2945	tr ("Machine session is not open (session state: %d)"),
2946	mData->mSession.mState);
2947
2948	directControl = mData->mSession.mDirectControl;
2949	}
2950
2951	/* ignore calls made after #OnSessionEnd() is called */
2952	if (!directControl)
2953	return S_OK;
2954
2955	ULONG64 dummy;
2956	return directControl->OnShowWindow (TRUE /* aCheck */, aCanShow, &dummy);
2957	}
2958
2959	STDMETHODIMP Machine::ShowConsoleWindow (ULONG64 *aWinId)
2960	{
2961	CheckComArgOutPointerValid (aWinId);
2962
2963	AutoCaller autoCaller (this);
2964	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
2965
2966	ComPtr <IInternalSessionControl> directControl;
2967	{
2968	AutoReadLock alock (this);
2969
2970	if (mData->mSession.mState != SessionState_Open)
2971	return setError (E_FAIL,
2972	tr ("Machine session is not open (session state: %d)"),
2973	mData->mSession.mState);
2974
2975	directControl = mData->mSession.mDirectControl;
2976	}
2977
2978	/* ignore calls made after #OnSessionEnd() is called */
2979	if (!directControl)
2980	return S_OK;
2981
2982	BOOL dummy;
2983	return directControl->OnShowWindow (FALSE /* aCheck */, &dummy, aWinId);
2984	}
2985
2986	STDMETHODIMP Machine::GetGuestProperty (IN_BSTR aName, BSTR aValue, ULONG64 aTimestamp, BSTR *aFlags)
2987	{
2988	#if !defined (VBOX_WITH_GUEST_PROPS)
2989	ReturnComNotImplemented();
2990	#else
2991	CheckComArgNotNull (aName);
2992	CheckComArgOutPointerValid (aValue);
2993	CheckComArgOutPointerValid (aTimestamp);
2994	CheckComArgOutPointerValid (aFlags);
2995
2996	AutoCaller autoCaller (this);
2997	CheckComRCReturnRC (autoCaller.rc());
2998
2999	AutoReadLock alock (this);
3000
3001	using namespace guestProp;
3002	HRESULT rc = E_FAIL;
3003
3004	if (!mHWData->mPropertyServiceActive)
3005	{
3006	bool found = false;
3007	for (HWData::GuestPropertyList::const_iterator it = mHWData->mGuestProperties.begin();
3008	(it != mHWData->mGuestProperties.end()) && !found; ++it)
3009	{
3010	if (it->mName == aName)
3011	{
3012	char szFlags[MAX_FLAGS_LEN + 1];
3013	it->mValue.cloneTo (aValue);
3014	*aTimestamp = it->mTimestamp;
3015	writeFlags (it->mFlags, szFlags);
3016	Bstr (szFlags).cloneTo (aFlags);
3017	found = true;
3018	}
3019	}
3020	rc = S_OK;
3021	}
3022	else
3023	{
3024	ComPtr <IInternalSessionControl> directControl =
3025	mData->mSession.mDirectControl;
3026
3027	/* just be on the safe side when calling another process */
3028	alock.unlock();
3029
3030	/* fail if we were called after #OnSessionEnd() is called. This is a
3031	* silly race condition. */
3032
3033	if (!directControl)
3034	rc = E_FAIL;
3035	else
3036	rc = directControl->AccessGuestProperty (aName, NULL, NULL,
3037	false /* isSetter */,
3038	aValue, aTimestamp, aFlags);
3039	}
3040	return rc;
3041	#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
3042	}
3043
3044	STDMETHODIMP Machine::GetGuestPropertyValue (IN_BSTR aName, BSTR *aValue)
3045	{
3046	ULONG64 dummyTimestamp;
3047	BSTR dummyFlags;
3048	return GetGuestProperty (aName, aValue, &dummyTimestamp, &dummyFlags);
3049	}
3050
3051	STDMETHODIMP Machine::GetGuestPropertyTimestamp (IN_BSTR aName, ULONG64 *aTimestamp)
3052	{
3053	BSTR dummyValue;
3054	BSTR dummyFlags;
3055	return GetGuestProperty (aName, &dummyValue, aTimestamp, &dummyFlags);
3056	}
3057
3058	STDMETHODIMP Machine::SetGuestProperty (IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags)
3059	{
3060	#if !defined (VBOX_WITH_GUEST_PROPS)
3061	ReturnComNotImplemented();
3062	#else
3063	using namespace guestProp;
3064
3065	CheckComArgNotNull (aName);
3066	CheckComArgNotNull (aValue);
3067	if ((aFlags != NULL) && !VALID_PTR (aFlags))
3068	return E_INVALIDARG;
3069
3070	Utf8Str utf8Name (aName);
3071	Utf8Str utf8Flags (aFlags);
3072	Utf8Str utf8Patterns (mHWData->mGuestPropertyNotificationPatterns);
3073	if ( utf8Name.isNull()
3074	\|\| ((aFlags != NULL) && utf8Flags.isNull())
3075	\|\| utf8Patterns.isNull()
3076	)
3077	return E_OUTOFMEMORY;
3078	bool matchAll = false;
3079	if (0 == utf8Patterns.length())
3080	matchAll = true;
3081
3082	uint32_t fFlags = NILFLAG;
3083	if ((aFlags != NULL) && RT_FAILURE (validateFlags (utf8Flags.raw(), &fFlags))
3084	)
3085	return setError (E_INVALIDARG, tr ("Invalid flag values: '%ls'"),
3086	aFlags);
3087
3088	AutoCaller autoCaller (this);
3089	CheckComRCReturnRC (autoCaller.rc());
3090
3091	AutoWriteLock alock (this);
3092
3093	HRESULT rc = checkStateDependency (MutableStateDep);
3094	CheckComRCReturnRC (rc);
3095
3096	rc = S_OK;
3097
3098	if (!mHWData->mPropertyServiceActive)
3099	{
3100	bool found = false;
3101	HWData::GuestProperty property;
3102	property.mFlags = NILFLAG;
3103	if (fFlags & TRANSIENT)
3104	rc = setError (VBOX_E_INVALID_OBJECT_STATE,
3105	tr ("Cannot set a transient property when the "
3106	"machine is not running"));
3107	if (SUCCEEDED (rc))
3108	{
3109	for (HWData::GuestPropertyList::iterator it =
3110	mHWData->mGuestProperties.begin();
3111	it != mHWData->mGuestProperties.end(); ++ it)
3112	if (it->mName == aName)
3113	{
3114	property = *it;
3115	if (it->mFlags & (RDONLYHOST))
3116	rc = setError (E_ACCESSDENIED,
3117	tr ("The property '%ls' cannot be changed by the host"),
3118	aName);
3119	else
3120	{
3121	mHWData.backup();
3122	/* The backup() operation invalidates our iterator, so
3123	* get a new one. */
3124	for (it = mHWData->mGuestProperties.begin();
3125	it->mName != aName; ++ it)
3126	;
3127	mHWData->mGuestProperties.erase (it);
3128	}
3129	found = true;
3130	break;
3131	}
3132	}
3133	if (found && SUCCEEDED (rc))
3134	{
3135	if (*aValue)
3136	{
3137	RTTIMESPEC time;
3138	property.mValue = aValue;
3139	property.mTimestamp = RTTimeSpecGetNano (RTTimeNow (&time));
3140	if (aFlags != NULL)
3141	property.mFlags = fFlags;
3142	mHWData->mGuestProperties.push_back (property);
3143	}
3144	}
3145	else if (SUCCEEDED (rc) && *aValue)
3146	{
3147	RTTIMESPEC time;
3148	mHWData.backup();
3149	property.mName = aName;
3150	property.mValue = aValue;
3151	property.mTimestamp = RTTimeSpecGetNano (RTTimeNow (&time));
3152	property.mFlags = fFlags;
3153	mHWData->mGuestProperties.push_back (property);
3154	}
3155	if ( SUCCEEDED (rc)
3156	&& ( matchAll
3157	\|\| RTStrSimplePatternMultiMatch (utf8Patterns.raw(), RTSTR_MAX,
3158	utf8Name.raw(), RTSTR_MAX, NULL)
3159	)
3160	)
3161	mParent->onGuestPropertyChange (mData->mUuid, aName, aValue, aFlags);
3162	}
3163	else
3164	{
3165	ComPtr <IInternalSessionControl> directControl =
3166	mData->mSession.mDirectControl;
3167
3168	/* just be on the safe side when calling another process */
3169	alock.leave();
3170
3171	BSTR dummy = NULL;
3172	ULONG64 dummy64;
3173	if (!directControl)
3174	rc = E_FAIL;
3175	else
3176	rc = directControl->AccessGuestProperty (aName, aValue, aFlags,
3177	true /* isSetter */,
3178	&dummy, &dummy64, &dummy);
3179	}
3180	return rc;
3181	#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
3182	}
3183
3184	STDMETHODIMP Machine::SetGuestPropertyValue (IN_BSTR aName, IN_BSTR aValue)
3185	{
3186	return SetGuestProperty (aName, aValue, NULL);
3187	}
3188
3189	STDMETHODIMP Machine::
3190	EnumerateGuestProperties (IN_BSTR aPatterns, ComSafeArrayOut (BSTR, aNames),
3191	ComSafeArrayOut (BSTR, aValues),
3192	ComSafeArrayOut (ULONG64, aTimestamps),
3193	ComSafeArrayOut (BSTR, aFlags))
3194	{
3195	#if !defined (VBOX_WITH_GUEST_PROPS)
3196	ReturnComNotImplemented();
3197	#else
3198	if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
3199	return E_POINTER;
3200
3201	CheckComArgOutSafeArrayPointerValid (aNames);
3202	CheckComArgOutSafeArrayPointerValid (aValues);
3203	CheckComArgOutSafeArrayPointerValid (aTimestamps);
3204	CheckComArgOutSafeArrayPointerValid (aFlags);
3205
3206	AutoCaller autoCaller (this);
3207	CheckComRCReturnRC (autoCaller.rc());
3208
3209	AutoReadLock alock (this);
3210
3211	using namespace guestProp;
3212	HRESULT rc = E_FAIL;
3213
3214	bool matchAll = false;
3215	if ((NULL == aPatterns) \|\| (0 == aPatterns[0]))
3216	matchAll = true;
3217	if (!mHWData->mPropertyServiceActive)
3218	{
3219
3220	/*
3221	* Look for matching patterns and build up a list.
3222	*/
3223	HWData::GuestPropertyList propList;
3224	for (HWData::GuestPropertyList::iterator it = mHWData->mGuestProperties.begin();
3225	it != mHWData->mGuestProperties.end(); ++it)
3226	if ( matchAll
3227	\|\| RTStrSimplePatternMultiMatch (Utf8Str (aPatterns).raw(),
3228	RTSTR_MAX,
3229	Utf8Str (it->mName).raw(),
3230	RTSTR_MAX, NULL)
3231	)
3232	propList.push_back (*it);
3233
3234	/*
3235	* And build up the arrays for returning the property information.
3236	*/
3237	size_t cEntries = propList.size();
3238	SafeArray <BSTR> names (cEntries);
3239	SafeArray <BSTR> values (cEntries);
3240	SafeArray <ULONG64> timestamps (cEntries);
3241	SafeArray <BSTR> flags (cEntries);
3242	size_t iProp = 0;
3243	for (HWData::GuestPropertyList::iterator it = propList.begin();
3244	it != propList.end(); ++it)
3245	{
3246	char szFlags[MAX_FLAGS_LEN + 1];
3247	it->mName.cloneTo (&names[iProp]);
3248	it->mValue.cloneTo (&values[iProp]);
3249	timestamps[iProp] = it->mTimestamp;
3250	writeFlags (it->mFlags, szFlags);
3251	Bstr (szFlags).cloneTo (&flags[iProp]);
3252	++iProp;
3253	}
3254	names.detachTo (ComSafeArrayOutArg (aNames));
3255	values.detachTo (ComSafeArrayOutArg (aValues));
3256	timestamps.detachTo (ComSafeArrayOutArg (aTimestamps));
3257	flags.detachTo (ComSafeArrayOutArg (aFlags));
3258	rc = S_OK;
3259	}
3260	else
3261	{
3262	ComPtr <IInternalSessionControl> directControl =
3263	mData->mSession.mDirectControl;
3264
3265	/* just be on the safe side when calling another process */
3266	alock.unlock();
3267
3268	if (!directControl)
3269	rc = E_FAIL;
3270	else
3271	rc = directControl->EnumerateGuestProperties (aPatterns,
3272	ComSafeArrayOutArg (aNames),
3273	ComSafeArrayOutArg (aValues),
3274	ComSafeArrayOutArg (aTimestamps),
3275	ComSafeArrayOutArg (aFlags));
3276	}
3277	return rc;
3278	#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
3279	}
3280
3281	STDMETHODIMP Machine::
3282	GetHardDiskAttachmentsOfController(IN_BSTR aName, ComSafeArrayOut (IHardDiskAttachment *, aAttachments))
3283	{
3284	HDData::AttachmentList atts;
3285
3286	HRESULT rc = getHardDiskAttachmentsOfController(aName, atts);
3287	CheckComRCReturnRC(rc);
3288
3289	SafeIfaceArray<IHardDiskAttachment> attachments (atts);
3290	attachments.detachTo (ComSafeArrayOutArg (aAttachments));
3291
3292	return S_OK;
3293	}
3294
3295	STDMETHODIMP Machine::
3296	AddStorageController(IN_BSTR aName,
3297	StorageBus_T aConnectionType,
3298	IStorageController **controller)
3299	{
3300	CheckComArgStrNotEmptyOrNull(aName);
3301
3302	if ( (aConnectionType <= StorageBus_Null)
3303	\|\| (aConnectionType > StorageBus_SCSI))
3304	return setError (E_INVALIDARG,
3305	tr ("Invalid connection type: %d"),
3306	aConnectionType);
3307
3308	AutoCaller autoCaller (this);
3309	CheckComRCReturnRC (autoCaller.rc());
3310
3311	AutoWriteLock alock (this);
3312
3313	HRESULT rc = checkStateDependency (MutableStateDep);
3314	CheckComRCReturnRC (rc);
3315
3316	/* try to find one with the name first. */
3317	ComObjPtr<StorageController> ctrl;
3318
3319	rc = getStorageControllerByName (aName, ctrl, false /* aSetError */);
3320	if (SUCCEEDED (rc))
3321	return setError (VBOX_E_OBJECT_IN_USE,
3322	tr ("Storage controller named '%ls' already exists"), aName);
3323
3324	ctrl.createObject();
3325	rc = ctrl->init (this, aName, aConnectionType);
3326	CheckComRCReturnRC (rc);
3327
3328	mStorageControllers.backup();
3329	mStorageControllers->push_back (ctrl);
3330
3331	ctrl.queryInterfaceTo(controller);
3332
3333	/* inform the direct session if any */
3334	alock.leave();
3335	onStorageControllerChange();
3336
3337	return S_OK;
3338	}
3339
3340	STDMETHODIMP Machine::
3341	GetStorageControllerByName(IN_BSTR aName, IStorageController **aStorageController)
3342	{
3343	CheckComArgStrNotEmptyOrNull(aName);
3344
3345	AutoCaller autoCaller (this);
3346	CheckComRCReturnRC (autoCaller.rc());
3347
3348	AutoReadLock alock (this);
3349
3350	ComObjPtr <StorageController> ctrl;
3351
3352	HRESULT rc = getStorageControllerByName (aName, ctrl, true /* aSetError */);
3353	if (SUCCEEDED (rc))
3354	ctrl.queryInterfaceTo (aStorageController);
3355
3356	return rc;
3357	}
3358
3359	STDMETHODIMP Machine::
3360	RemoveStorageController(IN_BSTR aName)
3361	{
3362	CheckComArgStrNotEmptyOrNull(aName);
3363
3364	AutoCaller autoCaller (this);
3365	CheckComRCReturnRC (autoCaller.rc());
3366
3367	AutoWriteLock alock (this);
3368
3369	HRESULT rc = checkStateDependency (MutableStateDep);
3370	CheckComRCReturnRC (rc);
3371
3372	ComObjPtr <StorageController> ctrl;
3373	rc = getStorageControllerByName (aName, ctrl, true /* aSetError */);
3374	CheckComRCReturnRC (rc);
3375
3376	/* We can remove the controller only if there is no device attached. */
3377	/* check if the device slot is already busy */
3378	for (HDData::AttachmentList::const_iterator
3379	it = mHDData->mAttachments.begin();
3380	it != mHDData->mAttachments.end();
3381	++ it)
3382	{
3383	if (it != mHDData->mAttachments.end())
3384	{
3385	if ((*it)->controller() == aName)
3386	return setError (VBOX_E_OBJECT_IN_USE,
3387	tr ("Storage controller named '%ls' has still devices attached"), aName);
3388	}
3389	}
3390
3391	/* We can remove it now. */
3392	mStorageControllers.backup();
3393
3394	ctrl->unshare();
3395
3396	mStorageControllers->remove (ctrl);
3397
3398	/* inform the direct session if any */
3399	alock.leave();
3400	onStorageControllerChange();
3401
3402	return S_OK;
3403	}
3404
3405	// public methods for internal purposes
3406	/////////////////////////////////////////////////////////////////////////////
3407
3408	/**
3409	* Saves the registry entry of this machine to the given configuration node.
3410	*
3411	* @param aEntryNode Node to save the registry entry to.
3412	*
3413	* @note locks this object for reading.
3414	*/
3415	HRESULT Machine::saveRegistryEntry (settings::Key &aEntryNode)
3416	{
3417	AssertReturn (!aEntryNode.isNull(), E_FAIL);
3418
3419	AutoLimitedCaller autoCaller (this);
3420	AssertComRCReturnRC (autoCaller.rc());
3421
3422	AutoReadLock alock (this);
3423
3424	/* UUID */
3425	aEntryNode.setValue <Guid> ("uuid", mData->mUuid);
3426	/* settings file name (possibly, relative) */
3427	aEntryNode.setValue <Bstr> ("src", mData->mConfigFile);
3428
3429	return S_OK;
3430	}
3431
3432	/**
3433	* Calculates the absolute path of the given path taking the directory of the
3434	* machine settings file as the current directory.
3435	*
3436	* @param aPath Path to calculate the absolute path for.
3437	* @param aResult Where to put the result (used only on success, can be the
3438	* same Utf8Str instance as passed in @a aPath).
3439	* @return IPRT result.
3440	*
3441	* @note Locks this object for reading.
3442	*/
3443	int Machine::calculateFullPath (const char *aPath, Utf8Str &aResult)
3444	{
3445	AutoCaller autoCaller (this);
3446	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
3447
3448	AutoReadLock alock (this);
3449
3450	AssertReturn (!mData->mConfigFileFull.isNull(), VERR_GENERAL_FAILURE);
3451
3452	Utf8Str settingsDir = mData->mConfigFileFull;
3453
3454	RTPathStripFilename (settingsDir.mutableRaw());
3455	char folder [RTPATH_MAX];
3456	int vrc = RTPathAbsEx (settingsDir, aPath, folder, sizeof (folder));
3457	if (RT_SUCCESS (vrc))
3458	aResult = folder;
3459
3460	return vrc;
3461	}
3462
3463	/**
3464	* Tries to calculate the relative path of the given absolute path using the
3465	* directory of the machine settings file as the base directory.
3466	*
3467	* @param aPath Absolute path to calculate the relative path for.
3468	* @param aResult Where to put the result (used only when it's possible to
3469	* make a relative path from the given absolute path; otherwise
3470	* left untouched).
3471	*
3472	* @note Locks this object for reading.
3473	*/
3474	void Machine::calculateRelativePath (const char *aPath, Utf8Str &aResult)
3475	{
3476	AutoCaller autoCaller (this);
3477	AssertComRCReturn (autoCaller.rc(), (void) 0);
3478
3479	AutoReadLock alock (this);
3480
3481	AssertReturnVoid (!mData->mConfigFileFull.isNull());
3482
3483	Utf8Str settingsDir = mData->mConfigFileFull;
3484
3485	RTPathStripFilename (settingsDir.mutableRaw());
3486	if (RTPathStartsWith (aPath, settingsDir))
3487	{
3488	/* when assigning, we create a separate Utf8Str instance because both
3489	* aPath and aResult can point to the same memory location when this
3490	* func is called (if we just do aResult = aPath, aResult will be freed
3491	* first, and since its the same as aPath, an attempt to copy garbage
3492	* will be made. */
3493	aResult = Utf8Str (aPath + settingsDir.length() + 1);
3494	}
3495	}
3496
3497	/**
3498	* Returns the full path to the machine's log folder in the
3499	* \a aLogFolder argument.
3500	*/
3501	void Machine::getLogFolder (Utf8Str &aLogFolder)
3502	{
3503	AutoCaller autoCaller (this);
3504	AssertComRCReturnVoid (autoCaller.rc());
3505
3506	AutoReadLock alock (this);
3507
3508	Utf8Str settingsDir;
3509	if (isInOwnDir (&settingsDir))
3510	{
3511	/* Log folder is <Machines>/<VM_Name>/Logs */
3512	aLogFolder = Utf8StrFmt ("%s%cLogs", settingsDir.raw(), RTPATH_DELIMITER);
3513	}
3514	else
3515	{
3516	/* Log folder is <Machines>/<VM_SnapshotFolder>/Logs */
3517	Assert (!mUserData->mSnapshotFolderFull.isEmpty());
3518	aLogFolder = Utf8StrFmt ("%ls%cLogs", mUserData->mSnapshotFolderFull.raw(),
3519	RTPATH_DELIMITER);
3520	}
3521	}
3522
3523	/**
3524	* @note Locks this object for writing, calls the client process (outside the
3525	* lock).
3526	*/
3527	HRESULT Machine::openSession (IInternalSessionControl *aControl)
3528	{
3529	LogFlowThisFuncEnter();
3530
3531	AssertReturn (aControl, E_FAIL);
3532
3533	AutoCaller autoCaller (this);
3534	CheckComRCReturnRC (autoCaller.rc());
3535
3536	AutoWriteLock alock (this);
3537
3538	if (!mData->mRegistered)
3539	return setError (E_UNEXPECTED,
3540	tr ("The machine '%ls' is not registered"), mUserData->mName.raw());
3541
3542	LogFlowThisFunc (("mSession.mState=%d\n", mData->mSession.mState));
3543
3544	if (mData->mSession.mState == SessionState_Open \|\|
3545	mData->mSession.mState == SessionState_Closing)
3546	return setError (VBOX_E_INVALID_OBJECT_STATE,
3547	tr ("A session for the machine '%ls' is currently open "
3548	"(or being closed)"),
3549	mUserData->mName.raw());
3550
3551	/* may not be busy */
3552	AssertReturn (!Global::IsOnlineOrTransient (mData->mMachineState), E_FAIL);
3553
3554	/* get the session PID */
3555	RTPROCESS pid = NIL_RTPROCESS;
3556	AssertCompile (sizeof (ULONG) == sizeof (RTPROCESS));
3557	aControl->GetPID ((ULONG *) &pid);
3558	Assert (pid != NIL_RTPROCESS);
3559
3560	if (mData->mSession.mState == SessionState_Spawning)
3561	{
3562	/* This machine is awaiting for a spawning session to be opened, so
3563	* reject any other open attempts from processes other than one
3564	* started by #openRemoteSession(). */
3565
3566	LogFlowThisFunc (("mSession.mPid=%d(0x%x)\n",
3567	mData->mSession.mPid, mData->mSession.mPid));
3568	LogFlowThisFunc (("session.pid=%d(0x%x)\n", pid, pid));
3569
3570	if (mData->mSession.mPid != pid)
3571	return setError (E_ACCESSDENIED,
3572	tr ("An unexpected process (PID=0x%08X) has tried to open a direct "
3573	"session with the machine named '%ls', while only a process "
3574	"started by OpenRemoteSession (PID=0x%08X) is allowed"),
3575	pid, mUserData->mName.raw(), mData->mSession.mPid);
3576	}
3577
3578	/* create a SessionMachine object */
3579	ComObjPtr <SessionMachine> sessionMachine;
3580	sessionMachine.createObject();
3581	HRESULT rc = sessionMachine->init (this);
3582	AssertComRC (rc);
3583
3584	/* NOTE: doing return from this function after this point but
3585	* before the end is forbidden since it may call SessionMachine::uninit()
3586	* (through the ComObjPtr's destructor) which requests the VirtualBox write
3587	* lock while still holding the Machine lock in alock so that a deadlock
3588	* is possible due to the wrong lock order. */
3589
3590	if (SUCCEEDED (rc))
3591	{
3592	#ifdef VBOX_WITH_RESOURCE_USAGE_API
3593	registerMetrics (mParent->performanceCollector(), this, pid);
3594	#endif /* VBOX_WITH_RESOURCE_USAGE_API */
3595
3596	/*
3597	* Set the session state to Spawning to protect against subsequent
3598	* attempts to open a session and to unregister the machine after
3599	* we leave the lock.
3600	*/
3601	SessionState_T origState = mData->mSession.mState;
3602	mData->mSession.mState = SessionState_Spawning;
3603
3604	/*
3605	* Leave the lock before calling the client process -- it will call
3606	* Machine/SessionMachine methods. Leaving the lock here is quite safe
3607	* because the state is Spawning, so that openRemotesession() and
3608	* openExistingSession() calls will fail. This method, called before we
3609	* enter the lock again, will fail because of the wrong PID.
3610	*
3611	* Note that mData->mSession.mRemoteControls accessed outside
3612	* the lock may not be modified when state is Spawning, so it's safe.
3613	*/
3614	alock.leave();
3615
3616	LogFlowThisFunc (("Calling AssignMachine()...\n"));
3617	rc = aControl->AssignMachine (sessionMachine);
3618	LogFlowThisFunc (("AssignMachine() returned %08X\n", rc));
3619
3620	/* The failure may occur w/o any error info (from RPC), so provide one */
3621	if (FAILED (rc))
3622	setError (VBOX_E_VM_ERROR,
3623	tr ("Failed to assign the machine to the session (%Rrc)"), rc);
3624
3625	if (SUCCEEDED (rc) && origState == SessionState_Spawning)
3626	{
3627	/* complete the remote session initialization */
3628
3629	/* get the console from the direct session */
3630	ComPtr <IConsole> console;
3631	rc = aControl->GetRemoteConsole (console.asOutParam());
3632	ComAssertComRC (rc);
3633
3634	if (SUCCEEDED (rc) && !console)
3635	{
3636	ComAssert (!!console);
3637	rc = E_FAIL;
3638	}
3639
3640	/* assign machine & console to the remote session */
3641	if (SUCCEEDED (rc))
3642	{
3643	/*
3644	* after openRemoteSession(), the first and the only
3645	* entry in remoteControls is that remote session
3646	*/
3647	LogFlowThisFunc (("Calling AssignRemoteMachine()...\n"));
3648	rc = mData->mSession.mRemoteControls.front()->
3649	AssignRemoteMachine (sessionMachine, console);
3650	LogFlowThisFunc (("AssignRemoteMachine() returned %08X\n", rc));
3651
3652	/* The failure may occur w/o any error info (from RPC), so provide one */
3653	if (FAILED (rc))
3654	setError (VBOX_E_VM_ERROR,
3655	tr ("Failed to assign the machine to the remote session (%Rrc)"), rc);
3656	}
3657
3658	if (FAILED (rc))
3659	aControl->Uninitialize();
3660	}
3661
3662	/* enter the lock again */
3663	alock.enter();
3664
3665	/* Restore the session state */
3666	mData->mSession.mState = origState;
3667	}
3668
3669	/* finalize spawning anyway (this is why we don't return on errors above) */
3670	if (mData->mSession.mState == SessionState_Spawning)
3671	{
3672	/* Note that the progress object is finalized later */
3673
3674	/* We don't reset mSession.mPid here because it is necessary for
3675	* SessionMachine::uninit() to reap the child process later. */
3676
3677	if (FAILED (rc))
3678	{
3679	/* Close the remote session, remove the remote control from the list
3680	* and reset session state to Closed (@note keep the code in sync
3681	* with the relevant part in openSession()). */
3682
3683	Assert (mData->mSession.mRemoteControls.size() == 1);
3684	if (mData->mSession.mRemoteControls.size() == 1)
3685	{
3686	ErrorInfoKeeper eik;
3687	mData->mSession.mRemoteControls.front()->Uninitialize();
3688	}
3689
3690	mData->mSession.mRemoteControls.clear();
3691	mData->mSession.mState = SessionState_Closed;
3692	}
3693	}
3694	else
3695	{
3696	/* memorize PID of the directly opened session */
3697	if (SUCCEEDED (rc))
3698	mData->mSession.mPid = pid;
3699	}
3700
3701	if (SUCCEEDED (rc))
3702	{
3703	/* memorize the direct session control and cache IUnknown for it */
3704	mData->mSession.mDirectControl = aControl;
3705	mData->mSession.mState = SessionState_Open;
3706	/* associate the SessionMachine with this Machine */
3707	mData->mSession.mMachine = sessionMachine;
3708
3709	/* request an IUnknown pointer early from the remote party for later
3710	* identity checks (it will be internally cached within mDirectControl
3711	* at least on XPCOM) */
3712	ComPtr <IUnknown> unk = mData->mSession.mDirectControl;
3713	NOREF (unk);
3714	}
3715
3716	if (mData->mSession.mProgress)
3717	{
3718	/* finalize the progress after setting the state, for consistency */
3719	mData->mSession.mProgress->notifyComplete (rc);
3720	mData->mSession.mProgress.setNull();
3721	}
3722
3723	/* Leave the lock since SessionMachine::uninit() locks VirtualBox which
3724	* would break the lock order */
3725	alock.leave();
3726
3727	/* uninitialize the created session machine on failure */
3728	if (FAILED (rc))
3729	sessionMachine->uninit();
3730
3731	LogFlowThisFunc (("rc=%08X\n", rc));
3732	LogFlowThisFuncLeave();
3733	return rc;
3734	}
3735
3736	/**
3737	* @note Locks this object for writing, calls the client process
3738	* (inside the lock).
3739	*/
3740	HRESULT Machine::openRemoteSession (IInternalSessionControl *aControl,
3741	IN_BSTR aType, IN_BSTR aEnvironment,
3742	Progress *aProgress)
3743	{
3744	LogFlowThisFuncEnter();
3745
3746	AssertReturn (aControl, E_FAIL);
3747	AssertReturn (aProgress, E_FAIL);
3748
3749	AutoCaller autoCaller (this);
3750	CheckComRCReturnRC (autoCaller.rc());
3751
3752	AutoWriteLock alock (this);
3753
3754	if (!mData->mRegistered)
3755	return setError (E_UNEXPECTED,
3756	tr ("The machine '%ls' is not registered"), mUserData->mName.raw());
3757
3758	LogFlowThisFunc (("mSession.mState=%d\n", mData->mSession.mState));
3759
3760	if (mData->mSession.mState == SessionState_Open \|\|
3761	mData->mSession.mState == SessionState_Spawning \|\|
3762	mData->mSession.mState == SessionState_Closing)
3763	return setError (VBOX_E_INVALID_OBJECT_STATE,
3764	tr ("A session for the machine '%ls' is currently open "
3765	"(or being opened or closed)"),
3766	mUserData->mName.raw());
3767
3768	/* may not be busy */
3769	AssertReturn (!Global::IsOnlineOrTransient (mData->mMachineState), E_FAIL);
3770
3771	/* get the path to the executable */
3772	char path [RTPATH_MAX];
3773	RTPathAppPrivateArch (path, RTPATH_MAX);
3774	size_t sz = strlen (path);
3775	path [sz++] = RTPATH_DELIMITER;
3776	path [sz] = 0;
3777	char *cmd = path + sz;
3778	sz = RTPATH_MAX - sz;
3779
3780	int vrc = VINF_SUCCESS;
3781	RTPROCESS pid = NIL_RTPROCESS;
3782
3783	RTENV env = RTENV_DEFAULT;
3784
3785	if (aEnvironment != NULL && *aEnvironment)
3786	{
3787	char *newEnvStr = NULL;
3788
3789	do
3790	{
3791	/* clone the current environment */
3792	int vrc2 = RTEnvClone (&env, RTENV_DEFAULT);
3793	AssertRCBreakStmt (vrc2, vrc = vrc2);
3794
3795	newEnvStr = RTStrDup (Utf8Str (aEnvironment));
3796	AssertPtrBreakStmt (newEnvStr, vrc = vrc2);
3797
3798	/* put new variables to the environment
3799	* (ignore empty variable names here since RTEnv API
3800	* intentionally doesn't do that) */
3801	char *var = newEnvStr;
3802	for (char p = newEnvStr; p; ++ p)
3803	{
3804	if (p == '\n' && (p == newEnvStr \|\| (p - 1) != '\\'))
3805	{
3806	*p = '\0';
3807	if (*var)
3808	{
3809	char *val = strchr (var, '=');
3810	if (val)
3811	{
3812	*val++ = '\0';
3813	vrc2 = RTEnvSetEx (env, var, val);
3814	}
3815	else
3816	vrc2 = RTEnvUnsetEx (env, var);
3817	if (RT_FAILURE (vrc2))
3818	break;
3819	}
3820	var = p + 1;
3821	}
3822	}
3823	if (RT_SUCCESS (vrc2) && *var)
3824	vrc2 = RTEnvPutEx (env, var);
3825
3826	AssertRCBreakStmt (vrc2, vrc = vrc2);
3827	}
3828	while (0);
3829
3830	if (newEnvStr != NULL)
3831	RTStrFree (newEnvStr);
3832	}
3833
3834	Bstr type (aType);
3835
3836	/* Qt is default */
3837	#ifdef VBOX_WITH_QTGUI
3838	if (type == "gui" \|\| type == "GUI/Qt")
3839	{
3840	# ifdef RT_OS_DARWIN /* Avoid Launch Services confusing this with the selector by using a helper app. */
3841	const char VirtualBox_exe[] = "../Resources/VirtualBoxVM.app/Contents/MacOS/VirtualBoxVM";
3842	# else
3843	const char VirtualBox_exe[] = "VirtualBox" HOSTSUFF_EXE;
3844	# endif
3845	Assert (sz >= sizeof (VirtualBox_exe));
3846	strcpy (cmd, VirtualBox_exe);
3847
3848	Utf8Str idStr = mData->mUuid.toString();
3849	# ifdef RT_OS_WINDOWS /** @todo drop this once the RTProcCreate bug has been fixed */
3850	const char * args[] = {path, "--startvm", idStr, 0 };
3851	# else
3852	Utf8Str name = mUserData->mName;
3853	const char * args[] = {path, "--comment", name, "--startvm", idStr, 0 };
3854	# endif
3855	vrc = RTProcCreate (path, args, env, 0, &pid);
3856	}
3857	#else /* !VBOX_WITH_QTGUI */
3858	if (0)
3859	;
3860	#endif /* VBOX_WITH_QTGUI */
3861
3862	else
3863
3864	#ifdef VBOX_WITH_VBOXSDL
3865	if (type == "sdl" \|\| type == "GUI/SDL")
3866	{
3867	const char VBoxSDL_exe[] = "VBoxSDL" HOSTSUFF_EXE;
3868	Assert (sz >= sizeof (VBoxSDL_exe));
3869	strcpy (cmd, VBoxSDL_exe);
3870
3871	Utf8Str idStr = mData->mUuid.toString();
3872	# ifdef RT_OS_WINDOWS
3873	const char * args[] = {path, "--startvm", idStr, 0 };
3874	# else
3875	Utf8Str name = mUserData->mName;
3876	const char * args[] = {path, "--comment", name, "--startvm", idStr, 0 };
3877	# endif
3878	vrc = RTProcCreate (path, args, env, 0, &pid);
3879	}
3880	#else /* !VBOX_WITH_VBOXSDL */
3881	if (0)
3882	;
3883	#endif /* !VBOX_WITH_VBOXSDL */
3884
3885	else
3886
3887	#ifdef VBOX_WITH_HEADLESS
3888	if ( type == "headless"
3889	\|\| type == "capture"
3890	#ifdef VBOX_WITH_VRDP
3891	\|\| type == "vrdp"
3892	#endif
3893	)
3894	{
3895	const char VBoxHeadless_exe[] = "VBoxHeadless" HOSTSUFF_EXE;
3896	Assert (sz >= sizeof (VBoxHeadless_exe));
3897	strcpy (cmd, VBoxHeadless_exe);
3898
3899	Utf8Str idStr = mData->mUuid.toString();
3900	/* Leave space for 2 args, as "headless" needs --vrdp off on non-OSE. */
3901	# ifdef RT_OS_WINDOWS
3902	const char * args[] = {path, "--startvm", idStr, 0, 0, 0 };
3903	# else
3904	Utf8Str name = mUserData->mName;
3905	const char * args[] = {path, "--comment", name, "--startvm", idStr, 0, 0, 0 };
3906	# endif
3907	#ifdef VBOX_WITH_VRDP
3908	if (type == "headless")
3909	{
3910	unsigned pos = RT_ELEMENTS(args) - 3;
3911	args[pos++] = "--vrdp";
3912	args[pos] = "off";
3913	}
3914	#endif
3915	if (type == "capture")
3916	{
3917	unsigned pos = RT_ELEMENTS(args) - 3;
3918	args[pos] = "--capture";
3919	}
3920	vrc = RTProcCreate (path, args, env, 0, &pid);
3921	}
3922	#else /* !VBOX_WITH_HEADLESS */
3923	if (0)
3924	;
3925	#endif /* !VBOX_WITH_HEADLESS */
3926	else
3927	{
3928	RTEnvDestroy (env);
3929	return setError (E_INVALIDARG,
3930	tr ("Invalid session type: '%ls'"), aType);
3931	}
3932
3933	RTEnvDestroy (env);
3934
3935	if (RT_FAILURE (vrc))
3936	return setError (VBOX_E_IPRT_ERROR,
3937	tr ("Could not launch a process for the machine '%ls' (%Rrc)"),
3938	mUserData->mName.raw(), vrc);
3939
3940	LogFlowThisFunc (("launched.pid=%d(0x%x)\n", pid, pid));
3941
3942	/*
3943	* Note that we don't leave the lock here before calling the client,
3944	* because it doesn't need to call us back if called with a NULL argument.
3945	* Leaving the lock herer is dangerous because we didn't prepare the
3946	* launch data yet, but the client we've just started may happen to be
3947	* too fast and call openSession() that will fail (because of PID, etc.),
3948	* so that the Machine will never get out of the Spawning session state.
3949	*/
3950
3951	/* inform the session that it will be a remote one */
3952	LogFlowThisFunc (("Calling AssignMachine (NULL)...\n"));
3953	HRESULT rc = aControl->AssignMachine (NULL);
3954	LogFlowThisFunc (("AssignMachine (NULL) returned %08X\n", rc));
3955
3956	if (FAILED (rc))
3957	{
3958	/* restore the session state */
3959	mData->mSession.mState = SessionState_Closed;
3960	/* The failure may occur w/o any error info (from RPC), so provide one */
3961	return setError (VBOX_E_VM_ERROR,
3962	tr ("Failed to assign the machine to the session (%Rrc)"), rc);
3963	}
3964
3965	/* attach launch data to the machine */
3966	Assert (mData->mSession.mPid == NIL_RTPROCESS);
3967	mData->mSession.mRemoteControls.push_back (aControl);
3968	mData->mSession.mProgress = aProgress;
3969	mData->mSession.mPid = pid;
3970	mData->mSession.mState = SessionState_Spawning;
3971	mData->mSession.mType = type;
3972
3973	LogFlowThisFuncLeave();
3974	return S_OK;
3975	}
3976
3977	/**
3978	* @note Locks this object for writing, calls the client process
3979	* (outside the lock).
3980	*/
3981	HRESULT Machine::openExistingSession (IInternalSessionControl *aControl)
3982	{
3983	LogFlowThisFuncEnter();
3984
3985	AssertReturn (aControl, E_FAIL);
3986
3987	AutoCaller autoCaller (this);
3988	CheckComRCReturnRC (autoCaller.rc());
3989
3990	AutoWriteLock alock (this);
3991
3992	if (!mData->mRegistered)
3993	return setError (E_UNEXPECTED,
3994	tr ("The machine '%ls' is not registered"), mUserData->mName.raw());
3995
3996	LogFlowThisFunc (("mSession.state=%d\n", mData->mSession.mState));
3997
3998	if (mData->mSession.mState != SessionState_Open)
3999	return setError (VBOX_E_INVALID_SESSION_STATE,
4000	tr ("The machine '%ls' does not have an open session"),
4001	mUserData->mName.raw());
4002
4003	ComAssertRet (!mData->mSession.mDirectControl.isNull(), E_FAIL);
4004
4005	/*
4006	* Get the console from the direct session (note that we don't leave the
4007	* lock here because GetRemoteConsole must not call us back).
4008	*/
4009	ComPtr <IConsole> console;
4010	HRESULT rc = mData->mSession.mDirectControl->
4011	GetRemoteConsole (console.asOutParam());
4012	if (FAILED (rc))
4013	{
4014	/* The failure may occur w/o any error info (from RPC), so provide one */
4015	return setError (VBOX_E_VM_ERROR,
4016	tr ("Failed to get a console object from the direct session (%Rrc)"), rc);
4017	}
4018
4019	ComAssertRet (!console.isNull(), E_FAIL);
4020
4021	ComObjPtr <SessionMachine> sessionMachine = mData->mSession.mMachine;
4022	AssertReturn (!sessionMachine.isNull(), E_FAIL);
4023
4024	/*
4025	* Leave the lock before calling the client process. It's safe here
4026	* since the only thing to do after we get the lock again is to add
4027	* the remote control to the list (which doesn't directly influence
4028	* anything).
4029	*/
4030	alock.leave();
4031
4032	/* attach the remote session to the machine */
4033	LogFlowThisFunc (("Calling AssignRemoteMachine()...\n"));
4034	rc = aControl->AssignRemoteMachine (sessionMachine, console);
4035	LogFlowThisFunc (("AssignRemoteMachine() returned %08X\n", rc));
4036
4037	/* The failure may occur w/o any error info (from RPC), so provide one */
4038	if (FAILED (rc))
4039	return setError (VBOX_E_VM_ERROR,
4040	tr ("Failed to assign the machine to the session (%Rrc)"), rc);
4041
4042	alock.enter();
4043
4044	/* need to revalidate the state after entering the lock again */
4045	if (mData->mSession.mState != SessionState_Open)
4046	{
4047	aControl->Uninitialize();
4048
4049	return setError (VBOX_E_INVALID_SESSION_STATE,
4050	tr ("The machine '%ls' does not have an open session"),
4051	mUserData->mName.raw());
4052	}
4053
4054	/* store the control in the list */
4055	mData->mSession.mRemoteControls.push_back (aControl);
4056
4057	LogFlowThisFuncLeave();
4058	return S_OK;
4059	}
4060
4061	/**
4062	* Returns @c true if the given machine has an open direct session and returns
4063	* the session machine instance and additional session data (on some platforms)
4064	* if so.
4065	*
4066	* Note that when the method returns @c false, the arguments remain unchanged.
4067	*
4068	* @param aMachine Session machine object.
4069	* @param aControl Direct session control object (optional).
4070	* @param aIPCSem Mutex IPC semaphore handle for this machine (optional).
4071	*
4072	* @note locks this object for reading.
4073	*/
4074	#if defined (RT_OS_WINDOWS)
4075	bool Machine::isSessionOpen (ComObjPtr <SessionMachine> &aMachine,
4076	ComPtr <IInternalSessionControl> aControl /= NULL*/,
4077	HANDLE aIPCSem /= NULL*/,
4078	bool aAllowClosing /= false/)
4079	#elif defined (RT_OS_OS2)
4080	bool Machine::isSessionOpen (ComObjPtr <SessionMachine> &aMachine,
4081	ComPtr <IInternalSessionControl> aControl /= NULL*/,
4082	HMTX aIPCSem /= NULL*/,
4083	bool aAllowClosing /= false/)
4084	#else
4085	bool Machine::isSessionOpen (ComObjPtr <SessionMachine> &aMachine,
4086	ComPtr <IInternalSessionControl> aControl /= NULL*/,
4087	bool aAllowClosing /= false/)
4088	#endif
4089	{
4090	AutoLimitedCaller autoCaller (this);
4091	AssertComRCReturn (autoCaller.rc(), false);
4092
4093	/* just return false for inaccessible machines */
4094	if (autoCaller.state() != Ready)
4095	return false;
4096
4097	AutoReadLock alock (this);
4098
4099	if (mData->mSession.mState == SessionState_Open \|\|
4100	(aAllowClosing && mData->mSession.mState == SessionState_Closing))
4101	{
4102	AssertReturn (!mData->mSession.mMachine.isNull(), false);
4103
4104	aMachine = mData->mSession.mMachine;
4105
4106	if (aControl != NULL)
4107	*aControl = mData->mSession.mDirectControl;
4108
4109	#if defined (RT_OS_WINDOWS) \|\| defined (RT_OS_OS2)
4110	/* Additional session data */
4111	if (aIPCSem != NULL)
4112	*aIPCSem = aMachine->mIPCSem;
4113	#endif
4114	return true;
4115	}
4116
4117	return false;
4118	}
4119
4120	/**
4121	* Returns @c true if the given machine has an spawning direct session and
4122	* returns and additional session data (on some platforms) if so.
4123	*
4124	* Note that when the method returns @c false, the arguments remain unchanged.
4125	*
4126	* @param aPID PID of the spawned direct session process.
4127	*
4128	* @note locks this object for reading.
4129	*/
4130	#if defined (RT_OS_WINDOWS) \|\| defined (RT_OS_OS2)
4131	bool Machine::isSessionSpawning (RTPROCESS aPID /= NULL*/)
4132	#else
4133	bool Machine::isSessionSpawning()
4134	#endif
4135	{
4136	AutoLimitedCaller autoCaller (this);
4137	AssertComRCReturn (autoCaller.rc(), false);
4138
4139	/* just return false for inaccessible machines */
4140	if (autoCaller.state() != Ready)
4141	return false;
4142
4143	AutoReadLock alock (this);
4144
4145	if (mData->mSession.mState == SessionState_Spawning)
4146	{
4147	#if defined (RT_OS_WINDOWS) \|\| defined (RT_OS_OS2)
4148	/* Additional session data */
4149	if (aPID != NULL)
4150	{
4151	AssertReturn (mData->mSession.mPid != NIL_RTPROCESS, false);
4152	*aPID = mData->mSession.mPid;
4153	}
4154	#endif
4155	return true;
4156	}
4157
4158	return false;
4159	}
4160
4161	/**
4162	* Called from the client watcher thread to check for unexpected client process
4163	* death during Session_Spawning state (e.g. before it successfully opened a
4164	* direct session).
4165	*
4166	* On Win32 and on OS/2, this method is called only when we've got the
4167	* direct client's process termination notification, so it always returns @c
4168	* true.
4169	*
4170	* On other platforms, this method returns @c true if the client process is
4171	* terminated and @c false if it's still alive.
4172	*
4173	* @note Locks this object for writing.
4174	*/
4175	bool Machine::checkForSpawnFailure()
4176	{
4177	AutoCaller autoCaller (this);
4178	if (!autoCaller.isOk())
4179	{
4180	/* nothing to do */
4181	LogFlowThisFunc (("Already uninitialized!"));
4182	return true;
4183	}
4184
4185	/* VirtualBox::addProcessToReap() needs a write lock */
4186	AutoMultiWriteLock2 alock (mParent, this);
4187
4188	if (mData->mSession.mState != SessionState_Spawning)
4189	{
4190	/* nothing to do */
4191	LogFlowThisFunc (("Not spawning any more!"));
4192	return true;
4193	}
4194
4195	HRESULT rc = S_OK;
4196
4197	#if defined (RT_OS_WINDOWS) \|\| defined (RT_OS_OS2)
4198
4199	/* the process was already unexpectedly terminated, we just need to set an
4200	* error and finalize session spawning */
4201	rc = setError (E_FAIL,
4202	tr ("Virtual machine '%ls' has terminated unexpectedly "
4203	"during startup"),
4204	name().raw());
4205	#else
4206
4207	RTPROCSTATUS status;
4208	int vrc = ::RTProcWait (mData->mSession.mPid, RTPROCWAIT_FLAGS_NOBLOCK,
4209	&status);
4210
4211	if (vrc != VERR_PROCESS_RUNNING)
4212	rc = setError (E_FAIL,
4213	tr ("Virtual machine '%ls' has terminated unexpectedly "
4214	"during startup"),
4215	name().raw());
4216	#endif
4217
4218	if (FAILED (rc))
4219	{
4220	/* Close the remote session, remove the remote control from the list
4221	* and reset session state to Closed (@note keep the code in sync with
4222	* the relevant part in checkForSpawnFailure()). */
4223
4224	Assert (mData->mSession.mRemoteControls.size() == 1);
4225	if (mData->mSession.mRemoteControls.size() == 1)
4226	{
4227	ErrorInfoKeeper eik;
4228	mData->mSession.mRemoteControls.front()->Uninitialize();
4229	}
4230
4231	mData->mSession.mRemoteControls.clear();
4232	mData->mSession.mState = SessionState_Closed;
4233
4234	/* finalize the progress after setting the state, for consistency */
4235	mData->mSession.mProgress->notifyComplete (rc);
4236	mData->mSession.mProgress.setNull();
4237
4238	mParent->addProcessToReap (mData->mSession.mPid);
4239	mData->mSession.mPid = NIL_RTPROCESS;
4240
4241	mParent->onSessionStateChange (mData->mUuid, SessionState_Closed);
4242	return true;
4243	}
4244
4245	return false;
4246	}
4247
4248	/**
4249	* Checks that the registered flag of the machine can be set according to
4250	* the argument and sets it. On success, commits and saves all settings.
4251	*
4252	* @note When this machine is inaccessible, the only valid value for \a
4253	* aRegistered is FALSE (i.e. unregister the machine) because unregistered
4254	* inaccessible machines are not currently supported. Note that unregistering
4255	* an inaccessible machine will \b uninitialize this machine object. Therefore,
4256	* the caller must make sure there are no active Machine::addCaller() calls
4257	* on the current thread because this will block Machine::uninit().
4258	*
4259	* @note Must be called from mParent's write lock. Locks this object and
4260	* children for writing.
4261	*/
4262	HRESULT Machine::trySetRegistered (BOOL aRegistered)
4263	{
4264	AssertReturn (mParent->isWriteLockOnCurrentThread(), E_FAIL);
4265
4266	AutoLimitedCaller autoCaller (this);
4267	AssertComRCReturnRC (autoCaller.rc());
4268
4269	AutoWriteLock alock (this);
4270
4271	/* wait for state dependants to drop to zero */
4272	ensureNoStateDependencies();
4273
4274	ComAssertRet (mData->mRegistered != aRegistered, E_FAIL);
4275
4276	if (!mData->mAccessible)
4277	{
4278	/* A special case: the machine is not accessible. */
4279
4280	/* inaccessible machines can only be unregistered */
4281	AssertReturn (!aRegistered, E_FAIL);
4282
4283	/* Uninitialize ourselves here because currently there may be no
4284	* unregistered that are inaccessible (this state combination is not
4285	* supported). Note releasing the caller and leaving the lock before
4286	* calling uninit() */
4287
4288	alock.leave();
4289	autoCaller.release();
4290
4291	uninit();
4292
4293	return S_OK;
4294	}
4295
4296	AssertReturn (autoCaller.state() == Ready, E_FAIL);
4297
4298	/* we will probably modify these and want to prevent concurrent
4299	* modifications until we finish */
4300	AutoWriteLock dvdLock (mDVDDrive);
4301	AutoWriteLock floppyLock (mFloppyDrive);
4302
4303	if (aRegistered)
4304	{
4305	if (mData->mRegistered)
4306	return setError (VBOX_E_INVALID_OBJECT_STATE,
4307	tr ("The machine '%ls' with UUID {%s} is already registered"),
4308	mUserData->mName.raw(),
4309	mData->mUuid.toString().raw());
4310	}
4311	else
4312	{
4313	if (mData->mMachineState == MachineState_Saved)
4314	return setError (VBOX_E_INVALID_VM_STATE,
4315	tr ("Cannot unregister the machine '%ls' because it "
4316	"is in the Saved state"),
4317	mUserData->mName.raw());
4318
4319	size_t snapshotCount = 0;
4320	if (mData->mFirstSnapshot)
4321	snapshotCount = mData->mFirstSnapshot->descendantCount() + 1;
4322	if (snapshotCount)
4323	return setError (VBOX_E_INVALID_OBJECT_STATE,
4324	tr ("Cannot unregister the machine '%ls' because it "
4325	"has %d snapshots"),
4326	mUserData->mName.raw(), snapshotCount);
4327
4328	if (mData->mSession.mState != SessionState_Closed)
4329	return setError (VBOX_E_INVALID_OBJECT_STATE,
4330	tr ("Cannot unregister the machine '%ls' because it has an "
4331	"open session"),
4332	mUserData->mName.raw());
4333
4334	if (mHDData->mAttachments.size() != 0)
4335	return setError (VBOX_E_INVALID_OBJECT_STATE,
4336	tr ("Cannot unregister the machine '%ls' because it "
4337	"has %d hard disks attached"),
4338	mUserData->mName.raw(), mHDData->mAttachments.size());
4339
4340	/* Note that we do not prevent unregistration of a DVD or Floppy image
4341	* is attached: as opposed to hard disks detaching such an image
4342	* implicitly in this method (which we will do below) won't have any
4343	* side effects (like detached orphan base and diff hard disks etc).*/
4344	}
4345
4346	HRESULT rc = S_OK;
4347
4348	/* Ensure the settings are saved. If we are going to be registered and
4349	* isConfigLocked() is FALSE then it means that no config file exists yet,
4350	* so create it by calling saveSettings() too. */
4351	if (isModified() \|\| (aRegistered && !isConfigLocked()))
4352	{
4353	rc = saveSettings();
4354	CheckComRCReturnRC (rc);
4355	}
4356
4357	/* Implicitly detach DVD/Floppy */
4358	rc = mDVDDrive->unmount();
4359	if (SUCCEEDED (rc))
4360	rc = mFloppyDrive->unmount();
4361
4362	if (SUCCEEDED (rc))
4363	{
4364	/* we may have had implicit modifications we want to fix on success */
4365	commit();
4366
4367	mData->mRegistered = aRegistered;
4368	}
4369	else
4370	{
4371	/* we may have had implicit modifications we want to cancel on failure*/
4372	rollback (false /* aNotify */);
4373	}
4374
4375	return rc;
4376	}
4377
4378	/**
4379	* Increases the number of objects dependent on the machine state or on the
4380	* registered state. Guarantees that these two states will not change at least
4381	* until #releaseStateDependency() is called.
4382	*
4383	* Depending on the @a aDepType value, additional state checks may be made.
4384	* These checks will set extended error info on failure. See
4385	* #checkStateDependency() for more info.
4386	*
4387	* If this method returns a failure, the dependency is not added and the caller
4388	* is not allowed to rely on any particular machine state or registration state
4389	* value and may return the failed result code to the upper level.
4390	*
4391	* @param aDepType Dependency type to add.
4392	* @param aState Current machine state (NULL if not interested).
4393	* @param aRegistered Current registered state (NULL if not interested).
4394	*
4395	* @note Locks this object for writing.
4396	*/
4397	HRESULT Machine::addStateDependency (StateDependency aDepType /* = AnyStateDep */,
4398	MachineState_T aState / = NULL */,
4399	BOOL aRegistered / = NULL */)
4400	{
4401	AutoCaller autoCaller (this);
4402	AssertComRCReturnRC (autoCaller.rc());
4403
4404	AutoWriteLock alock (this);
4405
4406	HRESULT rc = checkStateDependency (aDepType);
4407	CheckComRCReturnRC (rc);
4408
4409	{
4410	if (mData->mMachineStateChangePending != 0)
4411	{
4412	/* ensureNoStateDependencies() is waiting for state dependencies to
4413	* drop to zero so don't add more. It may make sense to wait a bit
4414	* and retry before reporting an error (since the pending state
4415	* transition should be really quick) but let's just assert for
4416	* now to see if it ever happens on practice. */
4417
4418	AssertFailed();
4419
4420	return setError (E_ACCESSDENIED,
4421	tr ("Machine state change is in progress. "
4422	"Please retry the operation later."));
4423	}
4424
4425	++ mData->mMachineStateDeps;
4426	Assert (mData->mMachineStateDeps != 0 /* overflow */);
4427	}
4428
4429	if (aState)
4430	*aState = mData->mMachineState;
4431	if (aRegistered)
4432	*aRegistered = mData->mRegistered;
4433
4434	return S_OK;
4435	}
4436
4437	/**
4438	* Decreases the number of objects dependent on the machine state.
4439	* Must always complete the #addStateDependency() call after the state
4440	* dependency is no more necessary.
4441	*/
4442	void Machine::releaseStateDependency()
4443	{
4444	AutoCaller autoCaller (this);
4445	AssertComRCReturnVoid (autoCaller.rc());
4446
4447	AutoWriteLock alock (this);
4448
4449	AssertReturnVoid (mData->mMachineStateDeps != 0
4450	/* releaseStateDependency() w/o addStateDependency()? */);
4451	-- mData->mMachineStateDeps;
4452
4453	if (mData->mMachineStateDeps == 0)
4454	{
4455	/* inform ensureNoStateDependencies() that there are no more deps */
4456	if (mData->mMachineStateChangePending != 0)
4457	{
4458	Assert (mData->mMachineStateDepsSem != NIL_RTSEMEVENTMULTI);
4459	RTSemEventMultiSignal (mData->mMachineStateDepsSem);
4460	}
4461	}
4462	}
4463
4464	// protected methods
4465	/////////////////////////////////////////////////////////////////////////////
4466
4467	/**
4468	* Performs machine state checks based on the @a aDepType value. If a check
4469	* fails, this method will set extended error info, otherwise it will return
4470	* S_OK. It is supposed, that on failure, the caller will immedieately return
4471	* the return value of this method to the upper level.
4472	*
4473	* When @a aDepType is AnyStateDep, this method always returns S_OK.
4474	*
4475	* When @a aDepType is MutableStateDep, this method returns S_OK only if the
4476	* current state of this machine object allows to change settings of the
4477	* machine (i.e. the machine is not registered, or registered but not running
4478	* and not saved). It is useful to call this method from Machine setters
4479	* before performing any change.
4480	*
4481	* When @a aDepType is MutableOrSavedStateDep, this method behaves the same
4482	* as for MutableStateDep except that if the machine is saved, S_OK is also
4483	* returned. This is useful in setters which allow changing machine
4484	* properties when it is in the saved state.
4485	*
4486	* @param aDepType Dependency type to check.
4487	*
4488	* @note Non Machine based classes should use #addStateDependency() and
4489	* #releaseStateDependency() methods or the smart AutoStateDependency
4490	* template.
4491	*
4492	* @note This method must be called from under this object's read or write
4493	* lock.
4494	*/
4495	HRESULT Machine::checkStateDependency (StateDependency aDepType)
4496	{
4497	switch (aDepType)
4498	{
4499	case AnyStateDep:
4500	{
4501	break;
4502	}
4503	case MutableStateDep:
4504	{
4505	if (mData->mRegistered &&
4506	(mType != IsSessionMachine \|\|
4507	mData->mMachineState > MachineState_Paused \|\|
4508	mData->mMachineState == MachineState_Saved))
4509	return setError (VBOX_E_INVALID_VM_STATE,
4510	tr ("The machine is not mutable (state is %d)"),
4511	mData->mMachineState);
4512	break;
4513	}
4514	case MutableOrSavedStateDep:
4515	{
4516	if (mData->mRegistered &&
4517	(mType != IsSessionMachine \|\|
4518	mData->mMachineState > MachineState_Paused))
4519	return setError (VBOX_E_INVALID_VM_STATE,
4520	tr ("The machine is not mutable (state is %d)"),
4521	mData->mMachineState);
4522	break;
4523	}
4524	}
4525
4526	return S_OK;
4527	}
4528
4529	/**
4530	* Helper to initialize all associated child objects and allocate data
4531	* structures.
4532	*
4533	* This method must be called as a part of the object's initialization procedure
4534	* (usually done in the #init() method).
4535	*
4536	* @note Must be called only from #init() or from #registeredInit().
4537	*/
4538	HRESULT Machine::initDataAndChildObjects()
4539	{
4540	AutoCaller autoCaller (this);
4541	AssertComRCReturnRC (autoCaller.rc());
4542	AssertComRCReturn (autoCaller.state() == InInit \|\|
4543	autoCaller.state() == Limited, E_FAIL);
4544
4545	AssertReturn (!mData->mAccessible, E_FAIL);
4546
4547	/* allocate data structures */
4548	mSSData.allocate();
4549	mUserData.allocate();
4550	mHWData.allocate();
4551	mHDData.allocate();
4552	mStorageControllers.allocate();
4553
4554	/* initialize mOSTypeId */
4555	mUserData->mOSTypeId = mParent->getUnknownOSType()->id();
4556
4557	/* create associated BIOS settings object */
4558	unconst (mBIOSSettings).createObject();
4559	mBIOSSettings->init (this);
4560
4561	#ifdef VBOX_WITH_VRDP
4562	/* create an associated VRDPServer object (default is disabled) */
4563	unconst (mVRDPServer).createObject();
4564	mVRDPServer->init (this);
4565	#endif
4566
4567	/* create an associated DVD drive object */
4568	unconst (mDVDDrive).createObject();
4569	mDVDDrive->init (this);
4570
4571	/* create an associated floppy drive object */
4572	unconst (mFloppyDrive).createObject();
4573	mFloppyDrive->init (this);
4574
4575	/* create associated serial port objects */
4576	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
4577	{
4578	unconst (mSerialPorts [slot]).createObject();
4579	mSerialPorts [slot]->init (this, slot);
4580	}
4581
4582	/* create associated parallel port objects */
4583	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
4584	{
4585	unconst (mParallelPorts [slot]).createObject();
4586	mParallelPorts [slot]->init (this, slot);
4587	}
4588
4589	/* create the audio adapter object (always present, default is disabled) */
4590	unconst (mAudioAdapter).createObject();
4591	mAudioAdapter->init (this);
4592
4593	/* create the USB controller object (always present, default is disabled) */
4594	unconst (mUSBController).createObject();
4595	mUSBController->init (this);
4596
4597	/* create associated network adapter objects */
4598	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
4599	{
4600	unconst (mNetworkAdapters [slot]).createObject();
4601	mNetworkAdapters [slot]->init (this, slot);
4602	}
4603
4604	return S_OK;
4605	}
4606
4607	/**
4608	* Helper to uninitialize all associated child objects and to free all data
4609	* structures.
4610	*
4611	* This method must be called as a part of the object's uninitialization
4612	* procedure (usually done in the #uninit() method).
4613	*
4614	* @note Must be called only from #uninit() or from #registeredInit().
4615	*/
4616	void Machine::uninitDataAndChildObjects()
4617	{
4618	AutoCaller autoCaller (this);
4619	AssertComRCReturnVoid (autoCaller.rc());
4620	AssertComRCReturnVoid (autoCaller.state() == InUninit \|\|
4621	autoCaller.state() == Limited);
4622
4623	/* uninit all children using addDependentChild()/removeDependentChild()
4624	* in their init()/uninit() methods */
4625	uninitDependentChildren();
4626
4627	/* tell all our other child objects we've been uninitialized */
4628
4629	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
4630	{
4631	if (mNetworkAdapters [slot])
4632	{
4633	mNetworkAdapters [slot]->uninit();
4634	unconst (mNetworkAdapters [slot]).setNull();
4635	}
4636	}
4637
4638	if (mUSBController)
4639	{
4640	mUSBController->uninit();
4641	unconst (mUSBController).setNull();
4642	}
4643
4644	if (mAudioAdapter)
4645	{
4646	mAudioAdapter->uninit();
4647	unconst (mAudioAdapter).setNull();
4648	}
4649
4650	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
4651	{
4652	if (mParallelPorts [slot])
4653	{
4654	mParallelPorts [slot]->uninit();
4655	unconst (mParallelPorts [slot]).setNull();
4656	}
4657	}
4658
4659	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
4660	{
4661	if (mSerialPorts [slot])
4662	{
4663	mSerialPorts [slot]->uninit();
4664	unconst (mSerialPorts [slot]).setNull();
4665	}
4666	}
4667
4668	if (mFloppyDrive)
4669	{
4670	mFloppyDrive->uninit();
4671	unconst (mFloppyDrive).setNull();
4672	}
4673
4674	if (mDVDDrive)
4675	{
4676	mDVDDrive->uninit();
4677	unconst (mDVDDrive).setNull();
4678	}
4679
4680	#ifdef VBOX_WITH_VRDP
4681	if (mVRDPServer)
4682	{
4683	mVRDPServer->uninit();
4684	unconst (mVRDPServer).setNull();
4685	}
4686	#endif
4687
4688	if (mBIOSSettings)
4689	{
4690	mBIOSSettings->uninit();
4691	unconst (mBIOSSettings).setNull();
4692	}
4693
4694	/* Deassociate hard disks (only when a real Machine or a SnapshotMachine
4695	* instance is uninitialized; SessionMachine instances refer to real
4696	* Machine hard disks). This is necessary for a clean re-initialization of
4697	* the VM after successfully re-checking the accessibility state. Note
4698	* that in case of normal Machine or SnapshotMachine uninitialization (as
4699	* a result of unregistering or discarding the snapshot), outdated hard
4700	* disk attachments will already be uninitialized and deleted, so this
4701	* code will not affect them. */
4702	if (!!mHDData && (mType == IsMachine \|\| mType == IsSnapshotMachine))
4703	{
4704	for (HDData::AttachmentList::const_iterator it =
4705	mHDData->mAttachments.begin();
4706	it != mHDData->mAttachments.end();
4707	++ it)
4708	{
4709	HRESULT rc = (*it)->hardDisk()->detachFrom (mData->mUuid,
4710	snapshotId());
4711	AssertComRC (rc);
4712	}
4713	}
4714
4715	if (mType == IsMachine)
4716	{
4717	/* reset some important fields of mData */
4718	mData->mCurrentSnapshot.setNull();
4719	mData->mFirstSnapshot.setNull();
4720	}
4721
4722	/* free data structures (the essential mData structure is not freed here
4723	* since it may be still in use) */
4724	mHDData.free();
4725	mStorageControllers.free();
4726	mHWData.free();
4727	mUserData.free();
4728	mSSData.free();
4729	}
4730
4731	/**
4732	* Makes sure that there are no machine state dependants. If necessary, waits
4733	* for the number of dependants to drop to zero.
4734	*
4735	* Make sure this method is called from under this object's write lock to
4736	* guarantee that no new dependants may be added when this method returns
4737	* control to the caller.
4738	*
4739	* @note Locks this object for writing. The lock will be released while waiting
4740	* (if necessary).
4741	*
4742	* @warning To be used only in methods that change the machine state!
4743	*/
4744	void Machine::ensureNoStateDependencies()
4745	{
4746	AssertReturnVoid (isWriteLockOnCurrentThread());
4747
4748	AutoWriteLock alock (this);
4749
4750	/* Wait for all state dependants if necessary */
4751	if (mData->mMachineStateDeps != 0)
4752	{
4753	/* lazy semaphore creation */
4754	if (mData->mMachineStateDepsSem == NIL_RTSEMEVENTMULTI)
4755	RTSemEventMultiCreate (&mData->mMachineStateDepsSem);
4756
4757	LogFlowThisFunc (("Waiting for state deps (%d) to drop to zero...\n",
4758	mData->mMachineStateDeps));
4759
4760	++ mData->mMachineStateChangePending;
4761
4762	/* reset the semaphore before waiting, the last dependant will signal
4763	* it */
4764	RTSemEventMultiReset (mData->mMachineStateDepsSem);
4765
4766	alock.leave();
4767
4768	RTSemEventMultiWait (mData->mMachineStateDepsSem, RT_INDEFINITE_WAIT);
4769
4770	alock.enter();
4771
4772	-- mData->mMachineStateChangePending;
4773	}
4774	}
4775
4776	/**
4777	* Changes the machine state and informs callbacks.
4778	*
4779	* This method is not intended to fail so it either returns S_OK or asserts (and
4780	* returns a failure).
4781	*
4782	* @note Locks this object for writing.
4783	*/
4784	HRESULT Machine::setMachineState (MachineState_T aMachineState)
4785	{
4786	LogFlowThisFuncEnter();
4787	LogFlowThisFunc (("aMachineState=%d\n", aMachineState));
4788
4789	AutoCaller autoCaller (this);
4790	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
4791
4792	AutoWriteLock alock (this);
4793
4794	/* wait for state dependants to drop to zero */
4795	ensureNoStateDependencies();
4796
4797	if (mData->mMachineState != aMachineState)
4798	{
4799	mData->mMachineState = aMachineState;
4800
4801	RTTimeNow (&mData->mLastStateChange);
4802
4803	mParent->onMachineStateChange (mData->mUuid, aMachineState);
4804	}
4805
4806	LogFlowThisFuncLeave();
4807	return S_OK;
4808	}
4809
4810	/**
4811	* Searches for a shared folder with the given logical name
4812	* in the collection of shared folders.
4813	*
4814	* @param aName logical name of the shared folder
4815	* @param aSharedFolder where to return the found object
4816	* @param aSetError whether to set the error info if the folder is
4817	* not found
4818	* @return
4819	* S_OK when found or VBOX_E_OBJECT_NOT_FOUND when not found
4820	*
4821	* @note
4822	* must be called from under the object's lock!
4823	*/
4824	HRESULT Machine::findSharedFolder (CBSTR aName,
4825	ComObjPtr <SharedFolder> &aSharedFolder,
4826	bool aSetError /* = false */)
4827	{
4828	bool found = false;
4829	for (HWData::SharedFolderList::const_iterator it = mHWData->mSharedFolders.begin();
4830	!found && it != mHWData->mSharedFolders.end();
4831	++ it)
4832	{
4833	AutoWriteLock alock (*it);
4834	found = (*it)->name() == aName;
4835	if (found)
4836	aSharedFolder = *it;
4837	}
4838
4839	HRESULT rc = found ? S_OK : VBOX_E_OBJECT_NOT_FOUND;
4840
4841	if (aSetError && !found)
4842	setError (rc, tr ("Could not find a shared folder named '%ls'"), aName);
4843
4844	return rc;
4845	}
4846
4847	/**
4848	* Loads all the VM settings by walking down the <Machine> node.
4849	*
4850	* @param aRegistered true when the machine is being loaded on VirtualBox
4851	* startup
4852	*
4853	* @note This method is intended to be called only from init(), so it assumes
4854	* all machine data fields have appropriate default values when it is called.
4855	*
4856	* @note Doesn't lock any objects.
4857	*/
4858	HRESULT Machine::loadSettings (bool aRegistered)
4859	{
4860	LogFlowThisFuncEnter();
4861	AssertReturn (mType == IsMachine, E_FAIL);
4862
4863	AutoCaller autoCaller (this);
4864	AssertReturn (autoCaller.state() == InInit, E_FAIL);
4865
4866	HRESULT rc = S_OK;
4867
4868	try
4869	{
4870	using namespace settings;
4871	using namespace xml;
4872
4873	/* no concurrent file access is possible in init() so open by handle */
4874	File file (mData->mHandleCfgFile, Utf8Str (mData->mConfigFileFull));
4875	XmlTreeBackend tree;
4876
4877	rc = VirtualBox::loadSettingsTree_FirstTime (tree, file,
4878	mData->mSettingsFileVersion);
4879	CheckComRCThrowRC (rc);
4880
4881	Key machineNode = tree.rootKey().key ("Machine");
4882
4883	/* uuid (required) */
4884	Guid id = machineNode.value <Guid> ("uuid");
4885
4886	/* If the stored UUID is not empty, it means the registered machine
4887	* is being loaded. Compare the loaded UUID with the stored one taken
4888	* from the global registry. */
4889	if (!mData->mUuid.isEmpty())
4890	{
4891	if (mData->mUuid != id)
4892	{
4893	throw setError (E_FAIL,
4894	tr ("Machine UUID {%RTuuid} in '%ls' doesn't match its "
4895	"UUID {%s} in the registry file '%ls'"),
4896	id.raw(), mData->mConfigFileFull.raw(),
4897	mData->mUuid.toString().raw(),
4898	mParent->settingsFileName().raw());
4899	}
4900	}
4901	else
4902	unconst (mData->mUuid) = id;
4903
4904	/* name (required) */
4905	mUserData->mName = machineNode.stringValue ("name");
4906
4907	/* nameSync (optional, default is true) */
4908	mUserData->mNameSync = machineNode.value <bool> ("nameSync");
4909
4910	/* Description (optional, default is null) */
4911	{
4912	Key descNode = machineNode.findKey ("Description");
4913	if (!descNode.isNull())
4914	mUserData->mDescription = descNode.keyStringValue();
4915	else
4916	mUserData->mDescription.setNull();
4917	}
4918
4919	/* OSType (required) */
4920	{
4921	mUserData->mOSTypeId = machineNode.stringValue ("OSType");
4922
4923	/* look up the object by Id to check it is valid */
4924	ComPtr <IGuestOSType> guestOSType;
4925	rc = mParent->GetGuestOSType (mUserData->mOSTypeId,
4926	guestOSType.asOutParam());
4927	CheckComRCThrowRC (rc);
4928	}
4929
4930	/* stateFile (optional) */
4931	{
4932	Bstr stateFilePath = machineNode.stringValue ("stateFile");
4933	if (stateFilePath)
4934	{
4935	Utf8Str stateFilePathFull = stateFilePath;
4936	int vrc = calculateFullPath (stateFilePathFull, stateFilePathFull);
4937	if (RT_FAILURE (vrc))
4938	{
4939	throw setError (E_FAIL,
4940	tr ("Invalid saved state file path '%ls' (%Rrc)"),
4941	stateFilePath.raw(), vrc);
4942	}
4943	mSSData->mStateFilePath = stateFilePathFull;
4944	}
4945	else
4946	mSSData->mStateFilePath.setNull();
4947	}
4948
4949	/*
4950	* currentSnapshot ID (optional)
4951	*
4952	* Note that due to XML Schema constaraints, this attribute, when
4953	* present, will guaranteedly refer to an existing snapshot
4954	* definition in XML
4955	*/
4956	Guid currentSnapshotId = machineNode.valueOr <Guid> ("currentSnapshot",
4957	Guid());
4958
4959	/* snapshotFolder (optional) */
4960	{
4961	Bstr folder = machineNode.stringValue ("snapshotFolder");
4962	rc = COMSETTER (SnapshotFolder) (folder);
4963	CheckComRCThrowRC (rc);
4964	}
4965
4966	/* currentStateModified (optional, default is true) */
4967	mData->mCurrentStateModified = machineNode.value <bool> ("currentStateModified");
4968
4969	/* lastStateChange (optional, defaults to now) */
4970	{
4971	RTTIMESPEC now;
4972	RTTimeNow (&now);
4973	mData->mLastStateChange =
4974	machineNode.valueOr <RTTIMESPEC> ("lastStateChange", now);
4975	}
4976
4977	/* aborted (optional, default is false) */
4978	bool aborted = machineNode.value <bool> ("aborted");
4979
4980	/*
4981	* note: all mUserData members must be assigned prior this point because
4982	* we need to commit changes in order to let mUserData be shared by all
4983	* snapshot machine instances.
4984	*/
4985	mUserData.commitCopy();
4986
4987	/* Snapshot node (optional) */
4988	{
4989	Key snapshotNode = machineNode.findKey ("Snapshot");
4990	if (!snapshotNode.isNull())
4991	{
4992	/* read all snapshots recursively */
4993	rc = loadSnapshot (snapshotNode, currentSnapshotId, NULL);
4994	CheckComRCThrowRC (rc);
4995	}
4996	}
4997
4998	Key hardwareNode = machineNode.key("Hardware");
4999
5000	/* Hardware node (required) */
5001	rc = loadHardware (hardwareNode);
5002	CheckComRCThrowRC (rc);
5003
5004	/* Load storage controllers */
5005	rc = loadStorageControllers (machineNode.key ("StorageControllers"), aRegistered);
5006	CheckComRCThrowRC (rc);
5007
5008	/*
5009	* NOTE: the assignment below must be the last thing to do,
5010	* otherwise it will be not possible to change the settings
5011	* somewehere in the code above because all setters will be
5012	* blocked by checkStateDependency (MutableStateDep).
5013	*/
5014
5015	/* set the machine state to Aborted or Saved when appropriate */
5016	if (aborted)
5017	{
5018	Assert (!mSSData->mStateFilePath);
5019	mSSData->mStateFilePath.setNull();
5020
5021	/* no need to use setMachineState() during init() */
5022	mData->mMachineState = MachineState_Aborted;
5023	}
5024	else if (mSSData->mStateFilePath)
5025	{
5026	/* no need to use setMachineState() during init() */
5027	mData->mMachineState = MachineState_Saved;
5028	}
5029	}
5030	catch (HRESULT err)
5031	{
5032	/* we assume that error info is set by the thrower */
5033	rc = err;
5034	}
5035	catch (...)
5036	{
5037	rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
5038	}
5039
5040	LogFlowThisFuncLeave();
5041	return rc;
5042	}
5043
5044	/**
5045	* Recursively loads all snapshots starting from the given.
5046	*
5047	* @param aNode <Snapshot> node.
5048	* @param aCurSnapshotId Current snapshot ID from the settings file.
5049	* @param aParentSnapshot Parent snapshot.
5050	*/
5051	HRESULT Machine::loadSnapshot (const settings::Key &aNode,
5052	const Guid &aCurSnapshotId,
5053	Snapshot *aParentSnapshot)
5054	{
5055	using namespace settings;
5056
5057	AssertReturn (!aNode.isNull(), E_INVALIDARG);
5058	AssertReturn (mType == IsMachine, E_FAIL);
5059
5060	/* create a snapshot machine object */
5061	ComObjPtr <SnapshotMachine> snapshotMachine;
5062	snapshotMachine.createObject();
5063
5064	HRESULT rc = S_OK;
5065
5066	/* required */
5067	Guid uuid = aNode.value <Guid> ("uuid");
5068
5069	{
5070	/* optional */
5071	Bstr stateFilePath = aNode.stringValue ("stateFile");
5072	if (stateFilePath)
5073	{
5074	Utf8Str stateFilePathFull = stateFilePath;
5075	int vrc = calculateFullPath (stateFilePathFull, stateFilePathFull);
5076	if (RT_FAILURE (vrc))
5077	return setError (E_FAIL,
5078	tr ("Invalid saved state file path '%ls' (%Rrc)"),
5079	stateFilePath.raw(), vrc);
5080
5081	stateFilePath = stateFilePathFull;
5082	}
5083
5084	/* Hardware node (required) */
5085	Key hardwareNode = aNode.key ("Hardware");
5086
5087	/* StorageControllers node (required) */
5088	Key storageNode = aNode.key ("StorageControllers");
5089
5090	/* initialize the snapshot machine */
5091	rc = snapshotMachine->init (this, hardwareNode, storageNode,
5092	uuid, stateFilePath);
5093	CheckComRCReturnRC (rc);
5094	}
5095
5096	/* create a snapshot object */
5097	ComObjPtr <Snapshot> snapshot;
5098	snapshot.createObject();
5099
5100	{
5101	/* required */
5102	Bstr name = aNode.stringValue ("name");
5103
5104	/* required */
5105	RTTIMESPEC timeStamp = aNode.value <RTTIMESPEC> ("timeStamp");
5106
5107	/* optional */
5108	Bstr description;
5109	{
5110	Key descNode = aNode.findKey ("Description");
5111	if (!descNode.isNull())
5112	description = descNode.keyStringValue();
5113	}
5114
5115	/* initialize the snapshot */
5116	rc = snapshot->init (uuid, name, description, timeStamp,
5117	snapshotMachine, aParentSnapshot);
5118	CheckComRCReturnRC (rc);
5119	}
5120
5121	/* memorize the first snapshot if necessary */
5122	if (!mData->mFirstSnapshot)
5123	mData->mFirstSnapshot = snapshot;
5124
5125	/* memorize the current snapshot when appropriate */
5126	if (!mData->mCurrentSnapshot && snapshot->data().mId == aCurSnapshotId)
5127	mData->mCurrentSnapshot = snapshot;
5128
5129	/* Snapshots node (optional) */
5130	{
5131	Key snapshotsNode = aNode.findKey ("Snapshots");
5132	if (!snapshotsNode.isNull())
5133	{
5134	Key::List children = snapshotsNode.keys ("Snapshot");
5135	for (Key::List::const_iterator it = children.begin();
5136	it != children.end(); ++ it)
5137	{
5138	rc = loadSnapshot ((*it), aCurSnapshotId, snapshot);
5139	CheckComRCBreakRC (rc);
5140	}
5141	}
5142	}
5143
5144	return rc;
5145	}
5146
5147	/**
5148	* @param aNode <Hardware> node.
5149	*/
5150	HRESULT Machine::loadHardware (const settings::Key &aNode)
5151	{
5152	using namespace settings;
5153
5154	AssertReturn (!aNode.isNull(), E_INVALIDARG);
5155	AssertReturn (mType == IsMachine \|\| mType == IsSnapshotMachine, E_FAIL);
5156
5157	HRESULT rc = S_OK;
5158
5159	/* The hardware version attribute (optional). */
5160	mHWData->mHWVersion = aNode.stringValue ("version");
5161
5162	/* CPU node (currently not required) */
5163	{
5164	/* default value in case the node is not there */
5165	mHWData->mHWVirtExEnabled = TSBool_Default;
5166	mHWData->mHWVirtExNestedPagingEnabled = false;
5167	mHWData->mHWVirtExVPIDEnabled = false;
5168	mHWData->mPAEEnabled = false;
5169
5170	Key cpuNode = aNode.findKey ("CPU");
5171	if (!cpuNode.isNull())
5172	{
5173	Key hwVirtExNode = cpuNode.key ("HardwareVirtEx");
5174	if (!hwVirtExNode.isNull())
5175	{
5176	const char *enabled = hwVirtExNode.stringValue ("enabled");
5177	if (strcmp (enabled, "false") == 0)
5178	mHWData->mHWVirtExEnabled = TSBool_False;
5179	else if (strcmp (enabled, "true") == 0)
5180	mHWData->mHWVirtExEnabled = TSBool_True;
5181	else
5182	mHWData->mHWVirtExEnabled = TSBool_Default;
5183	}
5184	/* HardwareVirtExNestedPaging (optional, default is false) */
5185	Key HWVirtExNestedPagingNode = cpuNode.findKey ("HardwareVirtExNestedPaging");
5186	if (!HWVirtExNestedPagingNode.isNull())
5187	{
5188	mHWData->mHWVirtExNestedPagingEnabled = HWVirtExNestedPagingNode.value <bool> ("enabled");
5189	}
5190
5191	/* HardwareVirtExVPID (optional, default is false) */
5192	Key HWVirtExVPIDNode = cpuNode.findKey ("HardwareVirtExVPID");
5193	if (!HWVirtExVPIDNode.isNull())
5194	{
5195	mHWData->mHWVirtExVPIDEnabled = HWVirtExVPIDNode.value <bool> ("enabled");
5196	}
5197
5198	/* PAE (optional, default is false) */
5199	Key PAENode = cpuNode.findKey ("PAE");
5200	if (!PAENode.isNull())
5201	{
5202	mHWData->mPAEEnabled = PAENode.value <bool> ("enabled");
5203	}
5204
5205	/* CPUCount (optional, default is 1) */
5206	mHWData->mCPUCount = cpuNode.value <ULONG> ("count");
5207	}
5208	}
5209
5210	/* Memory node (required) */
5211	{
5212	Key memoryNode = aNode.key ("Memory");
5213
5214	mHWData->mMemorySize = memoryNode.value <ULONG> ("RAMSize");
5215	}
5216
5217	/* Boot node (required) */
5218	{
5219	/* reset all boot order positions to NoDevice */
5220	for (size_t i = 0; i < RT_ELEMENTS (mHWData->mBootOrder); i++)
5221	mHWData->mBootOrder [i] = DeviceType_Null;
5222
5223	Key bootNode = aNode.key ("Boot");
5224
5225	Key::List orderNodes = bootNode.keys ("Order");
5226	for (Key::List::const_iterator it = orderNodes.begin();
5227	it != orderNodes.end(); ++ it)
5228	{
5229	/* position (required) */
5230	/* position unicity is guaranteed by XML Schema */
5231	uint32_t position = (*it).value <uint32_t> ("position");
5232	-- position;
5233	Assert (position < RT_ELEMENTS (mHWData->mBootOrder));
5234
5235	/* device (required) */
5236	const char device = (it).stringValue ("device");
5237	if (strcmp (device, "None") == 0)
5238	mHWData->mBootOrder [position] = DeviceType_Null;
5239	else if (strcmp (device, "Floppy") == 0)
5240	mHWData->mBootOrder [position] = DeviceType_Floppy;
5241	else if (strcmp (device, "DVD") == 0)
5242	mHWData->mBootOrder [position] = DeviceType_DVD;
5243	else if (strcmp (device, "HardDisk") == 0)
5244	mHWData->mBootOrder [position] = DeviceType_HardDisk;
5245	else if (strcmp (device, "Network") == 0)
5246	mHWData->mBootOrder [position] = DeviceType_Network;
5247	else
5248	ComAssertMsgFailed (("Invalid device: %s", device));
5249	}
5250	}
5251
5252	/* Display node (required) */
5253	{
5254	Key displayNode = aNode.key ("Display");
5255
5256	mHWData->mVRAMSize = displayNode.value <ULONG> ("VRAMSize");
5257	mHWData->mMonitorCount = displayNode.value <ULONG> ("monitorCount");
5258	mHWData->mAccelerate3DEnabled = displayNode.value <bool> ("accelerate3D");
5259	}
5260
5261	#ifdef VBOX_WITH_VRDP
5262	/* RemoteDisplay */
5263	rc = mVRDPServer->loadSettings (aNode);
5264	CheckComRCReturnRC (rc);
5265	#endif
5266
5267	/* BIOS */
5268	rc = mBIOSSettings->loadSettings (aNode);
5269	CheckComRCReturnRC (rc);
5270
5271	/* DVD drive */
5272	rc = mDVDDrive->loadSettings (aNode);
5273	CheckComRCReturnRC (rc);
5274
5275	/* Floppy drive */
5276	rc = mFloppyDrive->loadSettings (aNode);
5277	CheckComRCReturnRC (rc);
5278
5279	/* USB Controller */
5280	rc = mUSBController->loadSettings (aNode);
5281	CheckComRCReturnRC (rc);
5282
5283	/* Network node (required) */
5284	{
5285	/* we assume that all network adapters are initially disabled
5286	* and detached */
5287
5288	Key networkNode = aNode.key ("Network");
5289
5290	rc = S_OK;
5291
5292	Key::List adapters = networkNode.keys ("Adapter");
5293	for (Key::List::const_iterator it = adapters.begin();
5294	it != adapters.end(); ++ it)
5295	{
5296	/* slot number (required) */
5297	/* slot unicity is guaranteed by XML Schema */
5298	uint32_t slot = (*it).value <uint32_t> ("slot");
5299	AssertBreak (slot < RT_ELEMENTS (mNetworkAdapters));
5300
5301	rc = mNetworkAdapters [slot]->loadSettings (*it);
5302	CheckComRCReturnRC (rc);
5303	}
5304	}
5305
5306	/* Serial node (required) */
5307	{
5308	Key serialNode = aNode.key ("UART");
5309
5310	rc = S_OK;
5311
5312	Key::List ports = serialNode.keys ("Port");
5313	for (Key::List::const_iterator it = ports.begin();
5314	it != ports.end(); ++ it)
5315	{
5316	/* slot number (required) */
5317	/* slot unicity is guaranteed by XML Schema */
5318	uint32_t slot = (*it).value <uint32_t> ("slot");
5319	AssertBreak (slot < RT_ELEMENTS (mSerialPorts));
5320
5321	rc = mSerialPorts [slot]->loadSettings (*it);
5322	CheckComRCReturnRC (rc);
5323	}
5324	}
5325
5326	/* Parallel node (optional) */
5327	{
5328	Key parallelNode = aNode.key ("LPT");
5329
5330	rc = S_OK;
5331
5332	Key::List ports = parallelNode.keys ("Port");
5333	for (Key::List::const_iterator it = ports.begin();
5334	it != ports.end(); ++ it)
5335	{
5336	/* slot number (required) */
5337	/* slot unicity is guaranteed by XML Schema */
5338	uint32_t slot = (*it).value <uint32_t> ("slot");
5339	AssertBreak (slot < RT_ELEMENTS (mSerialPorts));
5340
5341	rc = mParallelPorts [slot]->loadSettings (*it);
5342	CheckComRCReturnRC (rc);
5343	}
5344	}
5345
5346	/* AudioAdapter */
5347	rc = mAudioAdapter->loadSettings (aNode);
5348	CheckComRCReturnRC (rc);
5349
5350	/* Shared folders (required) */
5351	{
5352	Key sharedFoldersNode = aNode.key ("SharedFolders");
5353
5354	rc = S_OK;
5355
5356	Key::List folders = sharedFoldersNode.keys ("SharedFolder");
5357	for (Key::List::const_iterator it = folders.begin();
5358	it != folders.end(); ++ it)
5359	{
5360	/* folder logical name (required) */
5361	Bstr name = (*it).stringValue ("name");
5362	/* folder host path (required) */
5363	Bstr hostPath = (*it).stringValue ("hostPath");
5364
5365	bool writable = (*it).value <bool> ("writable");
5366
5367	rc = CreateSharedFolder (name, hostPath, writable);
5368	CheckComRCReturnRC (rc);
5369	}
5370	}
5371
5372	/* Clipboard node (required) */
5373	{
5374	Key clipNode = aNode.key ("Clipboard");
5375
5376	const char *mode = clipNode.stringValue ("mode");
5377	if (strcmp (mode, "Disabled") == 0)
5378	mHWData->mClipboardMode = ClipboardMode_Disabled;
5379	else if (strcmp (mode, "HostToGuest") == 0)
5380	mHWData->mClipboardMode = ClipboardMode_HostToGuest;
5381	else if (strcmp (mode, "GuestToHost") == 0)
5382	mHWData->mClipboardMode = ClipboardMode_GuestToHost;
5383	else if (strcmp (mode, "Bidirectional") == 0)
5384	mHWData->mClipboardMode = ClipboardMode_Bidirectional;
5385	else
5386	AssertMsgFailed (("Invalid clipboard mode '%s'\n", mode));
5387	}
5388
5389	/* Guest node (required) */
5390	{
5391	Key guestNode = aNode.key ("Guest");
5392
5393	/* optional, defaults to 0 */
5394	mHWData->mMemoryBalloonSize =
5395	guestNode.value <ULONG> ("memoryBalloonSize");
5396	/* optional, defaults to 0 */
5397	mHWData->mStatisticsUpdateInterval =
5398	guestNode.value <ULONG> ("statisticsUpdateInterval");
5399	}
5400
5401	#ifdef VBOX_WITH_GUEST_PROPS
5402	/* Guest properties (optional) */
5403	{
5404	using namespace guestProp;
5405
5406	Key guestPropertiesNode = aNode.findKey ("GuestProperties");
5407	Bstr notificationPatterns (""); /* We catch allocation failure below. */
5408	if (!guestPropertiesNode.isNull())
5409	{
5410	Key::List properties = guestPropertiesNode.keys ("GuestProperty");
5411	for (Key::List::const_iterator it = properties.begin();
5412	it != properties.end(); ++ it)
5413	{
5414	uint32_t fFlags = NILFLAG;
5415
5416	/* property name (required) */
5417	Bstr name = (*it).stringValue ("name");
5418	/* property value (required) */
5419	Bstr value = (*it).stringValue ("value");
5420	/* property timestamp (optional, defaults to 0) */
5421	ULONG64 timestamp = (*it).value<ULONG64> ("timestamp");
5422	/* property flags (optional, defaults to empty) */
5423	Bstr flags = (*it).stringValue ("flags");
5424	Utf8Str utf8Flags (flags);
5425	if (utf8Flags.isNull ())
5426	return E_OUTOFMEMORY;
5427	validateFlags (utf8Flags.raw(), &fFlags);
5428	HWData::GuestProperty property = { name, value, timestamp, fFlags };
5429	mHWData->mGuestProperties.push_back (property);
5430	/* This is just sanity, as the push_back() will probably have thrown
5431	* an exception if we are out of memory. Note that if we run out
5432	* allocating the Bstrs above, this will be caught here as well. */
5433	if ( mHWData->mGuestProperties.back().mName.isNull ()
5434	\|\| mHWData->mGuestProperties.back().mValue.isNull ()
5435	)
5436	return E_OUTOFMEMORY;
5437	}
5438	notificationPatterns = guestPropertiesNode.stringValue ("notificationPatterns");
5439	}
5440	mHWData->mPropertyServiceActive = false;
5441	mHWData->mGuestPropertyNotificationPatterns = notificationPatterns;
5442	if (mHWData->mGuestPropertyNotificationPatterns.isNull ())
5443	return E_OUTOFMEMORY;
5444	}
5445	#endif /* VBOX_WITH_GUEST_PROPS defined */
5446
5447	AssertComRC (rc);
5448	return rc;
5449	}
5450
5451	/**
5452	* @param aNode <StorageControllers> node.
5453	*/
5454	HRESULT Machine::loadStorageControllers (const settings::Key &aNode, bool aRegistered,
5455	const Guid aSnapshotId / = NULL */)
5456	{
5457	using namespace settings;
5458
5459	AssertReturn (!aNode.isNull(), E_INVALIDARG);
5460	AssertReturn (mType == IsMachine \|\| mType == IsSnapshotMachine, E_FAIL);
5461
5462	HRESULT rc = S_OK;
5463
5464	Key::List children = aNode.keys ("StorageController");
5465
5466	/* Make sure the attached hard disks don't get unregistered until we
5467	* associate them with tis machine (important for VMs loaded (opened) after
5468	* VirtualBox startup) */
5469	AutoReadLock vboxLock (mParent);
5470
5471	for (Key::List::const_iterator it = children.begin();
5472	it != children.end(); ++ it)
5473	{
5474	Bstr controllerName = (*it).stringValue ("name");
5475	const char controllerType = (it).stringValue ("type");
5476	ULONG portCount = (*it).value <ULONG> ("PortCount");
5477	StorageControllerType_T controller;
5478	StorageBus_T connection;
5479
5480	if (strcmp (controllerType, "AHCI") == 0)
5481	{
5482	connection = StorageBus_SATA;
5483	controller = StorageControllerType_IntelAhci;
5484	}
5485	else if (strcmp (controllerType, "LsiLogic") == 0)
5486	{
5487	connection = StorageBus_SCSI;
5488	controller = StorageControllerType_LsiLogic;
5489	}
5490	else if (strcmp (controllerType, "BusLogic") == 0)
5491	{
5492	connection = StorageBus_SCSI;
5493	controller = StorageControllerType_BusLogic;
5494	}
5495	else if (strcmp (controllerType, "PIIX3") == 0)
5496	{
5497	connection = StorageBus_IDE;
5498	controller = StorageControllerType_PIIX3;
5499	}
5500	else if (strcmp (controllerType, "PIIX4") == 0)
5501	{
5502	connection = StorageBus_IDE;
5503	controller = StorageControllerType_PIIX4;
5504	}
5505	else if (strcmp (controllerType, "ICH6") == 0)
5506	{
5507	connection = StorageBus_IDE;
5508	controller = StorageControllerType_ICH6;
5509	}
5510	else
5511	AssertFailedReturn (E_FAIL);
5512
5513	ComObjPtr<StorageController> ctl;
5514	/* Try to find one with the name first. */
5515	rc = getStorageControllerByName (controllerName, ctl, false /* aSetError */);
5516	if (SUCCEEDED (rc))
5517	return setError (VBOX_E_OBJECT_IN_USE,
5518	tr ("Storage controller named '%ls' already exists"), controllerName.raw());
5519
5520	ctl.createObject();
5521	rc = ctl->init (this, controllerName, connection);
5522	CheckComRCReturnRC (rc);
5523
5524	mStorageControllers->push_back (ctl);
5525
5526	rc = ctl->COMSETTER(ControllerType)(controller);
5527	CheckComRCReturnRC(rc);
5528
5529	rc = ctl->COMSETTER(PortCount)(portCount);
5530	CheckComRCReturnRC(rc);
5531
5532	/* Set IDE emulation settings (only for AHCI controller). */
5533	if (controller == StorageControllerType_IntelAhci)
5534	{
5535	ULONG val;
5536
5537	/* ide emulation settings (optional, default to 0,1,2,3 respectively) */
5538	val = (*it).valueOr <ULONG> ("IDE0MasterEmulationPort", 0);
5539	rc = ctl->SetIDEEmulationPort(0, val);
5540	CheckComRCReturnRC(rc);
5541	val = (*it).valueOr <ULONG> ("IDE0SlaveEmulationPort", 1);
5542	rc = ctl->SetIDEEmulationPort(1, val);
5543	CheckComRCReturnRC(rc);
5544	val = (*it).valueOr <ULONG> ("IDE1MasterEmulationPort", 2);
5545	rc = ctl->SetIDEEmulationPort(2, val);
5546	CheckComRCReturnRC(rc);
5547	val = (*it).valueOr <ULONG> ("IDE1SlaveEmulationPort", 3);
5548	rc = ctl->SetIDEEmulationPort(3, val);
5549	CheckComRCReturnRC(rc);
5550	}
5551
5552	/* Load the attached devices now. */
5553	rc = loadStorageDevices(ctl, (*it),
5554	aRegistered, aSnapshotId);
5555	CheckComRCReturnRC(rc);
5556	}
5557
5558	return S_OK;
5559	}
5560
5561	/**
5562	* @param aNode <HardDiskAttachments> node.
5563	* @param aRegistered true when the machine is being loaded on VirtualBox
5564	* startup, or when a snapshot is being loaded (wchich
5565	* currently can happen on startup only)
5566	* @param aSnapshotId pointer to the snapshot ID if this is a snapshot machine
5567	*
5568	* @note Lock mParent for reading and hard disks for writing before calling.
5569	*/
5570	HRESULT Machine::loadStorageDevices (ComObjPtr<StorageController> aStorageController,
5571	const settings::Key &aNode, bool aRegistered,
5572	const Guid aSnapshotId / = NULL */)
5573	{
5574	using namespace settings;
5575
5576	AssertReturn (!aNode.isNull(), E_INVALIDARG);
5577	AssertReturn ((mType == IsMachine && aSnapshotId == NULL) \|\|
5578	(mType == IsSnapshotMachine && aSnapshotId != NULL), E_FAIL);
5579
5580	HRESULT rc = S_OK;
5581
5582	Key::List children = aNode.keys ("AttachedDevice");
5583
5584	if (!aRegistered && children.size() > 0)
5585	{
5586	/* when the machine is being loaded (opened) from a file, it cannot
5587	* have hard disks attached (this should not happen normally,
5588	* because we don't allow to attach hard disks to an unregistered
5589	* VM at all */
5590	return setError (E_FAIL,
5591	tr ("Unregistered machine '%ls' cannot have hard disks attached "
5592	"(found %d hard disk attachments)"),
5593	mUserData->mName.raw(), children.size());
5594	}
5595
5596	for (Key::List::const_iterator it = children.begin();
5597	it != children.end(); ++ it)
5598	{
5599	Key idKey = (*it).key ("Image");
5600	/* hard disk uuid (required) */
5601	Guid uuid = idKey.value <Guid> ("uuid");
5602	/* device type (required) */
5603	const char deviceType = (it).stringValue ("type");
5604	/* channel (required) */
5605	LONG port = (*it).value <LONG> ("port");
5606	/* device (required) */
5607	LONG device = (*it).value <LONG> ("device");
5608
5609	/* We support only hard disk types at the moment.
5610	* @todo: Implement support for CD/DVD drives.
5611	*/
5612	if (strcmp(deviceType, "HardDisk") != 0)
5613	return setError (E_FAIL,
5614	tr ("Device at position %lu:%lu is not a hard disk: %s"),
5615	port, device, deviceType);
5616
5617	/* find a hard disk by UUID */
5618	ComObjPtr<HardDisk> hd;
5619	rc = mParent->findHardDisk(&uuid, NULL, true /* aDoSetError */, &hd);
5620	CheckComRCReturnRC (rc);
5621
5622	AutoWriteLock hdLock (hd);
5623
5624	if (hd->type() == HardDiskType_Immutable)
5625	{
5626	if (mType == IsSnapshotMachine)
5627	return setError (E_FAIL,
5628	tr ("Immutable hard disk '%ls' with UUID {%RTuuid} cannot be "
5629	"directly attached to snapshot with UUID {%RTuuid} "
5630	"of the virtual machine '%ls' ('%ls')"),
5631	hd->locationFull().raw(), uuid.raw(),
5632	aSnapshotId->raw(),
5633	mUserData->mName.raw(), mData->mConfigFileFull.raw());
5634
5635	return setError (E_FAIL,
5636	tr ("Immutable hard disk '%ls' with UUID {%RTuuid} cannot be "
5637	"directly attached to the virtual machine '%ls' ('%ls')"),
5638	hd->locationFull().raw(), uuid.raw(),
5639	mUserData->mName.raw(), mData->mConfigFileFull.raw());
5640	}
5641
5642	if (mType != IsSnapshotMachine && hd->children().size() != 0)
5643	return setError (E_FAIL,
5644	tr ("Hard disk '%ls' with UUID {%RTuuid} cannot be directly "
5645	"attached to the virtual machine '%ls' ('%ls') "
5646	"because it has %d differencing child hard disks"),
5647	hd->locationFull().raw(), uuid.raw(),
5648	mUserData->mName.raw(), mData->mConfigFileFull.raw(),
5649	hd->children().size());
5650
5651	if (std::find_if (mHDData->mAttachments.begin(),
5652	mHDData->mAttachments.end(),
5653	HardDiskAttachment::RefersTo (hd)) !=
5654	mHDData->mAttachments.end())
5655	{
5656	return setError (E_FAIL,
5657	tr ("Hard disk '%ls' with UUID {%RTuuid} is already attached "
5658	"to the virtual machine '%ls' ('%ls')"),
5659	hd->locationFull().raw(), uuid.raw(),
5660	mUserData->mName.raw(), mData->mConfigFileFull.raw());
5661	}
5662
5663	const Bstr controllerName = aStorageController->name();
5664	ComObjPtr<HardDiskAttachment> attachment;
5665	attachment.createObject();
5666	rc = attachment->init (hd, controllerName, port, device);
5667	CheckComRCBreakRC (rc);
5668
5669	/* associate the hard disk with this machine and snapshot */
5670	if (mType == IsSnapshotMachine)
5671	rc = hd->attachTo (mData->mUuid, *aSnapshotId);
5672	else
5673	rc = hd->attachTo (mData->mUuid);
5674
5675	AssertComRCBreakRC (rc);
5676
5677	/* backup mHDData to let registeredInit() properly rollback on failure
5678	* (= limited accessibility) */
5679
5680	mHDData.backup();
5681	mHDData->mAttachments.push_back (attachment);
5682	}
5683
5684	return rc;
5685	}
5686
5687	/**
5688	* Searches for a <Snapshot> node for the given snapshot.
5689	* If the search is successful, \a aSnapshotNode will contain the found node.
5690	* In this case, \a aSnapshotsNode can be NULL meaning the found node is a
5691	* direct child of \a aMachineNode.
5692	*
5693	* If the search fails, a failure is returned and both \a aSnapshotsNode and
5694	* \a aSnapshotNode are set to 0.
5695	*
5696	* @param aSnapshot Snapshot to search for.
5697	* @param aMachineNode <Machine> node to start from.
5698	* @param aSnapshotsNode <Snapshots> node containing the found <Snapshot> node
5699	* (may be NULL if the caller is not interested).
5700	* @param aSnapshotNode Found <Snapshot> node.
5701	*/
5702	HRESULT Machine::findSnapshotNode (Snapshot *aSnapshot, settings::Key &aMachineNode,
5703	settings::Key *aSnapshotsNode,
5704	settings::Key *aSnapshotNode)
5705	{
5706	using namespace settings;
5707
5708	AssertReturn (aSnapshot && !aMachineNode.isNull()
5709	&& aSnapshotNode != NULL, E_FAIL);
5710
5711	if (aSnapshotsNode)
5712	aSnapshotsNode->setNull();
5713	aSnapshotNode->setNull();
5714
5715	// build the full uuid path (from the top parent to the given snapshot)
5716	std::list <Guid> path;
5717	{
5718	ComObjPtr <Snapshot> parent = aSnapshot;
5719	while (parent)
5720	{
5721	path.push_front (parent->data().mId);
5722	parent = parent->parent();
5723	}
5724	}
5725
5726	Key snapshotsNode = aMachineNode;
5727	Key snapshotNode;
5728
5729	for (std::list <Guid>::const_iterator it = path.begin();
5730	it != path.end();
5731	++ it)
5732	{
5733	if (!snapshotNode.isNull())
5734	{
5735	/* proceed to the nested <Snapshots> node */
5736	snapshotsNode = snapshotNode.key ("Snapshots");
5737	snapshotNode.setNull();
5738	}
5739
5740	AssertReturn (!snapshotsNode.isNull(), E_FAIL);
5741
5742	Key::List children = snapshotsNode.keys ("Snapshot");
5743	for (Key::List::const_iterator ch = children.begin();
5744	ch != children.end();
5745	++ ch)
5746	{
5747	Guid id = (*ch).value <Guid> ("uuid");
5748	if (id == (*it))
5749	{
5750	/* pass over to the outer loop */
5751	snapshotNode = *ch;
5752	break;
5753	}
5754	}
5755
5756	if (!snapshotNode.isNull())
5757	continue;
5758
5759	/* the next uuid is not found, no need to continue... */
5760	AssertFailedBreak();
5761	}
5762
5763	// we must always succesfully find the node
5764	AssertReturn (!snapshotNode.isNull(), E_FAIL);
5765	AssertReturn (!snapshotsNode.isNull(), E_FAIL);
5766
5767	if (aSnapshotsNode && (snapshotsNode != aMachineNode))
5768	*aSnapshotsNode = snapshotsNode;
5769	*aSnapshotNode = snapshotNode;
5770
5771	return S_OK;
5772	}
5773
5774	/**
5775	* Returns the snapshot with the given UUID or fails of no such snapshot.
5776	*
5777	* @param aId snapshot UUID to find (empty UUID refers the first snapshot)
5778	* @param aSnapshot where to return the found snapshot
5779	* @param aSetError true to set extended error info on failure
5780	*/
5781	HRESULT Machine::findSnapshot (const Guid &aId, ComObjPtr <Snapshot> &aSnapshot,
5782	bool aSetError /* = false */)
5783	{
5784	if (!mData->mFirstSnapshot)
5785	{
5786	if (aSetError)
5787	return setError (E_FAIL,
5788	tr ("This machine does not have any snapshots"));
5789	return E_FAIL;
5790	}
5791
5792	if (aId.isEmpty())
5793	aSnapshot = mData->mFirstSnapshot;
5794	else
5795	aSnapshot = mData->mFirstSnapshot->findChildOrSelf (aId);
5796
5797	if (!aSnapshot)
5798	{
5799	if (aSetError)
5800	return setError (E_FAIL,
5801	tr ("Could not find a snapshot with UUID {%s}"),
5802	aId.toString().raw());
5803	return E_FAIL;
5804	}
5805
5806	return S_OK;
5807	}
5808
5809	/**
5810	* Returns the snapshot with the given name or fails of no such snapshot.
5811	*
5812	* @param aName snapshot name to find
5813	* @param aSnapshot where to return the found snapshot
5814	* @param aSetError true to set extended error info on failure
5815	*/
5816	HRESULT Machine::findSnapshot (IN_BSTR aName, ComObjPtr <Snapshot> &aSnapshot,
5817	bool aSetError /* = false */)
5818	{
5819	AssertReturn (aName, E_INVALIDARG);
5820
5821	if (!mData->mFirstSnapshot)
5822	{
5823	if (aSetError)
5824	return setError (VBOX_E_OBJECT_NOT_FOUND,
5825	tr ("This machine does not have any snapshots"));
5826	return VBOX_E_OBJECT_NOT_FOUND;
5827	}
5828
5829	aSnapshot = mData->mFirstSnapshot->findChildOrSelf (aName);
5830
5831	if (!aSnapshot)
5832	{
5833	if (aSetError)
5834	return setError (VBOX_E_OBJECT_NOT_FOUND,
5835	tr ("Could not find a snapshot named '%ls'"), aName);
5836	return VBOX_E_OBJECT_NOT_FOUND;
5837	}
5838
5839	return S_OK;
5840	}
5841
5842	/**
5843	* Returns a storage controller object with the given name.
5844	*
5845	* @param aName storage controller name to find
5846	* @param aStorageController where to return the found storage controller
5847	* @param aSetError true to set extended error info on failure
5848	*/
5849	HRESULT Machine::getStorageControllerByName(CBSTR aName,
5850	ComObjPtr <StorageController> &aStorageController,
5851	bool aSetError /* = false */)
5852	{
5853	AssertReturn (aName, E_INVALIDARG);
5854
5855	for (StorageControllerList::const_iterator it =
5856	mStorageControllers->begin();
5857	it != mStorageControllers->end();
5858	++ it)
5859	{
5860	if ((*it)->name() == aName)
5861	{
5862	aStorageController = (*it);
5863	return S_OK;
5864	}
5865	}
5866
5867	if (aSetError)
5868	return setError (VBOX_E_OBJECT_NOT_FOUND,
5869	tr ("Could not find a storage controller named '%ls'"), aName);
5870	return VBOX_E_OBJECT_NOT_FOUND;
5871	}
5872
5873	HRESULT Machine::getHardDiskAttachmentsOfController(CBSTR aName,
5874	HDData::AttachmentList &atts)
5875	{
5876	AutoCaller autoCaller (this);
5877	CheckComRCReturnRC(autoCaller.rc());
5878
5879	AutoReadLock alock(this);
5880
5881	for (HDData::AttachmentList::iterator it = mHDData->mAttachments.begin();
5882	it != mHDData->mAttachments.end(); ++it)
5883	{
5884	if ((*it)->controller() == aName)
5885	atts.push_back(*it);
5886	}
5887
5888	return S_OK;
5889	}
5890
5891	/**
5892	* Helper for #saveSettings. Cares about renaming the settings directory and
5893	* file if the machine name was changed and about creating a new settings file
5894	* if this is a new machine.
5895	*
5896	* @note Must be never called directly but only from #saveSettings().
5897	*
5898	* @param aRenamed receives \|true\| if the name was changed and the settings
5899	* file was renamed as a result, or \|false\| otherwise. The
5900	* value makes sense only on success.
5901	* @param aNew receives \|true\| if a virgin settings file was created.
5902	*/
5903	HRESULT Machine::prepareSaveSettings (bool &aRenamed, bool &aNew)
5904	{
5905	/* Note: tecnhically, mParent needs to be locked only when the machine is
5906	* registered (see prepareSaveSettings() for details) but we don't
5907	* currently differentiate it in callers of saveSettings() so we don't
5908	* make difference here too. */
5909	AssertReturn (mParent->isWriteLockOnCurrentThread(), E_FAIL);
5910	AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
5911
5912	HRESULT rc = S_OK;
5913
5914	aRenamed = false;
5915
5916	/* if we're ready and isConfigLocked() is FALSE then it means
5917	* that no config file exists yet (we will create a virgin one) */
5918	aNew = !isConfigLocked();
5919
5920	/* attempt to rename the settings file if machine name is changed */
5921	if (mUserData->mNameSync &&
5922	mUserData.isBackedUp() &&
5923	mUserData.backedUpData()->mName != mUserData->mName)
5924	{
5925	aRenamed = true;
5926
5927	if (!aNew)
5928	{
5929	/* unlock the old config file */
5930	rc = unlockConfig();
5931	CheckComRCReturnRC (rc);
5932	}
5933
5934	bool dirRenamed = false;
5935	bool fileRenamed = false;
5936
5937	Utf8Str configFile, newConfigFile;
5938	Utf8Str configDir, newConfigDir;
5939
5940	do
5941	{
5942	int vrc = VINF_SUCCESS;
5943
5944	Utf8Str name = mUserData.backedUpData()->mName;
5945	Utf8Str newName = mUserData->mName;
5946
5947	configFile = mData->mConfigFileFull;
5948
5949	/* first, rename the directory if it matches the machine name */
5950	configDir = configFile;
5951	RTPathStripFilename (configDir.mutableRaw());
5952	newConfigDir = configDir;
5953	if (RTPathFilename (configDir) == name)
5954	{
5955	RTPathStripFilename (newConfigDir.mutableRaw());
5956	newConfigDir = Utf8StrFmt ("%s%c%s",
5957	newConfigDir.raw(), RTPATH_DELIMITER, newName.raw());
5958	/* new dir and old dir cannot be equal here because of 'if'
5959	* above and because name != newName */
5960	Assert (configDir != newConfigDir);
5961	if (!aNew)
5962	{
5963	/* perform real rename only if the machine is not new */
5964	vrc = RTPathRename (configDir.raw(), newConfigDir.raw(), 0);
5965	if (RT_FAILURE (vrc))
5966	{
5967	rc = setError (E_FAIL,
5968	tr ("Could not rename the directory '%s' to '%s' "
5969	"to save the settings file (%Rrc)"),
5970	configDir.raw(), newConfigDir.raw(), vrc);
5971	break;
5972	}
5973	dirRenamed = true;
5974	}
5975	}
5976
5977	newConfigFile = Utf8StrFmt ("%s%c%s.xml",
5978	newConfigDir.raw(), RTPATH_DELIMITER, newName.raw());
5979
5980	/* then try to rename the settings file itself */
5981	if (newConfigFile != configFile)
5982	{
5983	/* get the path to old settings file in renamed directory */
5984	configFile = Utf8StrFmt ("%s%c%s",
5985	newConfigDir.raw(), RTPATH_DELIMITER,
5986	RTPathFilename (configFile));
5987	if (!aNew)
5988	{
5989	/* perform real rename only if the machine is not new */
5990	vrc = RTFileRename (configFile.raw(), newConfigFile.raw(), 0);
5991	if (RT_FAILURE (vrc))
5992	{
5993	rc = setError (E_FAIL,
5994	tr ("Could not rename the settings file '%s' to '%s' "
5995	"(%Rrc)"),
5996	configFile.raw(), newConfigFile.raw(), vrc);
5997	break;
5998	}
5999	fileRenamed = true;
6000	}
6001	}
6002
6003	/* update mConfigFileFull amd mConfigFile */
6004	Bstr oldConfigFileFull = mData->mConfigFileFull;
6005	Bstr oldConfigFile = mData->mConfigFile;
6006	mData->mConfigFileFull = newConfigFile;
6007	/* try to get the relative path for mConfigFile */
6008	Utf8Str path = newConfigFile;
6009	mParent->calculateRelativePath (path, path);
6010	mData->mConfigFile = path;
6011
6012	/* last, try to update the global settings with the new path */
6013	if (mData->mRegistered)
6014	{
6015	rc = mParent->updateSettings (configDir, newConfigDir);
6016	if (FAILED (rc))
6017	{
6018	/* revert to old values */
6019	mData->mConfigFileFull = oldConfigFileFull;
6020	mData->mConfigFile = oldConfigFile;
6021	break;
6022	}
6023	}
6024
6025	/* update the snapshot folder */
6026	path = mUserData->mSnapshotFolderFull;
6027	if (RTPathStartsWith (path, configDir))
6028	{
6029	path = Utf8StrFmt ("%s%s", newConfigDir.raw(),
6030	path.raw() + configDir.length());
6031	mUserData->mSnapshotFolderFull = path;
6032	calculateRelativePath (path, path);
6033	mUserData->mSnapshotFolder = path;
6034	}
6035
6036	/* update the saved state file path */
6037	path = mSSData->mStateFilePath;
6038	if (RTPathStartsWith (path, configDir))
6039	{
6040	path = Utf8StrFmt ("%s%s", newConfigDir.raw(),
6041	path.raw() + configDir.length());
6042	mSSData->mStateFilePath = path;
6043	}
6044
6045	/* Update saved state file paths of all online snapshots.
6046	* Note that saveSettings() will recognize name change
6047	* and will save all snapshots in this case. */
6048	if (mData->mFirstSnapshot)
6049	mData->mFirstSnapshot->updateSavedStatePaths (configDir,
6050	newConfigDir);
6051	}
6052	while (0);
6053
6054	if (FAILED (rc))
6055	{
6056	/* silently try to rename everything back */
6057	if (fileRenamed)
6058	RTFileRename (newConfigFile.raw(), configFile.raw(), 0);
6059	if (dirRenamed)
6060	RTPathRename (newConfigDir.raw(), configDir.raw(), 0);
6061	}
6062
6063	if (!aNew)
6064	{
6065	/* lock the config again */
6066	HRESULT rc2 = lockConfig();
6067	if (SUCCEEDED (rc))
6068	rc = rc2;
6069	}
6070
6071	CheckComRCReturnRC (rc);
6072	}
6073
6074	if (aNew)
6075	{
6076	/* create a virgin config file */
6077	int vrc = VINF_SUCCESS;
6078
6079	/* ensure the settings directory exists */
6080	Utf8Str path = mData->mConfigFileFull;
6081	RTPathStripFilename (path.mutableRaw());
6082	if (!RTDirExists (path))
6083	{
6084	vrc = RTDirCreateFullPath (path, 0777);
6085	if (RT_FAILURE (vrc))
6086	{
6087	return setError (E_FAIL,
6088	tr ("Could not create a directory '%s' "
6089	"to save the settings file (%Rrc)"),
6090	path.raw(), vrc);
6091	}
6092	}
6093
6094	/* Note: open flags must correlate with RTFileOpen() in lockConfig() */
6095	path = Utf8Str (mData->mConfigFileFull);
6096	vrc = RTFileOpen (&mData->mHandleCfgFile, path,
6097	RTFILE_O_READWRITE \| RTFILE_O_CREATE \|
6098	RTFILE_O_DENY_WRITE);
6099	if (RT_SUCCESS (vrc))
6100	{
6101	vrc = RTFileWrite (mData->mHandleCfgFile,
6102	(void *) gDefaultMachineConfig,
6103	strlen (gDefaultMachineConfig), NULL);
6104	}
6105	if (RT_FAILURE (vrc))
6106	{
6107	mData->mHandleCfgFile = NIL_RTFILE;
6108	return setError (E_FAIL,
6109	tr ("Could not create the settings file '%s' (%Rrc)"),
6110	path.raw(), vrc);
6111	}
6112	/* we do not close the file to simulate lockConfig() */
6113	}
6114
6115	return rc;
6116	}
6117
6118	/**
6119	* Saves and commits machine data, user data and hardware data.
6120	*
6121	* Note that on failure, the data remains uncommitted.
6122	*
6123	* @a aFlags may combine the following flags:
6124	*
6125	* - SaveS_ResetCurStateModified: Resets mData->mCurrentStateModified to FALSE.
6126	* Used when saving settings after an operation that makes them 100%
6127	* correspond to the settings from the current snapshot.
6128	* - SaveS_InformCallbacksAnyway: Callbacks will be informed even if
6129	* #isReallyModified() returns false. This is necessary for cases when we
6130	* change machine data diectly, not through the backup()/commit() mechanism.
6131	*
6132	* @note Must be called from under mParent write lock (sometimes needed by
6133	* #prepareSaveSettings()) and this object's write lock. Locks children for
6134	* writing. There is one exception when mParent is unused and therefore may be
6135	* left unlocked: if this machine is an unregistered one.
6136	*/
6137	HRESULT Machine::saveSettings (int aFlags /= 0/)
6138	{
6139	LogFlowThisFuncEnter();
6140
6141	/* Note: tecnhically, mParent needs to be locked only when the machine is
6142	* registered (see prepareSaveSettings() for details) but we don't
6143	* currently differentiate it in callers of saveSettings() so we don't
6144	* make difference here too. */
6145	AssertReturn (mParent->isWriteLockOnCurrentThread(), E_FAIL);
6146	AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
6147
6148	/* make sure child objects are unable to modify the settings while we are
6149	* saving them */
6150	ensureNoStateDependencies();
6151
6152	AssertReturn (mType == IsMachine \|\| mType == IsSessionMachine, E_FAIL);
6153
6154	BOOL currentStateModified = mData->mCurrentStateModified;
6155	bool settingsModified;
6156
6157	if (!(aFlags & SaveS_ResetCurStateModified) && !currentStateModified)
6158	{
6159	/* We ignore changes to user data when setting mCurrentStateModified
6160	* because the current state will not differ from the current snapshot
6161	* if only user data has been changed (user data is shared by all
6162	* snapshots). */
6163	currentStateModified = isReallyModified (true /* aIgnoreUserData */);
6164	settingsModified = mUserData.hasActualChanges() \|\| currentStateModified;
6165	}
6166	else
6167	{
6168	if (aFlags & SaveS_ResetCurStateModified)
6169	currentStateModified = FALSE;
6170	settingsModified = isReallyModified();
6171	}
6172
6173	HRESULT rc = S_OK;
6174
6175	/* First, prepare to save settings. It will care about renaming the
6176	* settings directory and file if the machine name was changed and about
6177	* creating a new settings file if this is a new machine. */
6178	bool isRenamed = false;
6179	bool isNew = false;
6180	rc = prepareSaveSettings (isRenamed, isNew);
6181	CheckComRCReturnRC (rc);
6182
6183	try
6184	{
6185	using namespace settings;
6186	using namespace xml;
6187
6188	/* this object is locked for writing to prevent concurrent reads and writes */
6189	File file (mData->mHandleCfgFile, Utf8Str (mData->mConfigFileFull));
6190	XmlTreeBackend tree;
6191
6192	/* The newly created settings file is incomplete therefore we turn off
6193	* validation. The rest is like in loadSettingsTree_ForUpdate().*/
6194	rc = VirtualBox::loadSettingsTree (tree, file,
6195	!isNew /* aValidate */,
6196	false /* aCatchLoadErrors */,
6197	false /* aAddDefaults */);
6198	CheckComRCThrowRC (rc);
6199
6200	Key machineNode = tree.rootKey().createKey ("Machine");
6201
6202	/* uuid (required) */
6203	Assert (!mData->mUuid.isEmpty());
6204	machineNode.setValue <Guid> ("uuid", mData->mUuid);
6205
6206	/* name (required) */
6207	Assert (!mUserData->mName.isEmpty());
6208	machineNode.setValue <Bstr> ("name", mUserData->mName);
6209
6210	/* nameSync (optional, default is true) */
6211	machineNode.setValueOr <bool> ("nameSync", !!mUserData->mNameSync, true);
6212
6213	/* Description node (optional) */
6214	if (!mUserData->mDescription.isNull())
6215	{
6216	Key descNode = machineNode.createKey ("Description");
6217	descNode.setKeyValue <Bstr> (mUserData->mDescription);
6218	}
6219	else
6220	{
6221	Key descNode = machineNode.findKey ("Description");
6222	if (!descNode.isNull())
6223	descNode.zap();
6224	}
6225
6226	/* OSType (required) */
6227	machineNode.setValue <Bstr> ("OSType", mUserData->mOSTypeId);
6228
6229	/* stateFile (optional) */
6230	/// @todo The reason for MachineState_Restoring below:
6231	/// PushGuestProperties() is always called from Console::powerDown()
6232	/// (including the case when restoring from the saved state fails) and
6233	/// calls SaveSettings() to save guest properties. Since the saved state
6234	/// file is still present there (and should be kept), we must save it
6235	/// while in Restoring state too. However, calling SaveSettings() from
6236	/// PushGuestProperties() is wrong in the first place. A proper way is
6237	/// to only save guest properties node and not involve the whole save
6238	/// process.
6239	if (mData->mMachineState == MachineState_Saved \|\|
6240	mData->mMachineState == MachineState_Restoring)
6241	{
6242	Assert (!mSSData->mStateFilePath.isEmpty());
6243	/* try to make the file name relative to the settings file dir */
6244	Utf8Str stateFilePath = mSSData->mStateFilePath;
6245	calculateRelativePath (stateFilePath, stateFilePath);
6246	machineNode.setStringValue ("stateFile", stateFilePath);
6247	}
6248	else
6249	{
6250	Assert (mSSData->mStateFilePath.isNull());
6251	machineNode.zapValue ("stateFile");
6252	}
6253
6254	/* currentSnapshot ID (optional) */
6255	if (!mData->mCurrentSnapshot.isNull())
6256	{
6257	Assert (!mData->mFirstSnapshot.isNull());
6258	machineNode.setValue <Guid> ("currentSnapshot",
6259	mData->mCurrentSnapshot->data().mId);
6260	}
6261	else
6262	{
6263	Assert (mData->mFirstSnapshot.isNull());
6264	machineNode.zapValue ("currentSnapshot");
6265	}
6266
6267	/* snapshotFolder (optional) */
6268	/// @todo use the Bstr::NullOrEmpty constant and setValueOr
6269	if (!mUserData->mSnapshotFolder.isEmpty())
6270	machineNode.setValue <Bstr> ("snapshotFolder", mUserData->mSnapshotFolder);
6271	else
6272	machineNode.zapValue ("snapshotFolder");
6273
6274	/* currentStateModified (optional, default is true) */
6275	machineNode.setValueOr <bool> ("currentStateModified",
6276	!!currentStateModified, true);
6277
6278	/* lastStateChange */
6279	machineNode.setValue <RTTIMESPEC> ("lastStateChange",
6280	mData->mLastStateChange);
6281
6282	/* set the aborted attribute when appropriate, defaults to false */
6283	machineNode.setValueOr <bool> ("aborted",
6284	mData->mMachineState == MachineState_Aborted,
6285	false);
6286
6287	/* Hardware node (required) */
6288	{
6289	/* first, delete the entire node if exists */
6290	Key hwNode = machineNode.findKey ("Hardware");
6291	if (!hwNode.isNull())
6292	hwNode.zap();
6293	/* then recreate it */
6294	hwNode = machineNode.createKey ("Hardware");
6295
6296	rc = saveHardware (hwNode);
6297	CheckComRCThrowRC (rc);
6298	}
6299
6300	/* StorageControllers node (required) */
6301	{
6302	/* first, delete the entire node if exists */
6303	Key storageNode = machineNode.findKey ("StorageControllers");
6304	if (!storageNode.isNull())
6305	storageNode.zap();
6306	/* then recreate it */
6307	storageNode = machineNode.createKey ("StorageControllers");
6308
6309	rc = saveStorageControllers (storageNode);
6310	CheckComRCThrowRC (rc);
6311	}
6312
6313	/* ask to save all snapshots when the machine name was changed since
6314	* it may affect saved state file paths for online snapshots (see
6315	* #openConfigLoader() for details) */
6316	if (isRenamed)
6317	{
6318	rc = saveSnapshotSettingsWorker (machineNode, NULL,
6319	SaveSS_UpdateAllOp);
6320	CheckComRCThrowRC (rc);
6321	}
6322
6323	/* save the settings on success */
6324	rc = VirtualBox::saveSettingsTree (tree, file,
6325	mData->mSettingsFileVersion);
6326	CheckComRCThrowRC (rc);
6327	}
6328	catch (HRESULT err)
6329	{
6330	/* we assume that error info is set by the thrower */
6331	rc = err;
6332	}
6333	catch (...)
6334	{
6335	rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
6336	}
6337
6338	if (SUCCEEDED (rc))
6339	{
6340	commit();
6341
6342	/* memorize the new modified state */
6343	mData->mCurrentStateModified = currentStateModified;
6344	}
6345
6346	if (settingsModified \|\| (aFlags & SaveS_InformCallbacksAnyway))
6347	{
6348	/* Fire the data change event, even on failure (since we've already
6349	* committed all data). This is done only for SessionMachines because
6350	* mutable Machine instances are always not registered (i.e. private
6351	* to the client process that creates them) and thus don't need to
6352	* inform callbacks. */
6353	if (mType == IsSessionMachine)
6354	mParent->onMachineDataChange (mData->mUuid);
6355	}
6356
6357	LogFlowThisFunc (("rc=%08X\n", rc));
6358	LogFlowThisFuncLeave();
6359	return rc;
6360	}
6361
6362	/**
6363	* Wrapper for #saveSnapshotSettingsWorker() that opens the settings file
6364	* and locates the <Machine> node in there. See #saveSnapshotSettingsWorker()
6365	* for more details.
6366	*
6367	* @param aSnapshot Snapshot to operate on
6368	* @param aOpFlags Operation to perform, one of SaveSS_NoOp, SaveSS_AddOp
6369	* or SaveSS_UpdateAttrsOp possibly combined with
6370	* SaveSS_UpdateCurrentId.
6371	*
6372	* @note Locks this object for writing + other child objects.
6373	*/
6374	HRESULT Machine::saveSnapshotSettings (Snapshot *aSnapshot, int aOpFlags)
6375	{
6376	AutoCaller autoCaller (this);
6377	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
6378
6379	AssertReturn (mType == IsMachine \|\| mType == IsSessionMachine, E_FAIL);
6380
6381	/* This object's write lock is also necessary to serialize file access
6382	* (prevent concurrent reads and writes) */
6383	AutoWriteLock alock (this);
6384
6385	AssertReturn (isConfigLocked(), E_FAIL);
6386
6387	HRESULT rc = S_OK;
6388
6389	try
6390	{
6391	using namespace settings;
6392	using namespace xml;
6393
6394	/* load the settings file */
6395	File file (mData->mHandleCfgFile, Utf8Str (mData->mConfigFileFull));
6396	XmlTreeBackend tree;
6397
6398	rc = VirtualBox::loadSettingsTree_ForUpdate (tree, file);
6399	CheckComRCReturnRC (rc);
6400
6401	Key machineNode = tree.rootKey().key ("Machine");
6402
6403	rc = saveSnapshotSettingsWorker (machineNode, aSnapshot, aOpFlags);
6404	CheckComRCReturnRC (rc);
6405
6406	/* save settings on success */
6407	rc = VirtualBox::saveSettingsTree (tree, file,
6408	mData->mSettingsFileVersion);
6409	CheckComRCReturnRC (rc);
6410	}
6411	catch (...)
6412	{
6413	rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
6414	}
6415
6416	return rc;
6417	}
6418
6419	/**
6420	* Performs the specified operation on the given snapshot
6421	* in the settings file represented by \a aMachineNode.
6422	*
6423	* If \a aOpFlags = SaveSS_UpdateAllOp, \a aSnapshot can be NULL to indicate
6424	* that the whole tree of the snapshots should be updated in <Machine>.
6425	* One particular case is when the last (and the only) snapshot should be
6426	* removed (it is so when both mCurrentSnapshot and mFirstSnapshot are NULL).
6427	*
6428	* \a aOp may be just SaveSS_UpdateCurrentId if only the currentSnapshot
6429	* attribute of <Machine> needs to be updated.
6430	*
6431	* @param aMachineNode <Machine> node in the opened settings file.
6432	* @param aSnapshot Snapshot to operate on.
6433	* @param aOpFlags Operation to perform, one of SaveSS_NoOp, SaveSS_AddOp
6434	* or SaveSS_UpdateAttrsOp possibly combined with
6435	* SaveSS_UpdateCurrentId.
6436	*
6437	* @note Must be called with this object locked for writing.
6438	* Locks child objects.
6439	*/
6440	HRESULT Machine::saveSnapshotSettingsWorker (settings::Key &aMachineNode,
6441	Snapshot *aSnapshot, int aOpFlags)
6442	{
6443	using namespace settings;
6444
6445	AssertReturn (!aMachineNode.isNull(), E_FAIL);
6446
6447	AssertReturn (isWriteLockOnCurrentThread(), E_FAIL);
6448
6449	int op = aOpFlags & SaveSS_OpMask;
6450	AssertReturn (
6451	(aSnapshot && (op == SaveSS_AddOp \|\| op == SaveSS_UpdateAttrsOp \|\|
6452	op == SaveSS_UpdateAllOp)) \|\|
6453	(!aSnapshot && ((op == SaveSS_NoOp && (aOpFlags & SaveSS_CurrentId)) \|\|
6454	op == SaveSS_UpdateAllOp)),
6455	E_FAIL);
6456
6457	HRESULT rc = S_OK;
6458
6459	bool recreateWholeTree = false;
6460
6461	do
6462	{
6463	if (op == SaveSS_NoOp)
6464	break;
6465
6466	/* quick path: recreate the whole tree of the snapshots */
6467	if (op == SaveSS_UpdateAllOp && aSnapshot == NULL)
6468	{
6469	/* first, delete the entire root snapshot node if it exists */
6470	Key snapshotNode = aMachineNode.findKey ("Snapshot");
6471	if (!snapshotNode.isNull())
6472	snapshotNode.zap();
6473
6474	/* second, if we have any snapshots left, substitute aSnapshot
6475	* with the first snapshot to recreate the whole tree, otherwise
6476	* break */
6477	if (mData->mFirstSnapshot)
6478	{
6479	aSnapshot = mData->mFirstSnapshot;
6480	recreateWholeTree = true;
6481	}
6482	else
6483	break;
6484	}
6485
6486	Assert (!!aSnapshot);
6487	ComObjPtr <Snapshot> parent = aSnapshot->parent();
6488
6489	if (op == SaveSS_AddOp)
6490	{
6491	Key parentNode;
6492
6493	if (parent)
6494	{
6495	rc = findSnapshotNode (parent, aMachineNode, NULL, &parentNode);
6496	CheckComRCBreakRC (rc);
6497
6498	ComAssertBreak (!parentNode.isNull(), rc = E_FAIL);
6499	}
6500
6501	do
6502	{
6503	Key snapshotsNode;
6504
6505	if (!parentNode.isNull())
6506	snapshotsNode = parentNode.createKey ("Snapshots");
6507	else
6508	snapshotsNode = aMachineNode;
6509	do
6510	{
6511	Key snapshotNode = snapshotsNode.appendKey ("Snapshot");
6512	rc = saveSnapshot (snapshotNode, aSnapshot, false /* aAttrsOnly */);
6513	CheckComRCBreakRC (rc);
6514
6515	/* when a new snapshot is added, this means diffs were created
6516	* for every normal/immutable hard disk of the VM, so we need to
6517	* save the current hard disk attachments */
6518
6519	Key storageNode = aMachineNode.findKey ("StorageControllers");
6520	if (!storageNode.isNull())
6521	storageNode.zap();
6522	storageNode = aMachineNode.createKey ("StorageControllers");
6523
6524	rc = saveStorageControllers (storageNode);
6525	CheckComRCBreakRC (rc);
6526
6527	if (mHDData->mAttachments.size() != 0)
6528	{
6529	/* If we have one or more attachments then we definitely
6530	* created diffs for them and associated new diffs with
6531	* current settngs. So, since we don't use saveSettings(),
6532	* we need to inform callbacks manually. */
6533	if (mType == IsSessionMachine)
6534	mParent->onMachineDataChange (mData->mUuid);
6535	}
6536	}
6537	while (0);
6538	}
6539	while (0);
6540
6541	break;
6542	}
6543
6544	Assert ((op == SaveSS_UpdateAttrsOp && !recreateWholeTree) \|\|
6545	op == SaveSS_UpdateAllOp);
6546
6547	Key snapshotsNode;
6548	Key snapshotNode;
6549
6550	if (!recreateWholeTree)
6551	{
6552	rc = findSnapshotNode (aSnapshot, aMachineNode,
6553	&snapshotsNode, &snapshotNode);
6554	CheckComRCBreakRC (rc);
6555	}
6556
6557	if (snapshotsNode.isNull())
6558	snapshotsNode = aMachineNode;
6559
6560	if (op == SaveSS_UpdateAttrsOp)
6561	rc = saveSnapshot (snapshotNode, aSnapshot, true /* aAttrsOnly */);
6562	else
6563	{
6564	if (!snapshotNode.isNull())
6565	snapshotNode.zap();
6566
6567	snapshotNode = snapshotsNode.appendKey ("Snapshot");
6568	rc = saveSnapshot (snapshotNode, aSnapshot, false /* aAttrsOnly */);
6569	CheckComRCBreakRC (rc);
6570	}
6571	}
6572	while (0);
6573
6574	if (SUCCEEDED (rc))
6575	{
6576	/* update currentSnapshot when appropriate */
6577	if (aOpFlags & SaveSS_CurrentId)
6578	{
6579	if (!mData->mCurrentSnapshot.isNull())
6580	aMachineNode.setValue <Guid> ("currentSnapshot",
6581	mData->mCurrentSnapshot->data().mId);
6582	else
6583	aMachineNode.zapValue ("currentSnapshot");
6584	}
6585	if (aOpFlags & SaveSS_CurStateModified)
6586	{
6587	/* defaults to true */
6588	aMachineNode.setValueOr <bool> ("currentStateModified",
6589	!!mData->mCurrentStateModified, true);
6590	}
6591	}
6592
6593	return rc;
6594	}
6595
6596	/**
6597	* Saves the given snapshot and all its children (unless \a aAttrsOnly is true).
6598	* It is assumed that the given node is empty (unless \a aAttrsOnly is true).
6599	*
6600	* @param aNode <Snapshot> node to save the snapshot to.
6601	* @param aSnapshot Snapshot to save.
6602	* @param aAttrsOnly If true, only updatge user-changeable attrs.
6603	*/
6604	HRESULT Machine::saveSnapshot (settings::Key &aNode, Snapshot *aSnapshot, bool aAttrsOnly)
6605	{
6606	using namespace settings;
6607
6608	AssertReturn (!aNode.isNull() && aSnapshot, E_INVALIDARG);
6609	AssertReturn (mType == IsMachine \|\| mType == IsSessionMachine, E_FAIL);
6610
6611	/* uuid (required) */
6612	if (!aAttrsOnly)
6613	aNode.setValue <Guid> ("uuid", aSnapshot->data().mId);
6614
6615	/* name (required) */
6616	aNode.setValue <Bstr> ("name", aSnapshot->data().mName);
6617
6618	/* timeStamp (required) */
6619	aNode.setValue <RTTIMESPEC> ("timeStamp", aSnapshot->data().mTimeStamp);
6620
6621	/* Description node (optional) */
6622	if (!aSnapshot->data().mDescription.isNull())
6623	{
6624	Key descNode = aNode.createKey ("Description");
6625	descNode.setKeyValue <Bstr> (aSnapshot->data().mDescription);
6626	}
6627	else
6628	{
6629	Key descNode = aNode.findKey ("Description");
6630	if (!descNode.isNull())
6631	descNode.zap();
6632	}
6633
6634	if (aAttrsOnly)
6635	return S_OK;
6636
6637	/* stateFile (optional) */
6638	if (aSnapshot->stateFilePath())
6639	{
6640	/* try to make the file name relative to the settings file dir */
6641	Utf8Str stateFilePath = aSnapshot->stateFilePath();
6642	calculateRelativePath (stateFilePath, stateFilePath);
6643	aNode.setStringValue ("stateFile", stateFilePath);
6644	}
6645
6646	{
6647	ComObjPtr <SnapshotMachine> snapshotMachine = aSnapshot->data().mMachine;
6648	ComAssertRet (!snapshotMachine.isNull(), E_FAIL);
6649
6650	/* save hardware */
6651	{
6652	Key hwNode = aNode.createKey ("Hardware");
6653	HRESULT rc = snapshotMachine->saveHardware (hwNode);
6654	CheckComRCReturnRC (rc);
6655	}
6656
6657	/* save hard disks. */
6658	{
6659	Key storageNode = aNode.createKey ("StorageControllers");
6660	HRESULT rc = snapshotMachine->saveStorageControllers (storageNode);
6661	CheckComRCReturnRC (rc);
6662	}
6663	}
6664
6665	/* save children */
6666	{
6667	AutoWriteLock listLock (aSnapshot->childrenLock ());
6668
6669	if (aSnapshot->children().size())
6670	{
6671	Key snapshotsNode = aNode.createKey ("Snapshots");
6672
6673	HRESULT rc = S_OK;
6674
6675	for (Snapshot::SnapshotList::const_iterator it = aSnapshot->children().begin();
6676	it != aSnapshot->children().end();
6677	++ it)
6678	{
6679	Key snapshotNode = snapshotsNode.createKey ("Snapshot");
6680	rc = saveSnapshot (snapshotNode, (*it), aAttrsOnly);
6681	CheckComRCReturnRC (rc);
6682	}
6683	}
6684	}
6685
6686	return S_OK;
6687	}
6688
6689	/**
6690	* Saves the VM hardware configuration. It is assumed that the
6691	* given node is empty.
6692	*
6693	* @param aNode <Hardware> node to save the VM hardware confguration to.
6694	*/
6695	HRESULT Machine::saveHardware (settings::Key &aNode)
6696	{
6697	using namespace settings;
6698
6699	AssertReturn (!aNode.isNull(), E_INVALIDARG);
6700
6701	HRESULT rc = S_OK;
6702
6703	/* The hardware version attribute (optional).
6704	Automatically upgrade from 1 to 2 when there is no saved state. (ugly!) */
6705	{
6706	Utf8Str hwVersion = mHWData->mHWVersion;
6707	if ( hwVersion.compare ("1") == 0
6708	&& mSSData->mStateFilePath.isEmpty())
6709	mHWData->mHWVersion = hwVersion = "2"; /** @todo Is this safe, to update mHWVersion here? If not some other point needs to be found where this can be done. */
6710	if (hwVersion.compare ("2") == 0) /** @todo get the default from the schema if possible. */
6711	aNode.zapValue ("version");
6712	else
6713	aNode.setStringValue ("version", hwVersion.raw());
6714	}
6715
6716	/* CPU (optional, but always created atm) */
6717	{
6718	Key cpuNode = aNode.createKey ("CPU");
6719	Key hwVirtExNode = cpuNode.createKey ("HardwareVirtEx");
6720	const char *value = NULL;
6721	switch (mHWData->mHWVirtExEnabled)
6722	{
6723	case TSBool_False:
6724	value = "false";
6725	break;
6726	case TSBool_True:
6727	value = "true";
6728	break;
6729	case TSBool_Default:
6730	value = "default";
6731	break;
6732	}
6733	hwVirtExNode.setStringValue ("enabled", value);
6734
6735	/* Nested paging (optional, default is false) */
6736	if (mHWData->mHWVirtExNestedPagingEnabled)
6737	{
6738	Key HWVirtExNestedPagingNode = cpuNode.createKey ("HardwareVirtExNestedPaging");
6739	HWVirtExNestedPagingNode.setValue <bool> ("enabled", true);
6740	}
6741
6742	/* VPID (optional, default is false) */
6743	if (mHWData->mHWVirtExVPIDEnabled)
6744	{
6745	Key HWVirtExVPIDNode = cpuNode.createKey ("HardwareVirtExVPID");
6746	HWVirtExVPIDNode.setValue <bool> ("enabled", true);
6747	}
6748
6749	/* PAE (optional, default is false) */
6750	if (mHWData->mPAEEnabled)
6751	{
6752	Key PAENode = cpuNode.createKey ("PAE");
6753	PAENode.setValue <bool> ("enabled", true);
6754	}
6755
6756	/* CPU count */
6757	cpuNode.setValue <ULONG> ("count", mHWData->mCPUCount);
6758	}
6759
6760	/* memory (required) */
6761	{
6762	Key memoryNode = aNode.createKey ("Memory");
6763	memoryNode.setValue <ULONG> ("RAMSize", mHWData->mMemorySize);
6764	}
6765
6766	/* boot (required) */
6767	{
6768	Key bootNode = aNode.createKey ("Boot");
6769
6770	for (ULONG pos = 0; pos < RT_ELEMENTS (mHWData->mBootOrder); ++ pos)
6771	{
6772	const char *device = NULL;
6773	switch (mHWData->mBootOrder [pos])
6774	{
6775	case DeviceType_Null:
6776	/* skip, this is allowed for <Order> nodes
6777	* when loading, the default value NoDevice will remain */
6778	continue;
6779	case DeviceType_Floppy: device = "Floppy"; break;
6780	case DeviceType_DVD: device = "DVD"; break;
6781	case DeviceType_HardDisk: device = "HardDisk"; break;
6782	case DeviceType_Network: device = "Network"; break;
6783	default:
6784	{
6785	ComAssertMsgFailedRet (("Invalid boot device: %d",
6786	mHWData->mBootOrder [pos]),
6787	E_FAIL);
6788	}
6789	}
6790
6791	Key orderNode = bootNode.appendKey ("Order");
6792	orderNode.setValue <ULONG> ("position", pos + 1);
6793	orderNode.setStringValue ("device", device);
6794	}
6795	}
6796
6797	/* display (required) */
6798	{
6799	Key displayNode = aNode.createKey ("Display");
6800	displayNode.setValue <ULONG> ("VRAMSize", mHWData->mVRAMSize);
6801	displayNode.setValue <ULONG> ("monitorCount", mHWData->mMonitorCount);
6802	displayNode.setValue <bool> ("accelerate3D", !!mHWData->mAccelerate3DEnabled);
6803	}
6804
6805	#ifdef VBOX_WITH_VRDP
6806	/* VRDP settings (optional) */
6807	rc = mVRDPServer->saveSettings (aNode);
6808	CheckComRCReturnRC (rc);
6809	#endif
6810
6811	/* BIOS (required) */
6812	rc = mBIOSSettings->saveSettings (aNode);
6813	CheckComRCReturnRC (rc);
6814
6815	/* DVD drive (required) */
6816	rc = mDVDDrive->saveSettings (aNode);
6817	CheckComRCReturnRC (rc);
6818
6819	/* Flooppy drive (required) */
6820	rc = mFloppyDrive->saveSettings (aNode);
6821	CheckComRCReturnRC (rc);
6822
6823	/* USB Controller (required) */
6824	rc = mUSBController->saveSettings (aNode);
6825	CheckComRCReturnRC (rc);
6826
6827	/* Network adapters (required) */
6828	{
6829	Key nwNode = aNode.createKey ("Network");
6830
6831	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); ++ slot)
6832	{
6833	Key adapterNode = nwNode.appendKey ("Adapter");
6834
6835	adapterNode.setValue <ULONG> ("slot", slot);
6836
6837	rc = mNetworkAdapters [slot]->saveSettings (adapterNode);
6838	CheckComRCReturnRC (rc);
6839	}
6840	}
6841
6842	/* Serial ports */
6843	{
6844	Key serialNode = aNode.createKey ("UART");
6845
6846	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); ++ slot)
6847	{
6848	Key portNode = serialNode.appendKey ("Port");
6849
6850	portNode.setValue <ULONG> ("slot", slot);
6851
6852	rc = mSerialPorts [slot]->saveSettings (portNode);
6853	CheckComRCReturnRC (rc);
6854	}
6855	}
6856
6857	/* Parallel ports */
6858	{
6859	Key parallelNode = aNode.createKey ("LPT");
6860
6861	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); ++ slot)
6862	{
6863	Key portNode = parallelNode.appendKey ("Port");
6864
6865	portNode.setValue <ULONG> ("slot", slot);
6866
6867	rc = mParallelPorts [slot]->saveSettings (portNode);
6868	CheckComRCReturnRC (rc);
6869	}
6870	}
6871
6872	/* Audio adapter */
6873	rc = mAudioAdapter->saveSettings (aNode);
6874	CheckComRCReturnRC (rc);
6875
6876	/* Shared folders */
6877	{
6878	Key sharedFoldersNode = aNode.createKey ("SharedFolders");
6879
6880	for (HWData::SharedFolderList::const_iterator it = mHWData->mSharedFolders.begin();
6881	it != mHWData->mSharedFolders.end();
6882	++ it)
6883	{
6884	ComObjPtr <SharedFolder> folder = *it;
6885
6886	Key folderNode = sharedFoldersNode.appendKey ("SharedFolder");
6887
6888	/* all are mandatory */
6889	folderNode.setValue <Bstr> ("name", folder->name());
6890	folderNode.setValue <Bstr> ("hostPath", folder->hostPath());
6891	folderNode.setValue <bool> ("writable", !!folder->writable());
6892	}
6893	}
6894
6895	/* Clipboard */
6896	{
6897	Key clipNode = aNode.createKey ("Clipboard");
6898
6899	const char *modeStr = "Disabled";
6900	switch (mHWData->mClipboardMode)
6901	{
6902	case ClipboardMode_Disabled:
6903	/* already assigned */
6904	break;
6905	case ClipboardMode_HostToGuest:
6906	modeStr = "HostToGuest";
6907	break;
6908	case ClipboardMode_GuestToHost:
6909	modeStr = "GuestToHost";
6910	break;
6911	case ClipboardMode_Bidirectional:
6912	modeStr = "Bidirectional";
6913	break;
6914	default:
6915	ComAssertMsgFailedRet (("Clipboard mode %d is invalid",
6916	mHWData->mClipboardMode),
6917	E_FAIL);
6918	}
6919	clipNode.setStringValue ("mode", modeStr);
6920	}
6921
6922	/* Guest */
6923	{
6924	Key guestNode = aNode.createKey ("Guest");
6925
6926	guestNode.setValue <ULONG> ("memoryBalloonSize",
6927	mHWData->mMemoryBalloonSize);
6928	guestNode.setValue <ULONG> ("statisticsUpdateInterval",
6929	mHWData->mStatisticsUpdateInterval);
6930	}
6931
6932	#ifdef VBOX_WITH_GUEST_PROPS
6933	/* Guest properties */
6934	try
6935	{
6936	using namespace guestProp;
6937
6938	Key guestPropertiesNode = aNode.createKey ("GuestProperties");
6939
6940	for (HWData::GuestPropertyList::const_iterator it = mHWData->mGuestProperties.begin();
6941	it != mHWData->mGuestProperties.end(); ++it)
6942	{
6943	HWData::GuestProperty property = *it;
6944
6945	Key propertyNode = guestPropertiesNode.appendKey ("GuestProperty");
6946	char szFlags[MAX_FLAGS_LEN + 1];
6947
6948	propertyNode.setValue <Bstr> ("name", property.mName);
6949	propertyNode.setValue <Bstr> ("value", property.mValue);
6950	propertyNode.setValue <ULONG64> ("timestamp", property.mTimestamp);
6951	writeFlags (property.mFlags, szFlags);
6952	Bstr flags (szFlags);
6953	if (flags.isNull())
6954	return E_OUTOFMEMORY;
6955	propertyNode.setValue <Bstr> ("flags", flags);
6956	}
6957	Bstr emptyStr ("");
6958	if (emptyStr.isNull())
6959	return E_OUTOFMEMORY;
6960	guestPropertiesNode.setValueOr <Bstr> ("notificationPatterns",
6961	mHWData->mGuestPropertyNotificationPatterns,
6962	emptyStr);
6963	}
6964	catch (xml::ENoMemory e)
6965	{
6966	return E_OUTOFMEMORY;
6967	}
6968	#endif /* VBOX_WITH_GUEST_PROPS defined */
6969
6970	AssertComRC (rc);
6971	return rc;
6972	}
6973
6974	/**
6975	* Saves the storage controller configuration.
6976	*
6977	* @param aNode <StorageControllers> node to save the VM hardware confguration to.
6978	*/
6979	HRESULT Machine::saveStorageControllers (settings::Key &aNode)
6980	{
6981	using namespace settings;
6982
6983	AssertReturn (!aNode.isNull(), E_INVALIDARG);
6984
6985	for (StorageControllerList::const_iterator
6986	it = mStorageControllers->begin();
6987	it != mStorageControllers->end();
6988	++ it)
6989	{
6990	HRESULT rc;
6991	const char *type = NULL;
6992	ComObjPtr <StorageController> ctl = *it;
6993
6994	Key ctlNode = aNode.appendKey ("StorageController");
6995
6996	ctlNode.setValue <Bstr> ("name", ctl->name());
6997
6998	switch (ctl->controllerType())
6999	{
7000	case StorageControllerType_IntelAhci: type = "AHCI"; break;
7001	case StorageControllerType_LsiLogic: type = "LsiLogic"; break;
7002	case StorageControllerType_BusLogic: type = "BusLogic"; break;
7003	case StorageControllerType_PIIX3: type = "PIIX3"; break;
7004	case StorageControllerType_PIIX4: type = "PIIX4"; break;
7005	case StorageControllerType_ICH6: type = "ICH6"; break;
7006	default:
7007	ComAssertFailedRet (E_FAIL);
7008	}
7009
7010	ctlNode.setStringValue ("type", type);
7011
7012	/* Save the port count. */
7013	ULONG portCount;
7014	rc = ctl->COMGETTER(PortCount)(&portCount);
7015	ComAssertRCRet(rc, rc);
7016	ctlNode.setValue <ULONG> ("PortCount", portCount);
7017
7018	/* Save IDE emulation settings. */
7019	if (ctl->controllerType() == StorageControllerType_IntelAhci)
7020	{
7021	LONG uVal;
7022
7023	rc = ctl->GetIDEEmulationPort(0, &uVal);
7024	ComAssertRCRet(rc, rc);
7025	ctlNode.setValue <LONG> ("IDE0MasterEmulationPort", uVal);
7026
7027	rc = ctl->GetIDEEmulationPort(1, &uVal);
7028	ComAssertRCRet(rc, rc);
7029	ctlNode.setValue <LONG> ("IDE0SlaveEmulationPort", uVal);
7030
7031	rc = ctl->GetIDEEmulationPort(2, &uVal);
7032	ComAssertRCRet(rc, rc);
7033	ctlNode.setValue <LONG> ("IDE1MasterEmulationPort", uVal);
7034
7035	rc = ctl->GetIDEEmulationPort(3, &uVal);
7036	ComAssertRCRet(rc, rc);
7037	ctlNode.setValue <LONG> ("IDE1SlaveEmulationPort", uVal);
7038	}
7039
7040	/* save the devices now. */
7041	rc = saveStorageDevices(ctl, ctlNode);
7042	ComAssertRCRet(rc, rc);
7043	}
7044
7045	return S_OK;
7046	}
7047
7048	/**
7049	* Saves the hard disk confguration.
7050	* It is assumed that the given node is empty.
7051	*
7052	* @param aNode <HardDiskAttachments> node to save the hard disk confguration to.
7053	*/
7054	HRESULT Machine::saveStorageDevices (ComObjPtr<StorageController> aStorageController,
7055	settings::Key &aNode)
7056	{
7057	using namespace settings;
7058
7059	AssertReturn (!aNode.isNull(), E_INVALIDARG);
7060
7061	HDData::AttachmentList atts;
7062
7063	HRESULT rc = getHardDiskAttachmentsOfController(aStorageController->name(), atts);
7064	CheckComRCReturnRC(rc);
7065
7066	for (HDData::AttachmentList::const_iterator
7067	it = atts.begin();
7068	it != atts.end();
7069	++ it)
7070	{
7071	Key hdNode = aNode.appendKey ("AttachedDevice");
7072
7073	{
7074	/* device type. Only hard disk allowed atm. */
7075	hdNode.setStringValue ("type", "HardDisk");
7076	/* channel (required) */
7077	hdNode.setValue <LONG> ("port", (*it)->port());
7078	/* device (required) */
7079	hdNode.setValue <LONG> ("device", (*it)->device());
7080	/* ID of the image. */
7081	Key idNode = hdNode.appendKey ("Image");
7082	idNode.setValue <Guid> ("uuid", (*it)->hardDisk()->id());
7083	}
7084	}
7085
7086	return S_OK;
7087	}
7088
7089	/**
7090	* Saves machine state settings as defined by aFlags
7091	* (SaveSTS_* values).
7092	*
7093	* @param aFlags Combination of SaveSTS_* flags.
7094	*
7095	* @note Locks objects for writing.
7096	*/
7097	HRESULT Machine::saveStateSettings (int aFlags)
7098	{
7099	if (aFlags == 0)
7100	return S_OK;
7101
7102	AutoCaller autoCaller (this);
7103	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
7104
7105	/* This object's write lock is also necessary to serialize file access
7106	* (prevent concurrent reads and writes) */
7107	AutoWriteLock alock (this);
7108
7109	AssertReturn (isConfigLocked(), E_FAIL);
7110
7111	HRESULT rc = S_OK;
7112
7113	try
7114	{
7115	using namespace settings;
7116	using namespace xml;
7117
7118	/* load the settings file */
7119	File file (mData->mHandleCfgFile, Utf8Str (mData->mConfigFileFull));
7120	XmlTreeBackend tree;
7121
7122	rc = VirtualBox::loadSettingsTree_ForUpdate (tree, file);
7123	CheckComRCReturnRC (rc);
7124
7125	Key machineNode = tree.rootKey().key ("Machine");
7126
7127	if (aFlags & SaveSTS_CurStateModified)
7128	{
7129	/* defaults to true */
7130	machineNode.setValueOr <bool> ("currentStateModified",
7131	!!mData->mCurrentStateModified, true);
7132	}
7133
7134	if (aFlags & SaveSTS_StateFilePath)
7135	{
7136	if (mSSData->mStateFilePath)
7137	{
7138	/* try to make the file name relative to the settings file dir */
7139	Utf8Str stateFilePath = mSSData->mStateFilePath;
7140	calculateRelativePath (stateFilePath, stateFilePath);
7141	machineNode.setStringValue ("stateFile", stateFilePath);
7142	}
7143	else
7144	machineNode.zapValue ("stateFile");
7145	}
7146
7147	if (aFlags & SaveSTS_StateTimeStamp)
7148	{
7149	Assert (mData->mMachineState != MachineState_Aborted \|\|
7150	mSSData->mStateFilePath.isNull());
7151
7152	machineNode.setValue <RTTIMESPEC> ("lastStateChange",
7153	mData->mLastStateChange);
7154
7155	/* set the aborted attribute when appropriate, defaults to false */
7156	machineNode.setValueOr <bool> ("aborted",
7157	mData->mMachineState == MachineState_Aborted,
7158	false);
7159	}
7160
7161	/* save settings on success */
7162	rc = VirtualBox::saveSettingsTree (tree, file,
7163	mData->mSettingsFileVersion);
7164	CheckComRCReturnRC (rc);
7165	}
7166	catch (...)
7167	{
7168	rc = VirtualBox::handleUnexpectedExceptions (RT_SRC_POS);
7169	}
7170
7171	return rc;
7172	}
7173
7174	/**
7175	* Creates differencing hard disks for all normal hard disks attached to this
7176	* machine and a new set of attachments to refer to created disks.
7177	*
7178	* Used when taking a snapshot or when discarding the current state.
7179	*
7180	* This method assumes that mHDData contains the original hard disk attachments
7181	* it needs to create diffs for. On success, these attachments will be replaced
7182	* with the created diffs. On failure, #deleteImplicitDiffs() is implicitly
7183	* called to delete created diffs which will also rollback mHDData and restore
7184	* whatever was backed up before calling this method.
7185	*
7186	* Attachments with non-normal hard disks are left as is.
7187	*
7188	* If @a aOnline is @c false then the original hard disks that require implicit
7189	* diffs will be locked for reading. Otherwise it is assumed that they are
7190	* already locked for writing (when the VM was started). Note that in the latter
7191	* case it is responsibility of the caller to lock the newly created diffs for
7192	* writing if this method succeeds.
7193	*
7194	* @param aFolder Folder where to create diff hard disks.
7195	* @param aProgress Progress object to run (must contain at least as
7196	* many operations left as the number of hard disks
7197	* attached).
7198	* @param aOnline Whether the VM was online prior to this operation.
7199	*
7200	* @note The progress object is not marked as completed, neither on success nor
7201	* on failure. This is a responsibility of the caller.
7202	*
7203	* @note Locks this object for writing.
7204	*/
7205	HRESULT Machine::createImplicitDiffs (const Bstr &aFolder,
7206	ComObjPtr <Progress> &aProgress,
7207	bool aOnline)
7208	{
7209	AssertReturn (!aFolder.isEmpty(), E_FAIL);
7210
7211	AutoCaller autoCaller (this);
7212	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
7213
7214	AutoWriteLock alock (this);
7215
7216	/* must be in a protective state because we leave the lock below */
7217	AssertReturn (mData->mMachineState == MachineState_Saving \|\|
7218	mData->mMachineState == MachineState_Discarding, E_FAIL);
7219
7220	HRESULT rc = S_OK;
7221
7222	typedef std::list< ComObjPtr<HardDisk> > LockedMedia;
7223	LockedMedia lockedMedia;
7224
7225	try
7226	{
7227	if (!aOnline)
7228	{
7229	/* lock all attached hard disks early to detect "in use"
7230	* situations before creating actual diffs */
7231	for (HDData::AttachmentList::const_iterator
7232	it = mHDData->mAttachments.begin();
7233	it != mHDData->mAttachments.end();
7234	++ it)
7235	{
7236	ComObjPtr<HardDiskAttachment> hda = *it;
7237	ComObjPtr<HardDisk> hd = hda->hardDisk();
7238
7239	rc = hd->LockRead (NULL);
7240	CheckComRCThrowRC (rc);
7241
7242	lockedMedia.push_back (hd);
7243	}
7244	}
7245
7246	/* remember the current list (note that we don't use backup() since
7247	* mHDData may be already backed up) */
7248	HDData::AttachmentList atts = mHDData->mAttachments;
7249
7250	/* start from scratch */
7251	mHDData->mAttachments.clear();
7252
7253	/* go through remembered attachments and create diffs for normal hard
7254	* disks and attach them */
7255
7256	for (HDData::AttachmentList::const_iterator
7257	it = atts.begin(); it != atts.end(); ++ it)
7258	{
7259	ComObjPtr<HardDiskAttachment> hda = *it;
7260	ComObjPtr<HardDisk> hd = hda->hardDisk();
7261
7262	/* type cannot be changed while attached => no need to lock */
7263	if (hd->type() != HardDiskType_Normal)
7264	{
7265	/* copy the attachment as is */
7266
7267	Assert (hd->type() == HardDiskType_Writethrough);
7268
7269	rc = aProgress->setNextOperation(BstrFmt(tr("Skipping writethrough hard disk '%s'"),
7270	hd->root()->name().raw()),
7271	1); // weight
7272	CheckComRCThrowRC (rc);
7273
7274	mHDData->mAttachments.push_back (hda);
7275	continue;
7276	}
7277
7278	/* need a diff */
7279
7280	rc = aProgress->setNextOperation(BstrFmt(tr("Creating differencing hard disk for '%s'"),
7281	hd->root()->name().raw()),
7282	1); // weight
7283	CheckComRCThrowRC (rc);
7284
7285	ComObjPtr<HardDisk> diff;
7286	diff.createObject();
7287	rc = diff->init (mParent, hd->preferredDiffFormat(),
7288	BstrFmt ("%ls"RTPATH_SLASH_STR,
7289	mUserData->mSnapshotFolderFull.raw()));
7290	CheckComRCThrowRC (rc);
7291
7292	/* leave the lock before the potentially lengthy operation */
7293	alock.leave();
7294
7295	rc = hd->createDiffStorageAndWait (diff, HardDiskVariant_Standard,
7296	&aProgress);
7297
7298	alock.enter();
7299
7300	CheckComRCThrowRC (rc);
7301
7302	rc = diff->attachTo (mData->mUuid);
7303	AssertComRCThrowRC (rc);
7304
7305	/* add a new attachment */
7306	ComObjPtr<HardDiskAttachment> attachment;
7307	attachment.createObject();
7308	rc = attachment->init (diff, hda->controller(), hda->port(),
7309	hda->device(), true /* aImplicit */);
7310	CheckComRCThrowRC (rc);
7311
7312	mHDData->mAttachments.push_back (attachment);
7313	}
7314	}
7315	catch (HRESULT aRC) { rc = aRC; }
7316
7317	/* unlock all hard disks we locked */
7318	if (!aOnline)
7319	{
7320	ErrorInfoKeeper eik;
7321
7322	for (LockedMedia::const_iterator it = lockedMedia.begin();
7323	it != lockedMedia.end(); ++ it)
7324	{
7325	HRESULT rc2 = (*it)->UnlockRead (NULL);
7326	AssertComRC (rc2);
7327	}
7328	}
7329
7330	if (FAILED (rc))
7331	{
7332	MultiResultRef mrc (rc);
7333
7334	mrc = deleteImplicitDiffs();
7335	}
7336
7337	return rc;
7338	}
7339
7340	/**
7341	* Deletes implicit differencing hard disks created either by
7342	* #createImplicitDiffs() or by #AttachHardDisk() and rolls back mHDData.
7343	*
7344	* Note that to delete hard disks created by #AttachHardDisk() this method is
7345	* called from #fixupHardDisks() when the changes are rolled back.
7346	*
7347	* @note Locks this object for writing.
7348	*/
7349	HRESULT Machine::deleteImplicitDiffs()
7350	{
7351	AutoCaller autoCaller (this);
7352	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
7353
7354	AutoWriteLock alock (this);
7355
7356	AssertReturn (mHDData.isBackedUp(), E_FAIL);
7357
7358	HRESULT rc = S_OK;
7359
7360	HDData::AttachmentList implicitAtts;
7361
7362	const HDData::AttachmentList &oldAtts =
7363	mHDData.backedUpData()->mAttachments;
7364
7365	/* enumerate new attachments */
7366	for (HDData::AttachmentList::const_iterator
7367	it = mHDData->mAttachments.begin();
7368	it != mHDData->mAttachments.end(); ++ it)
7369	{
7370	ComObjPtr<HardDisk> hd = (*it)->hardDisk();
7371
7372	if ((*it)->isImplicit())
7373	{
7374	/* deassociate and mark for deletion */
7375	rc = hd->detachFrom (mData->mUuid);
7376	AssertComRC (rc);
7377	implicitAtts.push_back (*it);
7378	continue;
7379	}
7380
7381	/* was this hard disk attached before? */
7382	HDData::AttachmentList::const_iterator oldIt =
7383	std::find_if(oldAtts.begin(), oldAtts.end(),
7384	HardDiskAttachment::RefersTo (hd));
7385	if (oldIt == oldAtts.end())
7386	{
7387	/* no: de-associate */
7388	rc = hd->detachFrom (mData->mUuid);
7389	AssertComRC (rc);
7390	continue;
7391	}
7392	}
7393
7394	/* rollback hard disk changes */
7395	mHDData.rollback();
7396
7397	MultiResult mrc (S_OK);
7398
7399	/* delete unused implicit diffs */
7400	if (implicitAtts.size() != 0)
7401	{
7402	/* will leave the lock before the potentially lengthy
7403	* operation, so protect with the special state (unless already
7404	* protected) */
7405	MachineState_T oldState = mData->mMachineState;
7406	if (oldState != MachineState_Saving &&
7407	oldState != MachineState_Discarding)
7408	{
7409	setMachineState (MachineState_SettingUp);
7410	}
7411
7412	alock.leave();
7413
7414	for (HDData::AttachmentList::const_iterator
7415	it = implicitAtts.begin();
7416	it != implicitAtts.end(); ++ it)
7417	{
7418	ComObjPtr<HardDisk> hd = (*it)->hardDisk();
7419
7420	mrc = hd->deleteStorageAndWait();
7421	}
7422
7423	alock.enter();
7424
7425	if (mData->mMachineState == MachineState_SettingUp)
7426	{
7427	setMachineState (oldState);
7428	}
7429	}
7430
7431	return mrc;
7432	}
7433
7434	/**
7435	* Perform deferred hard disk detachments on success and deletion of implicitly
7436	* created diffs on failure.
7437	*
7438	* Does nothing if the hard disk attachment data (mHDData) is not changed (not
7439	* backed up).
7440	*
7441	* When the data is backed up, this method will commit mHDData if @a aCommit is
7442	* @c true and rollback it otherwise before returning.
7443	*
7444	* If @a aOnline is @c true then this method called with @a aCommit = @c true
7445	* will also unlock the old hard disks for which the new implicit diffs were
7446	* created and will lock these new diffs for writing. When @a aCommit is @c
7447	* false, this argument is ignored.
7448	*
7449	* @param aCommit @c true if called on success.
7450	* @param aOnline Whether the VM was online prior to this operation.
7451	*
7452	* @note Locks this object for writing!
7453	*/
7454	void Machine::fixupHardDisks(bool aCommit, bool aOnline /= false/)
7455	{
7456	AutoCaller autoCaller (this);
7457	AssertComRCReturnVoid (autoCaller.rc());
7458
7459	AutoWriteLock alock (this);
7460
7461	/* no attach/detach operations -- nothing to do */
7462	if (!mHDData.isBackedUp())
7463	return;
7464
7465	HRESULT rc = S_OK;
7466
7467	if (aCommit)
7468	{
7469	HDData::AttachmentList &oldAtts =
7470	mHDData.backedUpData()->mAttachments;
7471
7472	/* enumerate new attachments */
7473	for (HDData::AttachmentList::const_iterator
7474	it = mHDData->mAttachments.begin();
7475	it != mHDData->mAttachments.end(); ++ it)
7476	{
7477	ComObjPtr<HardDisk> hd = (*it)->hardDisk();
7478
7479	if ((*it)->isImplicit())
7480	{
7481	/* convert implicit attachment to normal */
7482	(*it)->setImplicit (false);
7483
7484	if (aOnline)
7485	{
7486	rc = hd->LockWrite (NULL);
7487	AssertComRC (rc);
7488
7489	mData->mSession.mLockedMedia.push_back (
7490	Data::Session::LockedMedia::value_type (
7491	ComPtr <IHardDisk> (hd), true));
7492
7493	/* also, relock the old hard disk which is a base for the
7494	* new diff for reading if the VM is online */
7495
7496	ComObjPtr<HardDisk> parent = hd->parent();
7497	/* make the relock atomic */
7498	AutoWriteLock parentLock (parent);
7499	rc = parent->UnlockWrite (NULL);
7500	AssertComRC (rc);
7501	rc = parent->LockRead (NULL);
7502	AssertComRC (rc);
7503
7504	/* XXX actually we should replace the old entry in that
7505	* vector (write lock => read lock) but this would take
7506	* some effort. So lets just ignore the error code in
7507	* SessionMachine::unlockMedia(). */
7508	mData->mSession.mLockedMedia.push_back (
7509	Data::Session::LockedMedia::value_type (
7510	ComPtr <IHardDisk> (parent), false));
7511	}
7512
7513	continue;
7514	}
7515
7516	/* was this hard disk attached before? */
7517	HDData::AttachmentList::iterator oldIt =
7518	std::find_if (oldAtts.begin(), oldAtts.end(),
7519	HardDiskAttachment::RefersTo (hd));
7520	if (oldIt != oldAtts.end())
7521	{
7522	/* yes: remove from old to avoid de-association */
7523	oldAtts.erase (oldIt);
7524	}
7525	}
7526
7527	/* enumerate remaining old attachments and de-associate from the
7528	* current machine state */
7529	for (HDData::AttachmentList::const_iterator it = oldAtts.begin();
7530	it != oldAtts.end(); ++ it)
7531	{
7532	ComObjPtr<HardDisk> hd = (*it)->hardDisk();
7533
7534	/* now de-associate from the current machine state */
7535	rc = hd->detachFrom (mData->mUuid);
7536	AssertComRC (rc);
7537
7538	if (aOnline)
7539	{
7540	/* unlock since not used anymore */
7541	MediaState_T state;
7542	rc = hd->UnlockWrite (&state);
7543	/* the disk may be alredy relocked for reading above */
7544	Assert (SUCCEEDED (rc) \|\| state == MediaState_LockedRead);
7545	}
7546	}
7547
7548	/* commit the hard disk changes */
7549	mHDData.commit();
7550
7551	if (mType == IsSessionMachine)
7552	{
7553	/* attach new data to the primary machine and reshare it */
7554	mPeer->mHDData.attach (mHDData);
7555	}
7556	}
7557	else
7558	{
7559	deleteImplicitDiffs();
7560	}
7561
7562	return;
7563	}
7564
7565	/**
7566	* Helper to lock the machine configuration for write access.
7567	*
7568	* @return S_OK or E_FAIL and sets error info on failure
7569	*
7570	* @note Doesn't lock anything (must be called from this object's lock)
7571	*/
7572	HRESULT Machine::lockConfig()
7573	{
7574	HRESULT rc = S_OK;
7575
7576	if (!isConfigLocked())
7577	{
7578	/* open the associated config file */
7579	int vrc = RTFileOpen (&mData->mHandleCfgFile,
7580	Utf8Str (mData->mConfigFileFull),
7581	RTFILE_O_READWRITE \| RTFILE_O_OPEN \|
7582	RTFILE_O_DENY_WRITE);
7583	if (RT_FAILURE (vrc) && (vrc != VERR_FILE_NOT_FOUND))
7584	{
7585	/* Open the associated config file only with read access. */
7586	vrc = RTFileOpen (&mData->mHandleCfgFile,
7587	Utf8Str (mData->mConfigFileFull),
7588	RTFILE_O_READ \| RTFILE_O_OPEN \|
7589	RTFILE_O_DENY_NONE);
7590	if (RT_FAILURE (vrc))
7591	{
7592	/* We even cannot open it in read mode, so there's seriously
7593	something wrong. */
7594	rc = setError (E_FAIL,
7595	tr ("Could not even open settings file '%ls' in read mode (%Rrc)"),
7596	mData->mConfigFile.raw(), vrc);
7597	}
7598	else
7599	{
7600	mData->mConfigFileReadonly = TRUE;
7601	}
7602	}
7603	else
7604	{
7605	mData->mConfigFileReadonly = FALSE;
7606	}
7607
7608	if (RT_FAILURE(vrc))
7609	{
7610	mData->mHandleCfgFile = NIL_RTFILE;
7611	mData->mConfigFileReadonly = FALSE;
7612	}
7613	}
7614
7615	LogFlowThisFunc (("mConfigFile={%ls}, mHandleCfgFile=%d, rc=%08X\n",
7616	mData->mConfigFileFull.raw(), mData->mHandleCfgFile, rc));
7617	return rc;
7618	}
7619
7620	/**
7621	* Helper to unlock the machine configuration from write access
7622	*
7623	* @return S_OK
7624	*
7625	* @note Doesn't lock anything.
7626	* @note Not thread safe (must be called from this object's lock).
7627	*/
7628	HRESULT Machine::unlockConfig()
7629	{
7630	HRESULT rc = S_OK;
7631
7632	if (isConfigLocked())
7633	{
7634	RTFileFlush (mData->mHandleCfgFile);
7635	RTFileClose (mData->mHandleCfgFile);
7636	/** @todo flush the directory. */
7637	mData->mHandleCfgFile = NIL_RTFILE;
7638	mData->mConfigFileReadonly = FALSE;
7639	}
7640
7641	LogFlowThisFunc (("\n"));
7642
7643	return rc;
7644	}
7645
7646	/**
7647	* Returns true if the settings file is located in the directory named exactly
7648	* as the machine. This will be true if the machine settings structure was
7649	* created by default in #openConfigLoader().
7650	*
7651	* @param aSettingsDir if not NULL, the full machine settings file directory
7652	* name will be assigned there.
7653	*
7654	* @note Doesn't lock anything.
7655	* @note Not thread safe (must be called from this object's lock).
7656	*/
7657	bool Machine::isInOwnDir (Utf8Str aSettingsDir / = NULL */)
7658	{
7659	Utf8Str settingsDir = mData->mConfigFileFull;
7660	RTPathStripFilename (settingsDir.mutableRaw());
7661	char *dirName = RTPathFilename (settingsDir);
7662
7663	AssertReturn (dirName, false);
7664
7665	/* if we don't rename anything on name change, return false shorlty */
7666	if (!mUserData->mNameSync)
7667	return false;
7668
7669	if (aSettingsDir)
7670	*aSettingsDir = settingsDir;
7671
7672	return Bstr (dirName) == mUserData->mName;
7673	}
7674
7675	/**
7676	* @note Locks objects for reading!
7677	*/
7678	bool Machine::isModified()
7679	{
7680	AutoCaller autoCaller (this);
7681	AssertComRCReturn (autoCaller.rc(), false);
7682
7683	AutoReadLock alock (this);
7684
7685	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
7686	if (mNetworkAdapters [slot] && mNetworkAdapters [slot]->isModified())
7687	return true;
7688
7689	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
7690	if (mSerialPorts [slot] && mSerialPorts [slot]->isModified())
7691	return true;
7692
7693	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
7694	if (mParallelPorts [slot] && mParallelPorts [slot]->isModified())
7695	return true;
7696
7697	if (!mStorageControllers.isNull())
7698	{
7699	for (StorageControllerList::const_iterator it =
7700	mStorageControllers->begin();
7701	it != mStorageControllers->end();
7702	++ it)
7703	{
7704	if ((*it)->isModified())
7705	return true;
7706	}
7707	}
7708
7709	return
7710	mUserData.isBackedUp() \|\|
7711	mHWData.isBackedUp() \|\|
7712	mHDData.isBackedUp() \|\|
7713	mStorageControllers.isBackedUp() \|\|
7714	#ifdef VBOX_WITH_VRDP
7715	(mVRDPServer && mVRDPServer->isModified()) \|\|
7716	#endif
7717	(mDVDDrive && mDVDDrive->isModified()) \|\|
7718	(mFloppyDrive && mFloppyDrive->isModified()) \|\|
7719	(mAudioAdapter && mAudioAdapter->isModified()) \|\|
7720	(mUSBController && mUSBController->isModified()) \|\|
7721	(mBIOSSettings && mBIOSSettings->isModified());
7722	}
7723
7724	/**
7725	* Returns the logical OR of data.hasActualChanges() of this and all child
7726	* objects.
7727	*
7728	* @param aIgnoreUserData @c true to ignore changes to mUserData
7729	*
7730	* @note Locks objects for reading!
7731	*/
7732	bool Machine::isReallyModified (bool aIgnoreUserData /* = false */)
7733	{
7734	AutoCaller autoCaller (this);
7735	AssertComRCReturn (autoCaller.rc(), false);
7736
7737	AutoReadLock alock (this);
7738
7739	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
7740	if (mNetworkAdapters [slot] && mNetworkAdapters [slot]->isReallyModified())
7741	return true;
7742
7743	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
7744	if (mSerialPorts [slot] && mSerialPorts [slot]->isReallyModified())
7745	return true;
7746
7747	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
7748	if (mParallelPorts [slot] && mParallelPorts [slot]->isReallyModified())
7749	return true;
7750
7751	if (!mStorageControllers.isBackedUp())
7752	{
7753	/* see whether any of the devices has changed its data */
7754	for (StorageControllerList::const_iterator
7755	it = mStorageControllers->begin();
7756	it != mStorageControllers->end();
7757	++ it)
7758	{
7759	if ((*it)->isReallyModified())
7760	return true;
7761	}
7762	}
7763	else
7764	{
7765	if (mStorageControllers->size() != mStorageControllers.backedUpData()->size())
7766	return true;
7767	}
7768
7769	return
7770	(!aIgnoreUserData && mUserData.hasActualChanges()) \|\|
7771	mHWData.hasActualChanges() \|\|
7772	mHDData.hasActualChanges() \|\|
7773	mStorageControllers.hasActualChanges() \|\|
7774	#ifdef VBOX_WITH_VRDP
7775	(mVRDPServer && mVRDPServer->isReallyModified()) \|\|
7776	#endif
7777	(mDVDDrive && mDVDDrive->isReallyModified()) \|\|
7778	(mFloppyDrive && mFloppyDrive->isReallyModified()) \|\|
7779	(mAudioAdapter && mAudioAdapter->isReallyModified()) \|\|
7780	(mUSBController && mUSBController->isReallyModified()) \|\|
7781	(mBIOSSettings && mBIOSSettings->isReallyModified());
7782	}
7783
7784	/**
7785	* Discards all changes to machine settings.
7786	*
7787	* @param aNotify Whether to notify the direct session about changes or not.
7788	*
7789	* @note Locks objects for writing!
7790	*/
7791	void Machine::rollback (bool aNotify)
7792	{
7793	AutoCaller autoCaller (this);
7794	AssertComRCReturn (autoCaller.rc(), (void) 0);
7795
7796	AutoWriteLock alock (this);
7797
7798	/* check for changes in own data */
7799
7800	bool sharedFoldersChanged = false, storageChanged = false;
7801
7802	if (aNotify && mHWData.isBackedUp())
7803	{
7804	if (mHWData->mSharedFolders.size() !=
7805	mHWData.backedUpData()->mSharedFolders.size())
7806	sharedFoldersChanged = true;
7807	else
7808	{
7809	for (HWData::SharedFolderList::iterator rit =
7810	mHWData->mSharedFolders.begin();
7811	rit != mHWData->mSharedFolders.end() && !sharedFoldersChanged;
7812	++ rit)
7813	{
7814	for (HWData::SharedFolderList::iterator cit =
7815	mHWData.backedUpData()->mSharedFolders.begin();
7816	cit != mHWData.backedUpData()->mSharedFolders.end();
7817	++ cit)
7818	{
7819	if ((cit)->name() != (rit)->name() \|\|
7820	(cit)->hostPath() != (rit)->hostPath())
7821	{
7822	sharedFoldersChanged = true;
7823	break;
7824	}
7825	}
7826	}
7827	}
7828	}
7829
7830	if (!mStorageControllers.isNull())
7831	{
7832	if (mStorageControllers.isBackedUp())
7833	{
7834	/* unitialize all new devices (absent in the backed up list). */
7835	StorageControllerList::const_iterator it = mStorageControllers->begin();
7836	StorageControllerList *backedList = mStorageControllers.backedUpData();
7837	while (it != mStorageControllers->end())
7838	{
7839	if (std::find (backedList->begin(), backedList->end(), *it ) ==
7840	backedList->end())
7841	{
7842	(*it)->uninit();
7843	}
7844	++ it;
7845	}
7846
7847	/* restore the list */
7848	mStorageControllers.rollback();
7849	}
7850
7851	/* rollback any changes to devices after restoring the list */
7852	StorageControllerList::const_iterator it = mStorageControllers->begin();
7853	while (it != mStorageControllers->end())
7854	{
7855	if ((*it)->isModified())
7856	(*it)->rollback();
7857
7858	++ it;
7859	}
7860	}
7861
7862	mUserData.rollback();
7863
7864	mHWData.rollback();
7865
7866	if (mHDData.isBackedUp())
7867	fixupHardDisks(false /* aCommit */);
7868
7869	/* check for changes in child objects */
7870
7871	bool vrdpChanged = false, dvdChanged = false, floppyChanged = false,
7872	usbChanged = false;
7873
7874	ComPtr <INetworkAdapter> networkAdapters [RT_ELEMENTS (mNetworkAdapters)];
7875	ComPtr <ISerialPort> serialPorts [RT_ELEMENTS (mSerialPorts)];
7876	ComPtr <IParallelPort> parallelPorts [RT_ELEMENTS (mParallelPorts)];
7877
7878	if (mBIOSSettings)
7879	mBIOSSettings->rollback();
7880
7881	#ifdef VBOX_WITH_VRDP
7882	if (mVRDPServer)
7883	vrdpChanged = mVRDPServer->rollback();
7884	#endif
7885
7886	if (mDVDDrive)
7887	dvdChanged = mDVDDrive->rollback();
7888
7889	if (mFloppyDrive)
7890	floppyChanged = mFloppyDrive->rollback();
7891
7892	if (mAudioAdapter)
7893	mAudioAdapter->rollback();
7894
7895	if (mUSBController)
7896	usbChanged = mUSBController->rollback();
7897
7898	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
7899	if (mNetworkAdapters [slot])
7900	if (mNetworkAdapters [slot]->rollback())
7901	networkAdapters [slot] = mNetworkAdapters [slot];
7902
7903	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
7904	if (mSerialPorts [slot])
7905	if (mSerialPorts [slot]->rollback())
7906	serialPorts [slot] = mSerialPorts [slot];
7907
7908	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
7909	if (mParallelPorts [slot])
7910	if (mParallelPorts [slot]->rollback())
7911	parallelPorts [slot] = mParallelPorts [slot];
7912
7913	if (aNotify)
7914	{
7915	/* inform the direct session about changes */
7916
7917	ComObjPtr <Machine> that = this;
7918	alock.leave();
7919
7920	if (sharedFoldersChanged)
7921	that->onSharedFolderChange();
7922
7923	if (vrdpChanged)
7924	that->onVRDPServerChange();
7925	if (dvdChanged)
7926	that->onDVDDriveChange();
7927	if (floppyChanged)
7928	that->onFloppyDriveChange();
7929	if (usbChanged)
7930	that->onUSBControllerChange();
7931
7932	for (ULONG slot = 0; slot < RT_ELEMENTS (networkAdapters); slot ++)
7933	if (networkAdapters [slot])
7934	that->onNetworkAdapterChange (networkAdapters [slot]);
7935	for (ULONG slot = 0; slot < RT_ELEMENTS (serialPorts); slot ++)
7936	if (serialPorts [slot])
7937	that->onSerialPortChange (serialPorts [slot]);
7938	for (ULONG slot = 0; slot < RT_ELEMENTS (parallelPorts); slot ++)
7939	if (parallelPorts [slot])
7940	that->onParallelPortChange (parallelPorts [slot]);
7941
7942	if (storageChanged)
7943	that->onStorageControllerChange();
7944	}
7945	}
7946
7947	/**
7948	* Commits all the changes to machine settings.
7949	*
7950	* Note that this operation is supposed to never fail.
7951	*
7952	* @note Locks this object and children for writing.
7953	*/
7954	void Machine::commit()
7955	{
7956	AutoCaller autoCaller (this);
7957	AssertComRCReturnVoid (autoCaller.rc());
7958
7959	AutoCaller peerCaller (mPeer);
7960	AssertComRCReturnVoid (peerCaller.rc());
7961
7962	AutoMultiWriteLock2 alock (mPeer, this);
7963
7964	/*
7965	* use safe commit to ensure Snapshot machines (that share mUserData)
7966	* will still refer to a valid memory location
7967	*/
7968	mUserData.commitCopy();
7969
7970	mHWData.commit();
7971
7972	if (mHDData.isBackedUp())
7973	fixupHardDisks(true /* aCommit */);
7974
7975	mBIOSSettings->commit();
7976	#ifdef VBOX_WITH_VRDP
7977	mVRDPServer->commit();
7978	#endif
7979	mDVDDrive->commit();
7980	mFloppyDrive->commit();
7981	mAudioAdapter->commit();
7982	mUSBController->commit();
7983
7984	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
7985	mNetworkAdapters [slot]->commit();
7986	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
7987	mSerialPorts [slot]->commit();
7988	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
7989	mParallelPorts [slot]->commit();
7990
7991	bool commitStorageControllers = false;
7992
7993	if (mStorageControllers.isBackedUp())
7994	{
7995	mStorageControllers.commit();
7996
7997	if (mPeer)
7998	{
7999	AutoWriteLock peerlock (mPeer);
8000
8001	/* Commit all changes to new controllers (this will reshare data with
8002	* peers for thos who have peers) */
8003	StorageControllerList *newList = new StorageControllerList();
8004	StorageControllerList::const_iterator it = mStorageControllers->begin();
8005	while (it != mStorageControllers->end())
8006	{
8007	(*it)->commit();
8008
8009	/* look if this controller has a peer device */
8010	ComObjPtr<StorageController> peer = (*it)->peer();
8011	if (!peer)
8012	{
8013	/* no peer means the device is a newly created one;
8014	* create a peer owning data this device share it with */
8015	peer.createObject();
8016	peer->init (mPeer, it, true / aReshare */);
8017	}
8018	else
8019	{
8020	/* remove peer from the old list */
8021	mPeer->mStorageControllers->remove (peer);
8022	}
8023	/* and add it to the new list */
8024	newList->push_back(peer);
8025
8026	++ it;
8027	}
8028
8029	/* uninit old peer's controllers that are left */
8030	it = mPeer->mStorageControllers->begin();
8031	while (it != mPeer->mStorageControllers->end())
8032	{
8033	(*it)->uninit();
8034	++ it;
8035	}
8036
8037	/* attach new list of controllers to our peer */
8038	mPeer->mStorageControllers.attach (newList);
8039	}
8040	else
8041	{
8042	/* we have no peer (our parent is the newly created machine);
8043	* just commit changes to devices */
8044	commitStorageControllers = true;
8045	}
8046	}
8047	else
8048	{
8049	/* the list of controllers itself is not changed,
8050	* just commit changes to controllers themselves */
8051	commitStorageControllers = true;
8052	}
8053
8054	if (commitStorageControllers)
8055	{
8056	StorageControllerList::const_iterator it = mStorageControllers->begin();
8057	while (it != mStorageControllers->end())
8058	{
8059	(*it)->commit();
8060	++ it;
8061	}
8062	}
8063
8064	if (mType == IsSessionMachine)
8065	{
8066	/* attach new data to the primary machine and reshare it */
8067	mPeer->mUserData.attach (mUserData);
8068	mPeer->mHWData.attach (mHWData);
8069	/* mHDData is reshared by fixupHardDisks */
8070	// mPeer->mHDData.attach (mHDData);
8071	Assert (mPeer->mHDData.data() == mHDData.data());
8072	}
8073	}
8074
8075	/**
8076	* Copies all the hardware data from the given machine.
8077	*
8078	* Currently, only called when the VM is being restored from a snapshot. In
8079	* particular, this implies that the VM is not running during this method's
8080	* call.
8081	*
8082	* @note This method must be called from under this object's lock.
8083	*
8084	* @note This method doesn't call #commit(), so all data remains backed up and
8085	* unsaved.
8086	*/
8087	void Machine::copyFrom (Machine *aThat)
8088	{
8089	AssertReturnVoid (mType == IsMachine \|\| mType == IsSessionMachine);
8090	AssertReturnVoid (aThat->mType == IsSnapshotMachine);
8091
8092	AssertReturnVoid (!Global::IsOnline (mData->mMachineState));
8093
8094	mHWData.assignCopy (aThat->mHWData);
8095
8096	// create copies of all shared folders (mHWData after attiching a copy
8097	// contains just references to original objects)
8098	for (HWData::SharedFolderList::iterator it = mHWData->mSharedFolders.begin();
8099	it != mHWData->mSharedFolders.end();
8100	++ it)
8101	{
8102	ComObjPtr <SharedFolder> folder;
8103	folder.createObject();
8104	HRESULT rc = folder->initCopy (machine(), *it);
8105	AssertComRC (rc);
8106	*it = folder;
8107	}
8108
8109	mBIOSSettings->copyFrom (aThat->mBIOSSettings);
8110	#ifdef VBOX_WITH_VRDP
8111	mVRDPServer->copyFrom (aThat->mVRDPServer);
8112	#endif
8113	mDVDDrive->copyFrom (aThat->mDVDDrive);
8114	mFloppyDrive->copyFrom (aThat->mFloppyDrive);
8115	mAudioAdapter->copyFrom (aThat->mAudioAdapter);
8116	mUSBController->copyFrom (aThat->mUSBController);
8117
8118	/* create private copies of all controllers */
8119	mStorageControllers.backup();
8120	mStorageControllers->clear();
8121	for (StorageControllerList::iterator it = aThat->mStorageControllers->begin();
8122	it != aThat->mStorageControllers->end();
8123	++ it)
8124	{
8125	ComObjPtr <StorageController> ctrl;
8126	ctrl.createObject();
8127	ctrl->initCopy (this, *it);
8128	mStorageControllers->push_back(ctrl);
8129	}
8130
8131	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
8132	mNetworkAdapters [slot]->copyFrom (aThat->mNetworkAdapters [slot]);
8133	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
8134	mSerialPorts [slot]->copyFrom (aThat->mSerialPorts [slot]);
8135	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
8136	mParallelPorts [slot]->copyFrom (aThat->mParallelPorts [slot]);
8137	}
8138
8139	#ifdef VBOX_WITH_RESOURCE_USAGE_API
8140	void Machine::registerMetrics (PerformanceCollector aCollector, Machine aMachine, RTPROCESS pid)
8141	{
8142	pm::CollectorHAL *hal = aCollector->getHAL();
8143	/* Create sub metrics */
8144	pm::SubMetric *cpuLoadUser = new pm::SubMetric ("CPU/Load/User",
8145	"Percentage of processor time spent in user mode by VM process.");
8146	pm::SubMetric *cpuLoadKernel = new pm::SubMetric ("CPU/Load/Kernel",
8147	"Percentage of processor time spent in kernel mode by VM process.");
8148	pm::SubMetric *ramUsageUsed = new pm::SubMetric ("RAM/Usage/Used",
8149	"Size of resident portion of VM process in memory.");
8150	/* Create and register base metrics */
8151	pm::BaseMetric *cpuLoad = new pm::MachineCpuLoadRaw (hal, aMachine, pid,
8152	cpuLoadUser, cpuLoadKernel);
8153	aCollector->registerBaseMetric (cpuLoad);
8154	pm::BaseMetric *ramUsage = new pm::MachineRamUsage (hal, aMachine, pid,
8155	ramUsageUsed);
8156	aCollector->registerBaseMetric (ramUsage);
8157
8158	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadUser, 0));
8159	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadUser,
8160	new pm::AggregateAvg()));
8161	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadUser,
8162	new pm::AggregateMin()));
8163	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadUser,
8164	new pm::AggregateMax()));
8165	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadKernel, 0));
8166	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadKernel,
8167	new pm::AggregateAvg()));
8168	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadKernel,
8169	new pm::AggregateMin()));
8170	aCollector->registerMetric (new pm::Metric (cpuLoad, cpuLoadKernel,
8171	new pm::AggregateMax()));
8172
8173	aCollector->registerMetric (new pm::Metric (ramUsage, ramUsageUsed, 0));
8174	aCollector->registerMetric (new pm::Metric (ramUsage, ramUsageUsed,
8175	new pm::AggregateAvg()));
8176	aCollector->registerMetric (new pm::Metric (ramUsage, ramUsageUsed,
8177	new pm::AggregateMin()));
8178	aCollector->registerMetric (new pm::Metric (ramUsage, ramUsageUsed,
8179	new pm::AggregateMax()));
8180	};
8181
8182	void Machine::unregisterMetrics (PerformanceCollector aCollector, Machine aMachine)
8183	{
8184	aCollector->unregisterMetricsFor (aMachine);
8185	aCollector->unregisterBaseMetricsFor (aMachine);
8186	};
8187	#endif /* VBOX_WITH_RESOURCE_USAGE_API */
8188
8189
8190	/////////////////////////////////////////////////////////////////////////////
8191	// SessionMachine class
8192	/////////////////////////////////////////////////////////////////////////////
8193
8194	/** Task structure for asynchronous VM operations */
8195	struct SessionMachine::Task
8196	{
8197	Task (SessionMachine m, Progress p)
8198	: machine (m), progress (p)
8199	, state (m->mData->mMachineState) // save the current machine state
8200	, subTask (false)
8201	{}
8202
8203	void modifyLastState (MachineState_T s)
8204	{
8205	const_cast <MachineState_T > (&state) = s;
8206	}
8207
8208	virtual void handler() = 0;
8209
8210	ComObjPtr <SessionMachine> machine;
8211	ComObjPtr <Progress> progress;
8212	const MachineState_T state;
8213
8214	bool subTask : 1;
8215	};
8216
8217	/** Take snapshot task */
8218	struct SessionMachine::TakeSnapshotTask : public SessionMachine::Task
8219	{
8220	TakeSnapshotTask (SessionMachine *m)
8221	: Task (m, NULL) {}
8222
8223	void handler() { machine->takeSnapshotHandler (*this); }
8224	};
8225
8226	/** Discard snapshot task */
8227	struct SessionMachine::DiscardSnapshotTask : public SessionMachine::Task
8228	{
8229	DiscardSnapshotTask (SessionMachine m, Progress p, Snapshot *s)
8230	: Task (m, p)
8231	, snapshot (s) {}
8232
8233	DiscardSnapshotTask (const Task &task, Snapshot *s)
8234	: Task (task)
8235	, snapshot (s) {}
8236
8237	void handler() { machine->discardSnapshotHandler (*this); }
8238
8239	ComObjPtr <Snapshot> snapshot;
8240	};
8241
8242	/** Discard current state task */
8243	struct SessionMachine::DiscardCurrentStateTask : public SessionMachine::Task
8244	{
8245	DiscardCurrentStateTask (SessionMachine m, Progress p,
8246	bool discardCurSnapshot)
8247	: Task (m, p), discardCurrentSnapshot (discardCurSnapshot) {}
8248
8249	void handler() { machine->discardCurrentStateHandler (*this); }
8250
8251	const bool discardCurrentSnapshot;
8252	};
8253
8254	////////////////////////////////////////////////////////////////////////////////
8255
8256	DEFINE_EMPTY_CTOR_DTOR (SessionMachine)
8257
8258	HRESULT SessionMachine::FinalConstruct()
8259	{
8260	LogFlowThisFunc (("\n"));
8261
8262	/* set the proper type to indicate we're the SessionMachine instance */
8263	unconst (mType) = IsSessionMachine;
8264
8265	#if defined(RT_OS_WINDOWS)
8266	mIPCSem = NULL;
8267	#elif defined(RT_OS_OS2)
8268	mIPCSem = NULLHANDLE;
8269	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
8270	mIPCSem = -1;
8271	#else
8272	# error "Port me!"
8273	#endif
8274
8275	return S_OK;
8276	}
8277
8278	void SessionMachine::FinalRelease()
8279	{
8280	LogFlowThisFunc (("\n"));
8281
8282	uninit (Uninit::Unexpected);
8283	}
8284
8285	/**
8286	* @note Must be called only by Machine::openSession() from its own write lock.
8287	*/
8288	HRESULT SessionMachine::init (Machine *aMachine)
8289	{
8290	LogFlowThisFuncEnter();
8291	LogFlowThisFunc (("mName={%ls}\n", aMachine->mUserData->mName.raw()));
8292
8293	AssertReturn (aMachine, E_INVALIDARG);
8294
8295	AssertReturn (aMachine->lockHandle()->isWriteLockOnCurrentThread(), E_FAIL);
8296
8297	/* Enclose the state transition NotReady->InInit->Ready */
8298	AutoInitSpan autoInitSpan (this);
8299	AssertReturn (autoInitSpan.isOk(), E_FAIL);
8300
8301	/* create the interprocess semaphore */
8302	#if defined(RT_OS_WINDOWS)
8303	mIPCSemName = aMachine->mData->mConfigFileFull;
8304	for (size_t i = 0; i < mIPCSemName.length(); i++)
8305	if (mIPCSemName[i] == '\\')
8306	mIPCSemName[i] = '/';
8307	mIPCSem = ::CreateMutex (NULL, FALSE, mIPCSemName);
8308	ComAssertMsgRet (mIPCSem,
8309	("Cannot create IPC mutex '%ls', err=%d",
8310	mIPCSemName.raw(), ::GetLastError()),
8311	E_FAIL);
8312	#elif defined(RT_OS_OS2)
8313	Utf8Str ipcSem = Utf8StrFmt ("\\SEM32\\VBOX\\VM\\{%RTuuid}",
8314	aMachine->mData->mUuid.raw());
8315	mIPCSemName = ipcSem;
8316	APIRET arc = ::DosCreateMutexSem ((PSZ) ipcSem.raw(), &mIPCSem, 0, FALSE);
8317	ComAssertMsgRet (arc == NO_ERROR,
8318	("Cannot create IPC mutex '%s', arc=%ld",
8319	ipcSem.raw(), arc),
8320	E_FAIL);
8321	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
8322	# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
8323	# if defined(RT_OS_FREEBSD) && (HC_ARCH_BITS == 64)
8324	/** @todo Check that this still works correctly. */
8325	AssertCompileSize(key_t, 8);
8326	# else
8327	AssertCompileSize(key_t, 4);
8328	# endif
8329	key_t key;
8330	mIPCSem = -1;
8331	mIPCKey = "0";
8332	for (uint32_t i = 0; i < 1 << 24; i++)
8333	{
8334	key = ((uint32_t)'V' << 24) \| i;
8335	int sem = ::semget (key, 1, S_IRUSR \| S_IWUSR \| IPC_CREAT \| IPC_EXCL);
8336	if (sem >= 0 \|\| (errno != EEXIST && errno != EACCES))
8337	{
8338	mIPCSem = sem;
8339	if (sem >= 0)
8340	mIPCKey = BstrFmt ("%u", key);
8341	break;
8342	}
8343	}
8344	# else /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
8345	Utf8Str semName = aMachine->mData->mConfigFileFull;
8346	char *pszSemName = NULL;
8347	RTStrUtf8ToCurrentCP (&pszSemName, semName);
8348	key_t key = ::ftok (pszSemName, 'V');
8349	RTStrFree (pszSemName);
8350
8351	mIPCSem = ::semget (key, 1, S_IRWXU \| S_IRWXG \| S_IRWXO \| IPC_CREAT);
8352	# endif /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
8353
8354	int errnoSave = errno;
8355	if (mIPCSem < 0 && errnoSave == ENOSYS)
8356	{
8357	setError (E_FAIL,
8358	tr ("Cannot create IPC semaphore. Most likely your host kernel lacks "
8359	"support for SysV IPC. Check the host kernel configuration for "
8360	"CONFIG_SYSVIPC=y"));
8361	return E_FAIL;
8362	}
8363	ComAssertMsgRet (mIPCSem >= 0, ("Cannot create IPC semaphore, errno=%d", errnoSave),
8364	E_FAIL);
8365	/* set the initial value to 1 */
8366	int rv = ::semctl (mIPCSem, 0, SETVAL, 1);
8367	ComAssertMsgRet (rv == 0, ("Cannot init IPC semaphore, errno=%d", errno),
8368	E_FAIL);
8369	#else
8370	# error "Port me!"
8371	#endif
8372
8373	/* memorize the peer Machine */
8374	unconst (mPeer) = aMachine;
8375	/* share the parent pointer */
8376	unconst (mParent) = aMachine->mParent;
8377
8378	/* take the pointers to data to share */
8379	mData.share (aMachine->mData);
8380	mSSData.share (aMachine->mSSData);
8381
8382	mUserData.share (aMachine->mUserData);
8383	mHWData.share (aMachine->mHWData);
8384	mHDData.share (aMachine->mHDData);
8385
8386	mStorageControllers.allocate();
8387	StorageControllerList::const_iterator it = aMachine->mStorageControllers->begin();
8388	while (it != aMachine->mStorageControllers->end())
8389	{
8390	ComObjPtr <StorageController> ctl;
8391	ctl.createObject();
8392	ctl->init(this, *it);
8393	mStorageControllers->push_back (ctl);
8394	++ it;
8395	}
8396
8397	unconst (mBIOSSettings).createObject();
8398	mBIOSSettings->init (this, aMachine->mBIOSSettings);
8399	#ifdef VBOX_WITH_VRDP
8400	/* create another VRDPServer object that will be mutable */
8401	unconst (mVRDPServer).createObject();
8402	mVRDPServer->init (this, aMachine->mVRDPServer);
8403	#endif
8404	/* create another DVD drive object that will be mutable */
8405	unconst (mDVDDrive).createObject();
8406	mDVDDrive->init (this, aMachine->mDVDDrive);
8407	/* create another floppy drive object that will be mutable */
8408	unconst (mFloppyDrive).createObject();
8409	mFloppyDrive->init (this, aMachine->mFloppyDrive);
8410	/* create another audio adapter object that will be mutable */
8411	unconst (mAudioAdapter).createObject();
8412	mAudioAdapter->init (this, aMachine->mAudioAdapter);
8413	/* create a list of serial ports that will be mutable */
8414	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
8415	{
8416	unconst (mSerialPorts [slot]).createObject();
8417	mSerialPorts [slot]->init (this, aMachine->mSerialPorts [slot]);
8418	}
8419	/* create a list of parallel ports that will be mutable */
8420	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
8421	{
8422	unconst (mParallelPorts [slot]).createObject();
8423	mParallelPorts [slot]->init (this, aMachine->mParallelPorts [slot]);
8424	}
8425	/* create another USB controller object that will be mutable */
8426	unconst (mUSBController).createObject();
8427	mUSBController->init (this, aMachine->mUSBController);
8428
8429	/* create a list of network adapters that will be mutable */
8430	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
8431	{
8432	unconst (mNetworkAdapters [slot]).createObject();
8433	mNetworkAdapters [slot]->init (this, aMachine->mNetworkAdapters [slot]);
8434	}
8435
8436	/* default is to delete saved state on Saved -> PoweredOff transition */
8437	mRemoveSavedState = true;
8438
8439	/* Confirm a successful initialization when it's the case */
8440	autoInitSpan.setSucceeded();
8441
8442	LogFlowThisFuncLeave();
8443	return S_OK;
8444	}
8445
8446	/**
8447	* Uninitializes this session object. If the reason is other than
8448	* Uninit::Unexpected, then this method MUST be called from #checkForDeath().
8449	*
8450	* @param aReason uninitialization reason
8451	*
8452	* @note Locks mParent + this object for writing.
8453	*/
8454	void SessionMachine::uninit (Uninit::Reason aReason)
8455	{
8456	LogFlowThisFuncEnter();
8457	LogFlowThisFunc (("reason=%d\n", aReason));
8458
8459	/*
8460	* Strongly reference ourselves to prevent this object deletion after
8461	* mData->mSession.mMachine.setNull() below (which can release the last
8462	* reference and call the destructor). Important: this must be done before
8463	* accessing any members (and before AutoUninitSpan that does it as well).
8464	* This self reference will be released as the very last step on return.
8465	*/
8466	ComObjPtr <SessionMachine> selfRef = this;
8467
8468	/* Enclose the state transition Ready->InUninit->NotReady */
8469	AutoUninitSpan autoUninitSpan (this);
8470	if (autoUninitSpan.uninitDone())
8471	{
8472	LogFlowThisFunc (("Already uninitialized\n"));
8473	LogFlowThisFuncLeave();
8474	return;
8475	}
8476
8477	if (autoUninitSpan.initFailed())
8478	{
8479	/* We've been called by init() because it's failed. It's not really
8480	* necessary (nor it's safe) to perform the regular uninit sequense
8481	* below, the following is enough.
8482	*/
8483	LogFlowThisFunc (("Initialization failed.\n"));
8484	#if defined(RT_OS_WINDOWS)
8485	if (mIPCSem)
8486	::CloseHandle (mIPCSem);
8487	mIPCSem = NULL;
8488	#elif defined(RT_OS_OS2)
8489	if (mIPCSem != NULLHANDLE)
8490	::DosCloseMutexSem (mIPCSem);
8491	mIPCSem = NULLHANDLE;
8492	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
8493	if (mIPCSem >= 0)
8494	::semctl (mIPCSem, 0, IPC_RMID);
8495	mIPCSem = -1;
8496	# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
8497	mIPCKey = "0";
8498	# endif /* VBOX_WITH_NEW_SYS_V_KEYGEN */
8499	#else
8500	# error "Port me!"
8501	#endif
8502	uninitDataAndChildObjects();
8503	mData.free();
8504	unconst (mParent).setNull();
8505	unconst (mPeer).setNull();
8506	LogFlowThisFuncLeave();
8507	return;
8508	}
8509
8510	/* We need to lock this object in uninit() because the lock is shared
8511	* with mPeer (as well as data we modify below). mParent->addProcessToReap()
8512	* and others need mParent lock. */
8513	AutoMultiWriteLock2 alock (mParent, this);
8514
8515	#ifdef VBOX_WITH_RESOURCE_USAGE_API
8516	unregisterMetrics (mParent->performanceCollector(), mPeer);
8517	#endif /* VBOX_WITH_RESOURCE_USAGE_API */
8518
8519	MachineState_T lastState = mData->mMachineState;
8520	NOREF(lastState);
8521
8522	if (aReason == Uninit::Abnormal)
8523	{
8524	LogWarningThisFunc (("ABNORMAL client termination! (wasBusy=%d)\n",
8525	Global::IsOnlineOrTransient (lastState)));
8526
8527	/* reset the state to Aborted */
8528	if (mData->mMachineState != MachineState_Aborted)
8529	setMachineState (MachineState_Aborted);
8530	}
8531
8532	if (isModified())
8533	{
8534	LogWarningThisFunc (("Discarding unsaved settings changes!\n"));
8535	rollback (false /* aNotify */);
8536	}
8537
8538	Assert (!mSnapshotData.mStateFilePath \|\| !mSnapshotData.mSnapshot);
8539	if (mSnapshotData.mStateFilePath)
8540	{
8541	LogWarningThisFunc (("canceling failed save state request!\n"));
8542	endSavingState (FALSE /* aSuccess */);
8543	}
8544	else if (!mSnapshotData.mSnapshot.isNull())
8545	{
8546	LogWarningThisFunc (("canceling untaken snapshot!\n"));
8547	endTakingSnapshot (FALSE /* aSuccess */);
8548	}
8549
8550	#ifdef VBOX_WITH_USB
8551	/* release all captured USB devices */
8552	if (aReason == Uninit::Abnormal && Global::IsOnline (lastState))
8553	{
8554	/* Console::captureUSBDevices() is called in the VM process only after
8555	* setting the machine state to Starting or Restoring.
8556	* Console::detachAllUSBDevices() will be called upon successful
8557	* termination. So, we need to release USB devices only if there was
8558	* an abnormal termination of a running VM.
8559	*
8560	* This is identical to SessionMachine::DetachAllUSBDevices except
8561	* for the aAbnormal argument. */
8562	HRESULT rc = mUSBController->notifyProxy (false /* aInsertFilters */);
8563	AssertComRC (rc);
8564	NOREF (rc);
8565
8566	USBProxyService *service = mParent->host()->usbProxyService();
8567	if (service)
8568	service->detachAllDevicesFromVM (this, true /* aDone /, true / aAbnormal */);
8569	}
8570	#endif /* VBOX_WITH_USB */
8571
8572	if (!mData->mSession.mType.isNull())
8573	{
8574	/* mType is not null when this machine's process has been started by
8575	* VirtualBox::OpenRemoteSession(), therefore it is our child. We
8576	* need to queue the PID to reap the process (and avoid zombies on
8577	* Linux). */
8578	Assert (mData->mSession.mPid != NIL_RTPROCESS);
8579	mParent->addProcessToReap (mData->mSession.mPid);
8580	}
8581
8582	mData->mSession.mPid = NIL_RTPROCESS;
8583
8584	if (aReason == Uninit::Unexpected)
8585	{
8586	/* Uninitialization didn't come from #checkForDeath(), so tell the
8587	* client watcher thread to update the set of machines that have open
8588	* sessions. */
8589	mParent->updateClientWatcher();
8590	}
8591
8592	/* uninitialize all remote controls */
8593	if (mData->mSession.mRemoteControls.size())
8594	{
8595	LogFlowThisFunc (("Closing remote sessions (%d):\n",
8596	mData->mSession.mRemoteControls.size()));
8597
8598	Data::Session::RemoteControlList::iterator it =
8599	mData->mSession.mRemoteControls.begin();
8600	while (it != mData->mSession.mRemoteControls.end())
8601	{
8602	LogFlowThisFunc ((" Calling remoteControl->Uninitialize()...\n"));
8603	HRESULT rc = (*it)->Uninitialize();
8604	LogFlowThisFunc ((" remoteControl->Uninitialize() returned %08X\n", rc));
8605	if (FAILED (rc))
8606	LogWarningThisFunc (("Forgot to close the remote session?\n"));
8607	++ it;
8608	}
8609	mData->mSession.mRemoteControls.clear();
8610	}
8611
8612	/*
8613	* An expected uninitialization can come only from #checkForDeath().
8614	* Otherwise it means that something's got really wrong (for examlple,
8615	* the Session implementation has released the VirtualBox reference
8616	* before it triggered #OnSessionEnd(), or before releasing IPC semaphore,
8617	* etc). However, it's also possible, that the client releases the IPC
8618	* semaphore correctly (i.e. before it releases the VirtualBox reference),
8619	* but the VirtualBox release event comes first to the server process.
8620	* This case is practically possible, so we should not assert on an
8621	* unexpected uninit, just log a warning.
8622	*/
8623
8624	if ((aReason == Uninit::Unexpected))
8625	LogWarningThisFunc (("Unexpected SessionMachine uninitialization!\n"));
8626
8627	if (aReason != Uninit::Normal)
8628	{
8629	mData->mSession.mDirectControl.setNull();
8630	}
8631	else
8632	{
8633	/* this must be null here (see #OnSessionEnd()) */
8634	Assert (mData->mSession.mDirectControl.isNull());
8635	Assert (mData->mSession.mState == SessionState_Closing);
8636	Assert (!mData->mSession.mProgress.isNull());
8637
8638	mData->mSession.mProgress->notifyComplete (S_OK);
8639	mData->mSession.mProgress.setNull();
8640	}
8641
8642	/* remove the association between the peer machine and this session machine */
8643	Assert (mData->mSession.mMachine == this \|\|
8644	aReason == Uninit::Unexpected);
8645
8646	/* reset the rest of session data */
8647	mData->mSession.mMachine.setNull();
8648	mData->mSession.mState = SessionState_Closed;
8649	mData->mSession.mType.setNull();
8650
8651	/* close the interprocess semaphore before leaving the shared lock */
8652	#if defined(RT_OS_WINDOWS)
8653	if (mIPCSem)
8654	::CloseHandle (mIPCSem);
8655	mIPCSem = NULL;
8656	#elif defined(RT_OS_OS2)
8657	if (mIPCSem != NULLHANDLE)
8658	::DosCloseMutexSem (mIPCSem);
8659	mIPCSem = NULLHANDLE;
8660	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
8661	if (mIPCSem >= 0)
8662	::semctl (mIPCSem, 0, IPC_RMID);
8663	mIPCSem = -1;
8664	# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
8665	mIPCKey = "0";
8666	# endif /* VBOX_WITH_NEW_SYS_V_KEYGEN */
8667	#else
8668	# error "Port me!"
8669	#endif
8670
8671	/* fire an event */
8672	mParent->onSessionStateChange (mData->mUuid, SessionState_Closed);
8673
8674	uninitDataAndChildObjects();
8675
8676	/* free the essential data structure last */
8677	mData.free();
8678
8679	/* leave the shared lock before setting the below two to NULL */
8680	alock.leave();
8681
8682	unconst (mParent).setNull();
8683	unconst (mPeer).setNull();
8684
8685	LogFlowThisFuncLeave();
8686	}
8687
8688	// util::Lockable interface
8689	////////////////////////////////////////////////////////////////////////////////
8690
8691	/**
8692	* Overrides VirtualBoxBase::lockHandle() in order to share the lock handle
8693	* with the primary Machine instance (mPeer).
8694	*/
8695	RWLockHandle *SessionMachine::lockHandle() const
8696	{
8697	AssertReturn (!mPeer.isNull(), NULL);
8698	return mPeer->lockHandle();
8699	}
8700
8701	// IInternalMachineControl methods
8702	////////////////////////////////////////////////////////////////////////////////
8703
8704	/**
8705	* @note Locks this object for writing.
8706	*/
8707	STDMETHODIMP SessionMachine::SetRemoveSavedState(BOOL aRemove)
8708	{
8709	AutoCaller autoCaller (this);
8710	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
8711
8712	AutoWriteLock alock (this);
8713
8714	mRemoveSavedState = aRemove;
8715
8716	return S_OK;
8717	}
8718
8719	/**
8720	* @note Locks the same as #setMachineState() does.
8721	*/
8722	STDMETHODIMP SessionMachine::UpdateState (MachineState_T aMachineState)
8723	{
8724	return setMachineState (aMachineState);
8725	}
8726
8727	/**
8728	* @note Locks this object for reading.
8729	*/
8730	STDMETHODIMP SessionMachine::GetIPCId (BSTR *aId)
8731	{
8732	AutoCaller autoCaller (this);
8733	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
8734
8735	AutoReadLock alock (this);
8736
8737	#if defined(RT_OS_WINDOWS) \|\| defined(RT_OS_OS2)
8738	mIPCSemName.cloneTo (aId);
8739	return S_OK;
8740	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
8741	# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
8742	mIPCKey.cloneTo (aId);
8743	# else /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
8744	mData->mConfigFileFull.cloneTo (aId);
8745	# endif /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
8746	return S_OK;
8747	#else
8748	# error "Port me!"
8749	#endif
8750	}
8751
8752	/**
8753	* Goes through the USB filters of the given machine to see if the given
8754	* device matches any filter or not.
8755	*
8756	* @note Locks the same as USBController::hasMatchingFilter() does.
8757	*/
8758	STDMETHODIMP SessionMachine::RunUSBDeviceFilters (IUSBDevice *aUSBDevice,
8759	BOOL *aMatched,
8760	ULONG *aMaskedIfs)
8761	{
8762	LogFlowThisFunc (("\n"));
8763
8764	CheckComArgNotNull (aUSBDevice);
8765	CheckComArgOutPointerValid (aMatched);
8766
8767	AutoCaller autoCaller (this);
8768	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
8769
8770	#ifdef VBOX_WITH_USB
8771	*aMatched = mUSBController->hasMatchingFilter (aUSBDevice, aMaskedIfs);
8772	#else
8773	NOREF(aUSBDevice);
8774	NOREF(aMaskedIfs);
8775	*aMatched = FALSE;
8776	#endif
8777
8778	return S_OK;
8779	}
8780
8781	/**
8782	* @note Locks the same as Host::captureUSBDevice() does.
8783	*/
8784	STDMETHODIMP SessionMachine::CaptureUSBDevice (IN_BSTR aId)
8785	{
8786	LogFlowThisFunc (("\n"));
8787
8788	AutoCaller autoCaller (this);
8789	AssertComRCReturnRC (autoCaller.rc());
8790
8791	#ifdef VBOX_WITH_USB
8792	/* if captureDeviceForVM() fails, it must have set extended error info */
8793	MultiResult rc = mParent->host()->checkUSBProxyService();
8794	CheckComRCReturnRC (rc);
8795
8796	USBProxyService *service = mParent->host()->usbProxyService();
8797	AssertReturn (service, E_FAIL);
8798	return service->captureDeviceForVM (this, Guid(aId));
8799	#else
8800	NOREF(aId);
8801	return E_NOTIMPL;
8802	#endif
8803	}
8804
8805	/**
8806	* @note Locks the same as Host::detachUSBDevice() does.
8807	*/
8808	STDMETHODIMP SessionMachine::DetachUSBDevice (IN_BSTR aId, BOOL aDone)
8809	{
8810	LogFlowThisFunc (("\n"));
8811
8812	AutoCaller autoCaller (this);
8813	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
8814
8815	#ifdef VBOX_WITH_USB
8816	USBProxyService *service = mParent->host()->usbProxyService();
8817	AssertReturn (service, E_FAIL);
8818	return service->detachDeviceFromVM (this, Guid(aId), !!aDone);
8819	#else
8820	NOREF(aId);
8821	NOREF(aDone);
8822	return E_NOTIMPL;
8823	#endif
8824	}
8825
8826	/**
8827	* Inserts all machine filters to the USB proxy service and then calls
8828	* Host::autoCaptureUSBDevices().
8829	*
8830	* Called by Console from the VM process upon VM startup.
8831	*
8832	* @note Locks what called methods lock.
8833	*/
8834	STDMETHODIMP SessionMachine::AutoCaptureUSBDevices()
8835	{
8836	LogFlowThisFunc (("\n"));
8837
8838	AutoCaller autoCaller (this);
8839	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
8840
8841	#ifdef VBOX_WITH_USB
8842	HRESULT rc = mUSBController->notifyProxy (true /* aInsertFilters */);
8843	AssertComRC (rc);
8844	NOREF (rc);
8845
8846	USBProxyService *service = mParent->host()->usbProxyService();
8847	AssertReturn (service, E_FAIL);
8848	return service->autoCaptureDevicesForVM (this);
8849	#else
8850	return S_OK;
8851	#endif
8852	}
8853
8854	/**
8855	* Removes all machine filters from the USB proxy service and then calls
8856	* Host::detachAllUSBDevices().
8857	*
8858	* Called by Console from the VM process upon normal VM termination or by
8859	* SessionMachine::uninit() upon abnormal VM termination (from under the
8860	* Machine/SessionMachine lock).
8861	*
8862	* @note Locks what called methods lock.
8863	*/
8864	STDMETHODIMP SessionMachine::DetachAllUSBDevices (BOOL aDone)
8865	{
8866	LogFlowThisFunc (("\n"));
8867
8868	AutoCaller autoCaller (this);
8869	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
8870
8871	#ifdef VBOX_WITH_USB
8872	HRESULT rc = mUSBController->notifyProxy (false /* aInsertFilters */);
8873	AssertComRC (rc);
8874	NOREF (rc);
8875
8876	USBProxyService *service = mParent->host()->usbProxyService();
8877	AssertReturn (service, E_FAIL);
8878	return service->detachAllDevicesFromVM (this, !!aDone, false /* aAbnormal */);
8879	#else
8880	NOREF(aDone);
8881	return S_OK;
8882	#endif
8883	}
8884
8885	/**
8886	* @note Locks this object for writing.
8887	*/
8888	STDMETHODIMP SessionMachine::OnSessionEnd (ISession *aSession,
8889	IProgress **aProgress)
8890	{
8891	LogFlowThisFuncEnter();
8892
8893	AssertReturn (aSession, E_INVALIDARG);
8894	AssertReturn (aProgress, E_INVALIDARG);
8895
8896	AutoCaller autoCaller (this);
8897
8898	LogFlowThisFunc (("state=%d\n", autoCaller.state()));
8899	/*
8900	* We don't assert below because it might happen that a non-direct session
8901	* informs us it is closed right after we've been uninitialized -- it's ok.
8902	*/
8903	CheckComRCReturnRC (autoCaller.rc());
8904
8905	/* get IInternalSessionControl interface */
8906	ComPtr <IInternalSessionControl> control (aSession);
8907
8908	ComAssertRet (!control.isNull(), E_INVALIDARG);
8909
8910	AutoWriteLock alock (this);
8911
8912	if (control.equalsTo (mData->mSession.mDirectControl))
8913	{
8914	ComAssertRet (aProgress, E_POINTER);
8915
8916	/* The direct session is being normally closed by the client process
8917	* ----------------------------------------------------------------- */
8918
8919	/* go to the closing state (essential for all open*Session() calls and
8920	* for #checkForDeath()) */
8921	Assert (mData->mSession.mState == SessionState_Open);
8922	mData->mSession.mState = SessionState_Closing;
8923
8924	/* set direct control to NULL to release the remote instance */
8925	mData->mSession.mDirectControl.setNull();
8926	LogFlowThisFunc (("Direct control is set to NULL\n"));
8927
8928	/* Create the progress object the client will use to wait until
8929	* #checkForDeath() is called to uninitialize this session object after
8930	* it releases the IPC semaphore. */
8931	ComObjPtr <Progress> progress;
8932	progress.createObject();
8933	progress->init (mParent, static_cast <IMachine *> (mPeer),
8934	Bstr (tr ("Closing session")), FALSE /* aCancelable */);
8935	progress.queryInterfaceTo (aProgress);
8936	mData->mSession.mProgress = progress;
8937	}
8938	else
8939	{
8940	/* the remote session is being normally closed */
8941	Data::Session::RemoteControlList::iterator it =
8942	mData->mSession.mRemoteControls.begin();
8943	while (it != mData->mSession.mRemoteControls.end())
8944	{
8945	if (control.equalsTo (*it))
8946	break;
8947	++it;
8948	}
8949	BOOL found = it != mData->mSession.mRemoteControls.end();
8950	ComAssertMsgRet (found, ("The session is not found in the session list!"),
8951	E_INVALIDARG);
8952	mData->mSession.mRemoteControls.remove (*it);
8953	}
8954
8955	LogFlowThisFuncLeave();
8956	return S_OK;
8957	}
8958
8959	/**
8960	* @note Locks this object for writing.
8961	*/
8962	STDMETHODIMP SessionMachine::BeginSavingState (IProgress aProgress, BSTR aStateFilePath)
8963	{
8964	LogFlowThisFuncEnter();
8965
8966	AssertReturn (aProgress, E_INVALIDARG);
8967	AssertReturn (aStateFilePath, E_POINTER);
8968
8969	AutoCaller autoCaller (this);
8970	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
8971
8972	AutoWriteLock alock (this);
8973
8974	AssertReturn (mData->mMachineState == MachineState_Paused &&
8975	mSnapshotData.mLastState == MachineState_Null &&
8976	mSnapshotData.mProgressId.isEmpty() &&
8977	mSnapshotData.mStateFilePath.isNull(),
8978	E_FAIL);
8979
8980	/* memorize the progress ID and add it to the global collection */
8981	Bstr progressId;
8982	HRESULT rc = aProgress->COMGETTER(Id) (progressId.asOutParam());
8983	AssertComRCReturn (rc, rc);
8984	rc = mParent->addProgress (aProgress);
8985	AssertComRCReturn (rc, rc);
8986
8987	Bstr stateFilePath;
8988	/* stateFilePath is null when the machine is not running */
8989	if (mData->mMachineState == MachineState_Paused)
8990	{
8991	stateFilePath = Utf8StrFmt ("%ls%c{%RTuuid}.sav",
8992	mUserData->mSnapshotFolderFull.raw(),
8993	RTPATH_DELIMITER, mData->mUuid.raw());
8994	}
8995
8996	/* fill in the snapshot data */
8997	mSnapshotData.mLastState = mData->mMachineState;
8998	mSnapshotData.mProgressId = Guid(progressId);
8999	mSnapshotData.mStateFilePath = stateFilePath;
9000
9001	/* set the state to Saving (this is expected by Console::SaveState()) */
9002	setMachineState (MachineState_Saving);
9003
9004	stateFilePath.cloneTo (aStateFilePath);
9005
9006	return S_OK;
9007	}
9008
9009	/**
9010	* @note Locks mParent + this object for writing.
9011	*/
9012	STDMETHODIMP SessionMachine::EndSavingState (BOOL aSuccess)
9013	{
9014	LogFlowThisFunc (("\n"));
9015
9016	AutoCaller autoCaller (this);
9017	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9018
9019	/* endSavingState() need mParent lock */
9020	AutoMultiWriteLock2 alock (mParent, this);
9021
9022	AssertReturn (mData->mMachineState == MachineState_Saving &&
9023	mSnapshotData.mLastState != MachineState_Null &&
9024	!mSnapshotData.mProgressId.isEmpty() &&
9025	!mSnapshotData.mStateFilePath.isNull(),
9026	E_FAIL);
9027
9028	/*
9029	* on success, set the state to Saved;
9030	* on failure, set the state to the state we had when BeginSavingState() was
9031	* called (this is expected by Console::SaveState() and
9032	* Console::saveStateThread())
9033	*/
9034	if (aSuccess)
9035	setMachineState (MachineState_Saved);
9036	else
9037	setMachineState (mSnapshotData.mLastState);
9038
9039	return endSavingState (aSuccess);
9040	}
9041
9042	/**
9043	* @note Locks this object for writing.
9044	*/
9045	STDMETHODIMP SessionMachine::AdoptSavedState (IN_BSTR aSavedStateFile)
9046	{
9047	LogFlowThisFunc (("\n"));
9048
9049	AssertReturn (aSavedStateFile, E_INVALIDARG);
9050
9051	AutoCaller autoCaller (this);
9052	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9053
9054	AutoWriteLock alock (this);
9055
9056	AssertReturn (mData->mMachineState == MachineState_PoweredOff \|\|
9057	mData->mMachineState == MachineState_Aborted,
9058	E_FAIL);
9059
9060	Utf8Str stateFilePathFull = aSavedStateFile;
9061	int vrc = calculateFullPath (stateFilePathFull, stateFilePathFull);
9062	if (RT_FAILURE (vrc))
9063	return setError (VBOX_E_FILE_ERROR,
9064	tr ("Invalid saved state file path '%ls' (%Rrc)"),
9065	aSavedStateFile, vrc);
9066
9067	mSSData->mStateFilePath = stateFilePathFull;
9068
9069	/* The below setMachineState() will detect the state transition and will
9070	* update the settings file */
9071
9072	return setMachineState (MachineState_Saved);
9073	}
9074
9075	/**
9076	* @note Locks mParent + this object for writing.
9077	*/
9078	STDMETHODIMP SessionMachine::BeginTakingSnapshot (
9079	IConsole *aInitiator, IN_BSTR aName, IN_BSTR aDescription,
9080	IProgress aProgress, BSTR aStateFilePath,
9081	IProgress **aServerProgress)
9082	{
9083	LogFlowThisFuncEnter();
9084
9085	AssertReturn (aInitiator && aName, E_INVALIDARG);
9086	AssertReturn (aStateFilePath && aServerProgress, E_POINTER);
9087
9088	LogFlowThisFunc (("aName='%ls'\n", aName));
9089
9090	AutoCaller autoCaller (this);
9091	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9092
9093	/* saveSettings() needs mParent lock */
9094	AutoMultiWriteLock2 alock (mParent, this);
9095
9096	AssertReturn ((!Global::IsOnlineOrTransient (mData->mMachineState) \|\|
9097	mData->mMachineState == MachineState_Paused) &&
9098	mSnapshotData.mLastState == MachineState_Null &&
9099	mSnapshotData.mSnapshot.isNull() &&
9100	mSnapshotData.mServerProgress.isNull() &&
9101	mSnapshotData.mCombinedProgress.isNull(),
9102	E_FAIL);
9103
9104	bool takingSnapshotOnline = mData->mMachineState == MachineState_Paused;
9105
9106	if (!takingSnapshotOnline && mData->mMachineState != MachineState_Saved)
9107	{
9108	/* save all current settings to ensure current changes are committed and
9109	* hard disks are fixed up */
9110	HRESULT rc = saveSettings();
9111	CheckComRCReturnRC (rc);
9112	}
9113
9114	/// @todo NEWMEDIA so far, we decided to allow for Writhethrough hard disks
9115	/// when taking snapshots putting all the responsibility to the user...
9116	#if 0
9117	/* check that there are no Writethrough hard disks attached */
9118	for (HDData::AttachmentList::const_iterator
9119	it = mHDData->mAttachments.begin();
9120	it != mHDData->mAttachments.end();
9121	++ it)
9122	{
9123	ComObjPtr <HardDisk> hd = (*it)->hardDisk();
9124	AutoReadLock hdLock (hd);
9125	if (hd->type() == HardDiskType_Writethrough)
9126	return setError (E_FAIL,
9127	tr ("Cannot take a snapshot because the Writethrough hard disk "
9128	"'%ls' is attached to this virtual machine"),
9129	hd->locationFull().raw());
9130	}
9131	#endif
9132
9133	AssertReturn (aProgress \|\| !takingSnapshotOnline, E_FAIL);
9134
9135	/* create an ID for the snapshot */
9136	Guid snapshotId;
9137	snapshotId.create();
9138
9139	Bstr stateFilePath;
9140	/* stateFilePath is null when the machine is not online nor saved */
9141	if (takingSnapshotOnline \|\| mData->mMachineState == MachineState_Saved)
9142	stateFilePath = Utf8StrFmt ("%ls%c{%RTuuid}.sav",
9143	mUserData->mSnapshotFolderFull.raw(),
9144	RTPATH_DELIMITER,
9145	snapshotId.ptr());
9146
9147	/* ensure the directory for the saved state file exists */
9148	if (stateFilePath)
9149	{
9150	HRESULT rc = VirtualBox::ensureFilePathExists (Utf8Str (stateFilePath));
9151	CheckComRCReturnRC (rc);
9152	}
9153
9154	/* create a snapshot machine object */
9155	ComObjPtr <SnapshotMachine> snapshotMachine;
9156	snapshotMachine.createObject();
9157	HRESULT rc = snapshotMachine->init (this, snapshotId, stateFilePath);
9158	AssertComRCReturn (rc, rc);
9159
9160	Bstr progressDesc = BstrFmt (tr ("Taking snapshot of virtual machine '%ls'"),
9161	mUserData->mName.raw());
9162	Bstr firstOpDesc = Bstr (tr ("Preparing to take snapshot"));
9163
9164	/* create a server-side progress object (it will be descriptionless when we
9165	* need to combine it with the VM-side progress, i.e. when we're taking a
9166	* snapshot online). The number of operations is: 1 (preparing) + # of
9167	* hard disks + 1 (if the state is saved so we need to copy it)
9168	*/
9169	ComObjPtr <Progress> serverProgress;
9170	serverProgress.createObject();
9171	{
9172	ULONG opCount = 1 + (ULONG)mHDData->mAttachments.size();
9173	if (mData->mMachineState == MachineState_Saved)
9174	opCount ++;
9175	if (takingSnapshotOnline)
9176	rc = serverProgress->init (FALSE, opCount, firstOpDesc);
9177	else
9178	rc = serverProgress->init (mParent, aInitiator, progressDesc, FALSE,
9179	opCount, firstOpDesc);
9180	AssertComRCReturn (rc, rc);
9181	}
9182
9183	/* create a combined server-side progress object when necessary */
9184	ComObjPtr <CombinedProgress> combinedProgress;
9185	if (takingSnapshotOnline)
9186	{
9187	combinedProgress.createObject();
9188	rc = combinedProgress->init (mParent, aInitiator, progressDesc,
9189	serverProgress, aProgress);
9190	AssertComRCReturn (rc, rc);
9191	}
9192
9193	/* create a snapshot object */
9194	RTTIMESPEC time;
9195	ComObjPtr <Snapshot> snapshot;
9196	snapshot.createObject();
9197	rc = snapshot->init (snapshotId, aName, aDescription,
9198	*RTTimeNow (&time), snapshotMachine,
9199	mData->mCurrentSnapshot);
9200	AssertComRCReturnRC (rc);
9201
9202	/* create and start the task on a separate thread (note that it will not
9203	* start working until we release alock) */
9204	TakeSnapshotTask *task = new TakeSnapshotTask (this);
9205	int vrc = RTThreadCreate (NULL, taskHandler,
9206	(void *) task,
9207	0, RTTHREADTYPE_MAIN_WORKER, 0, "TakeSnapshot");
9208	if (RT_FAILURE (vrc))
9209	{
9210	snapshot->uninit();
9211	delete task;
9212	ComAssertRCRet (vrc, E_FAIL);
9213	}
9214
9215	/* fill in the snapshot data */
9216	mSnapshotData.mLastState = mData->mMachineState;
9217	mSnapshotData.mSnapshot = snapshot;
9218	mSnapshotData.mServerProgress = serverProgress;
9219	mSnapshotData.mCombinedProgress = combinedProgress;
9220
9221	/* set the state to Saving (this is expected by Console::TakeSnapshot()) */
9222	setMachineState (MachineState_Saving);
9223
9224	if (takingSnapshotOnline)
9225	stateFilePath.cloneTo (aStateFilePath);
9226	else
9227	*aStateFilePath = NULL;
9228
9229	serverProgress.queryInterfaceTo (aServerProgress);
9230
9231	LogFlowThisFuncLeave();
9232	return S_OK;
9233	}
9234
9235	/**
9236	* @note Locks this object for writing.
9237	*/
9238	STDMETHODIMP SessionMachine::EndTakingSnapshot (BOOL aSuccess)
9239	{
9240	LogFlowThisFunc (("\n"));
9241
9242	AutoCaller autoCaller (this);
9243	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9244
9245	AutoWriteLock alock (this);
9246
9247	AssertReturn (!aSuccess \|\|
9248	(mData->mMachineState == MachineState_Saving &&
9249	mSnapshotData.mLastState != MachineState_Null &&
9250	!mSnapshotData.mSnapshot.isNull() &&
9251	!mSnapshotData.mServerProgress.isNull() &&
9252	!mSnapshotData.mCombinedProgress.isNull()),
9253	E_FAIL);
9254
9255	/* set the state to the state we had when BeginTakingSnapshot() was called
9256	* (this is expected by Console::TakeSnapshot() and
9257	* Console::saveStateThread()) */
9258	setMachineState (mSnapshotData.mLastState);
9259
9260	return endTakingSnapshot (aSuccess);
9261	}
9262
9263	/**
9264	* @note Locks mParent + this + children objects for writing!
9265	*/
9266	STDMETHODIMP SessionMachine::DiscardSnapshot (
9267	IConsole *aInitiator, IN_BSTR aId,
9268	MachineState_T aMachineState, IProgress *aProgress)
9269	{
9270	LogFlowThisFunc (("\n"));
9271
9272	Guid id(aId);
9273	AssertReturn (aInitiator && !id.isEmpty(), E_INVALIDARG);
9274	AssertReturn (aMachineState && aProgress, E_POINTER);
9275
9276	AutoCaller autoCaller (this);
9277	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9278
9279	/* saveSettings() needs mParent lock */
9280	AutoMultiWriteLock2 alock (mParent, this);
9281
9282	ComAssertRet (!Global::IsOnlineOrTransient (mData->mMachineState), E_FAIL);
9283
9284	ComObjPtr <Snapshot> snapshot;
9285	HRESULT rc = findSnapshot (id, snapshot, true /* aSetError */);
9286	CheckComRCReturnRC (rc);
9287
9288	AutoWriteLock snapshotLock (snapshot);
9289
9290	{
9291	AutoWriteLock chLock (snapshot->childrenLock());
9292	size_t childrenCount = snapshot->children().size();
9293	if (childrenCount > 1)
9294	return setError (VBOX_E_INVALID_OBJECT_STATE,
9295	tr ("Snapshot '%ls' of the machine '%ls' has more than one "
9296	"child snapshot (%d)"),
9297	snapshot->data().mName.raw(), mUserData->mName.raw(),
9298	childrenCount);
9299	}
9300
9301	/* If the snapshot being discarded is the current one, ensure current
9302	* settings are committed and saved.
9303	*/
9304	if (snapshot == mData->mCurrentSnapshot)
9305	{
9306	if (isModified())
9307	{
9308	rc = saveSettings();
9309	CheckComRCReturnRC (rc);
9310	}
9311	}
9312
9313	/* create a progress object. The number of operations is:
9314	* 1 (preparing) + # of hard disks + 1 if the snapshot is online
9315	*/
9316	ComObjPtr <Progress> progress;
9317	progress.createObject();
9318	rc = progress->init (mParent, aInitiator,
9319	Bstr (Utf8StrFmt (tr ("Discarding snapshot '%ls'"),
9320	snapshot->data().mName.raw())),
9321	FALSE /* aCancelable */,
9322	1 + (ULONG)snapshot->data().mMachine->mHDData->mAttachments.size() +
9323	(snapshot->stateFilePath().isNull() ? 0 : 1),
9324	Bstr (tr ("Preparing to discard snapshot")));
9325	AssertComRCReturn (rc, rc);
9326
9327	/* create and start the task on a separate thread */
9328	DiscardSnapshotTask *task = new DiscardSnapshotTask (this, progress, snapshot);
9329	int vrc = RTThreadCreate (NULL, taskHandler,
9330	(void *) task,
9331	0, RTTHREADTYPE_MAIN_WORKER, 0, "DiscardSnapshot");
9332	if (RT_FAILURE (vrc))
9333	delete task;
9334	ComAssertRCRet (vrc, E_FAIL);
9335
9336	/* set the proper machine state (note: after creating a Task instance) */
9337	setMachineState (MachineState_Discarding);
9338
9339	/* return the progress to the caller */
9340	progress.queryInterfaceTo (aProgress);
9341
9342	/* return the new state to the caller */
9343	*aMachineState = mData->mMachineState;
9344
9345	return S_OK;
9346	}
9347
9348	/**
9349	* @note Locks this + children objects for writing!
9350	*/
9351	STDMETHODIMP SessionMachine::DiscardCurrentState (
9352	IConsole aInitiator, MachineState_T aMachineState, IProgress **aProgress)
9353	{
9354	LogFlowThisFunc (("\n"));
9355
9356	AssertReturn (aInitiator, E_INVALIDARG);
9357	AssertReturn (aMachineState && aProgress, E_POINTER);
9358
9359	AutoCaller autoCaller (this);
9360	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9361
9362	AutoWriteLock alock (this);
9363
9364	ComAssertRet (!Global::IsOnlineOrTransient (mData->mMachineState), E_FAIL);
9365
9366	if (mData->mCurrentSnapshot.isNull())
9367	return setError (VBOX_E_INVALID_OBJECT_STATE,
9368	tr ("Could not discard the current state of the machine '%ls' "
9369	"because it doesn't have any snapshots"),
9370	mUserData->mName.raw());
9371
9372	/* create a progress object. The number of operations is: 1 (preparing) + #
9373	* of hard disks + 1 (if we need to copy the saved state file) */
9374	ComObjPtr <Progress> progress;
9375	progress.createObject();
9376	{
9377	ULONG opCount = 1 + (ULONG)mData->mCurrentSnapshot->data()
9378	.mMachine->mHDData->mAttachments.size();
9379	if (mData->mCurrentSnapshot->stateFilePath())
9380	++ opCount;
9381	progress->init (mParent, aInitiator,
9382	Bstr (tr ("Discarding current machine state")),
9383	FALSE /* aCancelable */, opCount,
9384	Bstr (tr ("Preparing to discard current state")));
9385	}
9386
9387	/* create and start the task on a separate thread (note that it will not
9388	* start working until we release alock) */
9389	DiscardCurrentStateTask *task =
9390	new DiscardCurrentStateTask (this, progress, false /* discardCurSnapshot */);
9391	int vrc = RTThreadCreate (NULL, taskHandler,
9392	(void *) task,
9393	0, RTTHREADTYPE_MAIN_WORKER, 0, "DiscardCurState");
9394	if (RT_FAILURE (vrc))
9395	{
9396	delete task;
9397	ComAssertRCRet (vrc, E_FAIL);
9398	}
9399
9400	/* set the proper machine state (note: after creating a Task instance) */
9401	setMachineState (MachineState_Discarding);
9402
9403	/* return the progress to the caller */
9404	progress.queryInterfaceTo (aProgress);
9405
9406	/* return the new state to the caller */
9407	*aMachineState = mData->mMachineState;
9408
9409	return S_OK;
9410	}
9411
9412	/**
9413	* @note Locks thos object for writing!
9414	*/
9415	STDMETHODIMP SessionMachine::DiscardCurrentSnapshotAndState (
9416	IConsole aInitiator, MachineState_T aMachineState, IProgress **aProgress)
9417	{
9418	LogFlowThisFunc (("\n"));
9419
9420	AssertReturn (aInitiator, E_INVALIDARG);
9421	AssertReturn (aMachineState && aProgress, E_POINTER);
9422
9423	AutoCaller autoCaller (this);
9424	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9425
9426	AutoWriteLock alock (this);
9427
9428	ComAssertRet (!Global::IsOnlineOrTransient (mData->mMachineState), E_FAIL);
9429
9430	if (mData->mCurrentSnapshot.isNull())
9431	return setError (VBOX_E_INVALID_OBJECT_STATE,
9432	tr ("Could not discard the current state of the machine '%ls' "
9433	"because it doesn't have any snapshots"),
9434	mUserData->mName.raw());
9435
9436	/* create a progress object. The number of operations is:
9437	* 1 (preparing) + # of hard disks in the current snapshot +
9438	* # of hard disks in the previous snapshot +
9439	* 1 if we need to copy the saved state file of the previous snapshot +
9440	* 1 if the current snapshot is online
9441	* or (if there is no previous snapshot):
9442	* 1 (preparing) + # of hard disks in the current snapshot * 2 +
9443	* 1 if we need to copy the saved state file of the current snapshot * 2
9444	*/
9445	ComObjPtr <Progress> progress;
9446	progress.createObject();
9447	{
9448	ComObjPtr <Snapshot> curSnapshot = mData->mCurrentSnapshot;
9449	ComObjPtr <Snapshot> prevSnapshot = mData->mCurrentSnapshot->parent();
9450
9451	ULONG opCount = 1;
9452	if (prevSnapshot)
9453	{
9454	opCount += (ULONG)curSnapshot->data().mMachine->mHDData->mAttachments.size();
9455	opCount += (ULONG)prevSnapshot->data().mMachine->mHDData->mAttachments.size();
9456	if (prevSnapshot->stateFilePath())
9457	++ opCount;
9458	if (curSnapshot->stateFilePath())
9459	++ opCount;
9460	}
9461	else
9462	{
9463	opCount +=
9464	(ULONG)curSnapshot->data().mMachine->mHDData->mAttachments.size() * 2;
9465	if (curSnapshot->stateFilePath())
9466	opCount += 2;
9467	}
9468
9469	progress->init (mParent, aInitiator,
9470	Bstr (tr ("Discarding current machine snapshot and state")),
9471	FALSE /* aCancelable */, opCount,
9472	Bstr (tr ("Preparing to discard current snapshot and state")));
9473	}
9474
9475	/* create and start the task on a separate thread */
9476	DiscardCurrentStateTask *task =
9477	new DiscardCurrentStateTask (this, progress, true /* discardCurSnapshot */);
9478	int vrc = RTThreadCreate (NULL, taskHandler,
9479	(void *) task,
9480	0, RTTHREADTYPE_MAIN_WORKER, 0, "DiscardCurStSnp");
9481	if (RT_FAILURE (vrc))
9482	{
9483	delete task;
9484	ComAssertRCRet (vrc, E_FAIL);
9485	}
9486
9487	/* set the proper machine state (note: after creating a Task instance) */
9488	setMachineState (MachineState_Discarding);
9489
9490	/* return the progress to the caller */
9491	progress.queryInterfaceTo (aProgress);
9492
9493	/* return the new state to the caller */
9494	*aMachineState = mData->mMachineState;
9495
9496	return S_OK;
9497	}
9498
9499	STDMETHODIMP SessionMachine::
9500	PullGuestProperties (ComSafeArrayOut (BSTR, aNames),
9501	ComSafeArrayOut (BSTR, aValues),
9502	ComSafeArrayOut (ULONG64, aTimestamps),
9503	ComSafeArrayOut (BSTR, aFlags))
9504	{
9505	LogFlowThisFunc (("\n"));
9506
9507	#ifdef VBOX_WITH_GUEST_PROPS
9508	using namespace guestProp;
9509
9510	AutoCaller autoCaller (this);
9511	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9512
9513	AutoReadLock alock (this);
9514
9515	AssertReturn (!ComSafeArrayOutIsNull (aNames), E_POINTER);
9516	AssertReturn (!ComSafeArrayOutIsNull (aValues), E_POINTER);
9517	AssertReturn (!ComSafeArrayOutIsNull (aTimestamps), E_POINTER);
9518	AssertReturn (!ComSafeArrayOutIsNull (aFlags), E_POINTER);
9519
9520	size_t cEntries = mHWData->mGuestProperties.size();
9521	com::SafeArray <BSTR> names (cEntries);
9522	com::SafeArray <BSTR> values (cEntries);
9523	com::SafeArray <ULONG64> timestamps (cEntries);
9524	com::SafeArray <BSTR> flags (cEntries);
9525	unsigned i = 0;
9526	for (HWData::GuestPropertyList::iterator it = mHWData->mGuestProperties.begin();
9527	it != mHWData->mGuestProperties.end(); ++it)
9528	{
9529	char szFlags[MAX_FLAGS_LEN + 1];
9530	it->mName.cloneTo (&names[i]);
9531	it->mValue.cloneTo (&values[i]);
9532	timestamps[i] = it->mTimestamp;
9533	writeFlags (it->mFlags, szFlags);
9534	Bstr (szFlags).cloneTo (&flags[i]);
9535	++i;
9536	}
9537	names.detachTo (ComSafeArrayOutArg (aNames));
9538	values.detachTo (ComSafeArrayOutArg (aValues));
9539	timestamps.detachTo (ComSafeArrayOutArg (aTimestamps));
9540	flags.detachTo (ComSafeArrayOutArg (aFlags));
9541	mHWData->mPropertyServiceActive = true;
9542	return S_OK;
9543	#else
9544	ReturnComNotImplemented();
9545	#endif
9546	}
9547
9548	STDMETHODIMP SessionMachine::PushGuestProperties (ComSafeArrayIn (IN_BSTR, aNames),
9549	ComSafeArrayIn (IN_BSTR, aValues),
9550	ComSafeArrayIn (ULONG64, aTimestamps),
9551	ComSafeArrayIn (IN_BSTR, aFlags))
9552	{
9553	LogFlowThisFunc (("\n"));
9554
9555	#ifdef VBOX_WITH_GUEST_PROPS
9556	using namespace guestProp;
9557
9558	AutoCaller autoCaller (this);
9559	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9560
9561	AutoWriteLock alock (this);
9562
9563	/* Temporarily reset the registered flag, so that our machine state
9564	* changes (i.e. mHWData.backup()) succeed. (isMutable() used in
9565	* all setters will return FALSE for a Machine instance if mRegistered
9566	* is TRUE). This is copied from registeredInit(), and may or may not be
9567	* the right way to handle this. */
9568	mData->mRegistered = FALSE;
9569	HRESULT rc = checkStateDependency (MutableStateDep);
9570	LogRel (("checkStateDependency (MutableStateDep) returned 0x%x\n", rc));
9571	CheckComRCReturnRC (rc);
9572
9573	// ComAssertRet (mData->mMachineState < MachineState_Running, E_FAIL);
9574
9575	AssertReturn (!ComSafeArrayInIsNull (aNames), E_POINTER);
9576	AssertReturn (!ComSafeArrayInIsNull (aValues), E_POINTER);
9577	AssertReturn (!ComSafeArrayInIsNull (aTimestamps), E_POINTER);
9578	AssertReturn (!ComSafeArrayInIsNull (aFlags), E_POINTER);
9579
9580	com::SafeArray <IN_BSTR> names (ComSafeArrayInArg (aNames));
9581	com::SafeArray <IN_BSTR> values (ComSafeArrayInArg (aValues));
9582	com::SafeArray <ULONG64> timestamps (ComSafeArrayInArg (aTimestamps));
9583	com::SafeArray <IN_BSTR> flags (ComSafeArrayInArg (aFlags));
9584	DiscardSettings();
9585	mHWData.backup();
9586	mHWData->mGuestProperties.erase (mHWData->mGuestProperties.begin(),
9587	mHWData->mGuestProperties.end());
9588	for (unsigned i = 0; i < names.size(); ++i)
9589	{
9590	uint32_t fFlags = NILFLAG;
9591	validateFlags (Utf8Str (flags[i]).raw(), &fFlags);
9592	HWData::GuestProperty property = { names[i], values[i], timestamps[i], fFlags };
9593	mHWData->mGuestProperties.push_back (property);
9594	}
9595	mHWData->mPropertyServiceActive = false;
9596	alock.unlock();
9597	SaveSettings();
9598	/* Restore the mRegistered flag. */
9599	mData->mRegistered = TRUE;
9600	return S_OK;
9601	#else
9602	ReturnComNotImplemented();
9603	#endif
9604	}
9605
9606	STDMETHODIMP SessionMachine::PushGuestProperty (IN_BSTR aName, IN_BSTR aValue,
9607	ULONG64 aTimestamp, IN_BSTR aFlags)
9608	{
9609	LogFlowThisFunc (("\n"));
9610
9611	#ifdef VBOX_WITH_GUEST_PROPS
9612	using namespace guestProp;
9613
9614	CheckComArgNotNull (aName);
9615	if ((aValue != NULL) && (!VALID_PTR (aValue) \|\| !VALID_PTR (aFlags)))
9616	return E_POINTER; /* aValue can be NULL to indicate deletion */
9617
9618	Utf8Str utf8Name (aName);
9619	Utf8Str utf8Flags (aFlags);
9620	Utf8Str utf8Patterns (mHWData->mGuestPropertyNotificationPatterns);
9621	if ( utf8Name.isNull()
9622	\|\| ((aFlags != NULL) && utf8Flags.isNull())
9623	\|\| utf8Patterns.isNull()
9624	)
9625	return E_OUTOFMEMORY;
9626
9627	uint32_t fFlags = NILFLAG;
9628	if ((aFlags != NULL) && RT_FAILURE (validateFlags (utf8Flags.raw(), &fFlags)))
9629	return E_INVALIDARG;
9630
9631	bool matchAll = false;
9632	if (utf8Patterns.length() == 0)
9633	matchAll = true;
9634
9635	AutoCaller autoCaller (this);
9636	CheckComRCReturnRC (autoCaller.rc());
9637
9638	AutoWriteLock alock (this);
9639
9640	HRESULT rc = checkStateDependency (MutableStateDep);
9641	CheckComRCReturnRC (rc);
9642
9643	mHWData.backup();
9644	for (HWData::GuestPropertyList::iterator iter = mHWData->mGuestProperties.begin();
9645	iter != mHWData->mGuestProperties.end(); ++iter)
9646	if (aName == iter->mName)
9647	{
9648	mHWData->mGuestProperties.erase (iter);
9649	break;
9650	}
9651	if (aValue != NULL)
9652	{
9653	HWData::GuestProperty property = { aName, aValue, aTimestamp, fFlags };
9654	mHWData->mGuestProperties.push_back (property);
9655	}
9656
9657	/* send a callback notification if appropriate */
9658	alock.leave();
9659	if ( matchAll
9660	\|\| RTStrSimplePatternMultiMatch (utf8Patterns.raw(), RTSTR_MAX,
9661	utf8Name.raw(), RTSTR_MAX, NULL)
9662	)
9663	mParent->onGuestPropertyChange (mData->mUuid, aName, aValue, aFlags);
9664
9665	return S_OK;
9666	#else
9667	ReturnComNotImplemented();
9668	#endif
9669	}
9670
9671	// public methods only for internal purposes
9672	/////////////////////////////////////////////////////////////////////////////
9673
9674	/**
9675	* Called from the client watcher thread to check for expected or unexpected
9676	* death of the client process that has a direct session to this machine.
9677	*
9678	* On Win32 and on OS/2, this method is called only when we've got the
9679	* mutex (i.e. the client has either died or terminated normally) so it always
9680	* returns @c true (the client is terminated, the session machine is
9681	* uninitialized).
9682	*
9683	* On other platforms, the method returns @c true if the client process has
9684	* terminated normally or abnormally and the session machine was uninitialized,
9685	* and @c false if the client process is still alive.
9686	*
9687	* @note Locks this object for writing.
9688	*/
9689	bool SessionMachine::checkForDeath()
9690	{
9691	Uninit::Reason reason;
9692	bool terminated = false;
9693
9694	/* Enclose autoCaller with a block because calling uninit() from under it
9695	* will deadlock. */
9696	{
9697	AutoCaller autoCaller (this);
9698	if (!autoCaller.isOk())
9699	{
9700	/* return true if not ready, to cause the client watcher to exclude
9701	* the corresponding session from watching */
9702	LogFlowThisFunc (("Already uninitialized!"));
9703	return true;
9704	}
9705
9706	AutoWriteLock alock (this);
9707
9708	/* Determine the reason of death: if the session state is Closing here,
9709	* everything is fine. Otherwise it means that the client did not call
9710	* OnSessionEnd() before it released the IPC semaphore. This may happen
9711	* either because the client process has abnormally terminated, or
9712	* because it simply forgot to call ISession::Close() before exiting. We
9713	* threat the latter also as an abnormal termination (see
9714	* Session::uninit() for details). */
9715	reason = mData->mSession.mState == SessionState_Closing ?
9716	Uninit::Normal :
9717	Uninit::Abnormal;
9718
9719	#if defined(RT_OS_WINDOWS)
9720
9721	AssertMsg (mIPCSem, ("semaphore must be created"));
9722
9723	/* release the IPC mutex */
9724	::ReleaseMutex (mIPCSem);
9725
9726	terminated = true;
9727
9728	#elif defined(RT_OS_OS2)
9729
9730	AssertMsg (mIPCSem, ("semaphore must be created"));
9731
9732	/* release the IPC mutex */
9733	::DosReleaseMutexSem (mIPCSem);
9734
9735	terminated = true;
9736
9737	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
9738
9739	AssertMsg (mIPCSem >= 0, ("semaphore must be created"));
9740
9741	int val = ::semctl (mIPCSem, 0, GETVAL);
9742	if (val > 0)
9743	{
9744	/* the semaphore is signaled, meaning the session is terminated */
9745	terminated = true;
9746	}
9747
9748	#else
9749	# error "Port me!"
9750	#endif
9751
9752	} /* AutoCaller block */
9753
9754	if (terminated)
9755	uninit (reason);
9756
9757	return terminated;
9758	}
9759
9760	/**
9761	* @note Locks this object for reading.
9762	*/
9763	HRESULT SessionMachine::onDVDDriveChange()
9764	{
9765	LogFlowThisFunc (("\n"));
9766
9767	AutoCaller autoCaller (this);
9768	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9769
9770	ComPtr <IInternalSessionControl> directControl;
9771	{
9772	AutoReadLock alock (this);
9773	directControl = mData->mSession.mDirectControl;
9774	}
9775
9776	/* ignore notifications sent after #OnSessionEnd() is called */
9777	if (!directControl)
9778	return S_OK;
9779
9780	return directControl->OnDVDDriveChange();
9781	}
9782
9783	/**
9784	* @note Locks this object for reading.
9785	*/
9786	HRESULT SessionMachine::onFloppyDriveChange()
9787	{
9788	LogFlowThisFunc (("\n"));
9789
9790	AutoCaller autoCaller (this);
9791	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9792
9793	ComPtr <IInternalSessionControl> directControl;
9794	{
9795	AutoReadLock alock (this);
9796	directControl = mData->mSession.mDirectControl;
9797	}
9798
9799	/* ignore notifications sent after #OnSessionEnd() is called */
9800	if (!directControl)
9801	return S_OK;
9802
9803	return directControl->OnFloppyDriveChange();
9804	}
9805
9806	/**
9807	* @note Locks this object for reading.
9808	*/
9809	HRESULT SessionMachine::onNetworkAdapterChange (INetworkAdapter *networkAdapter)
9810	{
9811	LogFlowThisFunc (("\n"));
9812
9813	AutoCaller autoCaller (this);
9814	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9815
9816	ComPtr <IInternalSessionControl> directControl;
9817	{
9818	AutoReadLock alock (this);
9819	directControl = mData->mSession.mDirectControl;
9820	}
9821
9822	/* ignore notifications sent after #OnSessionEnd() is called */
9823	if (!directControl)
9824	return S_OK;
9825
9826	return directControl->OnNetworkAdapterChange (networkAdapter);
9827	}
9828
9829	/**
9830	* @note Locks this object for reading.
9831	*/
9832	HRESULT SessionMachine::onSerialPortChange (ISerialPort *serialPort)
9833	{
9834	LogFlowThisFunc (("\n"));
9835
9836	AutoCaller autoCaller (this);
9837	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9838
9839	ComPtr <IInternalSessionControl> directControl;
9840	{
9841	AutoReadLock alock (this);
9842	directControl = mData->mSession.mDirectControl;
9843	}
9844
9845	/* ignore notifications sent after #OnSessionEnd() is called */
9846	if (!directControl)
9847	return S_OK;
9848
9849	return directControl->OnSerialPortChange (serialPort);
9850	}
9851
9852	/**
9853	* @note Locks this object for reading.
9854	*/
9855	HRESULT SessionMachine::onParallelPortChange (IParallelPort *parallelPort)
9856	{
9857	LogFlowThisFunc (("\n"));
9858
9859	AutoCaller autoCaller (this);
9860	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9861
9862	ComPtr <IInternalSessionControl> directControl;
9863	{
9864	AutoReadLock alock (this);
9865	directControl = mData->mSession.mDirectControl;
9866	}
9867
9868	/* ignore notifications sent after #OnSessionEnd() is called */
9869	if (!directControl)
9870	return S_OK;
9871
9872	return directControl->OnParallelPortChange (parallelPort);
9873	}
9874
9875	/**
9876	* @note Locks this object for reading.
9877	*/
9878	HRESULT SessionMachine::onStorageControllerChange ()
9879	{
9880	LogFlowThisFunc (("\n"));
9881
9882	AutoCaller autoCaller (this);
9883	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9884
9885	ComPtr <IInternalSessionControl> directControl;
9886	{
9887	AutoReadLock alock (this);
9888	directControl = mData->mSession.mDirectControl;
9889	}
9890
9891	/* ignore notifications sent after #OnSessionEnd() is called */
9892	if (!directControl)
9893	return S_OK;
9894
9895	return directControl->OnStorageControllerChange ();
9896	}
9897
9898	/**
9899	* @note Locks this object for reading.
9900	*/
9901	HRESULT SessionMachine::onVRDPServerChange()
9902	{
9903	LogFlowThisFunc (("\n"));
9904
9905	AutoCaller autoCaller (this);
9906	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9907
9908	ComPtr <IInternalSessionControl> directControl;
9909	{
9910	AutoReadLock alock (this);
9911	directControl = mData->mSession.mDirectControl;
9912	}
9913
9914	/* ignore notifications sent after #OnSessionEnd() is called */
9915	if (!directControl)
9916	return S_OK;
9917
9918	return directControl->OnVRDPServerChange();
9919	}
9920
9921	/**
9922	* @note Locks this object for reading.
9923	*/
9924	HRESULT SessionMachine::onUSBControllerChange()
9925	{
9926	LogFlowThisFunc (("\n"));
9927
9928	AutoCaller autoCaller (this);
9929	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
9930
9931	ComPtr <IInternalSessionControl> directControl;
9932	{
9933	AutoReadLock alock (this);
9934	directControl = mData->mSession.mDirectControl;
9935	}
9936
9937	/* ignore notifications sent after #OnSessionEnd() is called */
9938	if (!directControl)
9939	return S_OK;
9940
9941	return directControl->OnUSBControllerChange();
9942	}
9943
9944	/**
9945	* @note Locks this object for reading.
9946	*/
9947	HRESULT SessionMachine::onSharedFolderChange()
9948	{
9949	LogFlowThisFunc (("\n"));
9950
9951	AutoCaller autoCaller (this);
9952	AssertComRCReturnRC (autoCaller.rc());
9953
9954	ComPtr <IInternalSessionControl> directControl;
9955	{
9956	AutoReadLock alock (this);
9957	directControl = mData->mSession.mDirectControl;
9958	}
9959
9960	/* ignore notifications sent after #OnSessionEnd() is called */
9961	if (!directControl)
9962	return S_OK;
9963
9964	return directControl->OnSharedFolderChange (FALSE /* aGlobal */);
9965	}
9966
9967	/**
9968	* Returns @c true if this machine's USB controller reports it has a matching
9969	* filter for the given USB device and @c false otherwise.
9970	*
9971	* @note Locks this object for reading.
9972	*/
9973	bool SessionMachine::hasMatchingUSBFilter (const ComObjPtr <HostUSBDevice> &aDevice, ULONG *aMaskedIfs)
9974	{
9975	AutoCaller autoCaller (this);
9976	/* silently return if not ready -- this method may be called after the
9977	* direct machine session has been called */
9978	if (!autoCaller.isOk())
9979	return false;
9980
9981	AutoReadLock alock (this);
9982
9983	#ifdef VBOX_WITH_USB
9984	switch (mData->mMachineState)
9985	{
9986	case MachineState_Starting:
9987	case MachineState_Restoring:
9988	case MachineState_Paused:
9989	case MachineState_Running:
9990	return mUSBController->hasMatchingFilter (aDevice, aMaskedIfs);
9991	default: break;
9992	}
9993	#else
9994	NOREF(aDevice);
9995	NOREF(aMaskedIfs);
9996	#endif
9997	return false;
9998	}
9999
10000	/**
10001	* @note The calls shall hold no locks. Will temporarily lock this object for reading.
10002	*/
10003	HRESULT SessionMachine::onUSBDeviceAttach (IUSBDevice *aDevice,
10004	IVirtualBoxErrorInfo *aError,
10005	ULONG aMaskedIfs)
10006	{
10007	LogFlowThisFunc (("\n"));
10008
10009	AutoCaller autoCaller (this);
10010
10011	/* This notification may happen after the machine object has been
10012	* uninitialized (the session was closed), so don't assert. */
10013	CheckComRCReturnRC (autoCaller.rc());
10014
10015	ComPtr <IInternalSessionControl> directControl;
10016	{
10017	AutoReadLock alock (this);
10018	directControl = mData->mSession.mDirectControl;
10019	}
10020
10021	/* fail on notifications sent after #OnSessionEnd() is called, it is
10022	* expected by the caller */
10023	if (!directControl)
10024	return E_FAIL;
10025
10026	/* No locks should be held at this point. */
10027	AssertMsg (RTThreadGetWriteLockCount (RTThreadSelf()) == 0, ("%d\n", RTThreadGetWriteLockCount (RTThreadSelf())));
10028	AssertMsg (RTThreadGetReadLockCount (RTThreadSelf()) == 0, ("%d\n", RTThreadGetReadLockCount (RTThreadSelf())));
10029
10030	return directControl->OnUSBDeviceAttach (aDevice, aError, aMaskedIfs);
10031	}
10032
10033	/**
10034	* @note The calls shall hold no locks. Will temporarily lock this object for reading.
10035	*/
10036	HRESULT SessionMachine::onUSBDeviceDetach (IN_BSTR aId,
10037	IVirtualBoxErrorInfo *aError)
10038	{
10039	LogFlowThisFunc (("\n"));
10040
10041	AutoCaller autoCaller (this);
10042
10043	/* This notification may happen after the machine object has been
10044	* uninitialized (the session was closed), so don't assert. */
10045	CheckComRCReturnRC (autoCaller.rc());
10046
10047	ComPtr <IInternalSessionControl> directControl;
10048	{
10049	AutoReadLock alock (this);
10050	directControl = mData->mSession.mDirectControl;
10051	}
10052
10053	/* fail on notifications sent after #OnSessionEnd() is called, it is
10054	* expected by the caller */
10055	if (!directControl)
10056	return E_FAIL;
10057
10058	/* No locks should be held at this point. */
10059	AssertMsg (RTThreadGetWriteLockCount (RTThreadSelf()) == 0, ("%d\n", RTThreadGetWriteLockCount (RTThreadSelf())));
10060	AssertMsg (RTThreadGetReadLockCount (RTThreadSelf()) == 0, ("%d\n", RTThreadGetReadLockCount (RTThreadSelf())));
10061
10062	return directControl->OnUSBDeviceDetach (aId, aError);
10063	}
10064
10065	// protected methods
10066	/////////////////////////////////////////////////////////////////////////////
10067
10068	/**
10069	* Helper method to finalize saving the state.
10070	*
10071	* @note Must be called from under this object's lock.
10072	*
10073	* @param aSuccess TRUE if the snapshot has been taken successfully
10074	*
10075	* @note Locks mParent + this objects for writing.
10076	*/
10077	HRESULT SessionMachine::endSavingState (BOOL aSuccess)
10078	{
10079	LogFlowThisFuncEnter();
10080
10081	AutoCaller autoCaller (this);
10082	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
10083
10084	/* saveSettings() needs mParent lock */
10085	AutoMultiWriteLock2 alock (mParent, this);
10086
10087	HRESULT rc = S_OK;
10088
10089	if (aSuccess)
10090	{
10091	mSSData->mStateFilePath = mSnapshotData.mStateFilePath;
10092
10093	/* save all VM settings */
10094	rc = saveSettings();
10095	}
10096	else
10097	{
10098	/* delete the saved state file (it might have been already created) */
10099	RTFileDelete (Utf8Str (mSnapshotData.mStateFilePath));
10100	}
10101
10102	/* remove the completed progress object */
10103	mParent->removeProgress (mSnapshotData.mProgressId);
10104
10105	/* clear out the temporary saved state data */
10106	mSnapshotData.mLastState = MachineState_Null;
10107	mSnapshotData.mProgressId.clear();
10108	mSnapshotData.mStateFilePath.setNull();
10109
10110	LogFlowThisFuncLeave();
10111	return rc;
10112	}
10113
10114	/**
10115	* Helper method to finalize taking a snapshot. Gets called to finalize the
10116	* "take snapshot" procedure.
10117	*
10118	* Expected to be called after completing all the tasks related to taking the
10119	* snapshot, either successfully or unsuccessfilly.
10120	*
10121	* @param aSuccess TRUE if the snapshot has been taken successfully.
10122	*
10123	* @note Locks this objects for writing.
10124	*/
10125	HRESULT SessionMachine::endTakingSnapshot (BOOL aSuccess)
10126	{
10127	LogFlowThisFuncEnter();
10128
10129	AutoCaller autoCaller (this);
10130	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
10131
10132	AutoWriteLock alock (this);
10133
10134	AssertReturn (!mSnapshotData.mSnapshot.isNull(), E_FAIL);
10135
10136	MultiResult rc (S_OK);
10137
10138	if (aSuccess)
10139	{
10140	/* the server progress must be completed on success */
10141	Assert (mSnapshotData.mServerProgress->completed());
10142
10143	mData->mCurrentSnapshot = mSnapshotData.mSnapshot;
10144
10145	/* memorize the first snapshot if necessary */
10146	if (!mData->mFirstSnapshot)
10147	mData->mFirstSnapshot = mData->mCurrentSnapshot;
10148
10149	int opFlags = SaveSS_AddOp \| SaveSS_CurrentId;
10150	if (!Global::IsOnline (mSnapshotData.mLastState))
10151	{
10152	/* the machine was powered off or saved when taking a snapshot, so
10153	* reset the mCurrentStateModified flag */
10154	mData->mCurrentStateModified = FALSE;
10155	opFlags \|= SaveSS_CurStateModified;
10156	}
10157
10158	rc = saveSnapshotSettings (mSnapshotData.mSnapshot, opFlags);
10159	}
10160
10161	if (aSuccess && SUCCEEDED (rc))
10162	{
10163	bool online = Global::IsOnline (mSnapshotData.mLastState);
10164
10165	/* associate old hard disks with the snapshot and do locking/unlocking*/
10166	fixupHardDisks(true /* aCommit */, online);
10167
10168	/* inform callbacks */
10169	mParent->onSnapshotTaken (mData->mUuid,
10170	mSnapshotData.mSnapshot->data().mId);
10171	}
10172	else
10173	{
10174	/* wait for the completion of the server progress (diff VDI creation) */
10175	/// @todo (dmik) later, we will definitely want to cancel it instead
10176	// (when the cancel function is implemented)
10177	mSnapshotData.mServerProgress->WaitForCompletion (-1);
10178
10179	/* delete all differencing hard disks created (this will also attach
10180	* their parents back by rolling back mHDData) */
10181	fixupHardDisks(false /* aCommit */);
10182
10183	/* delete the saved state file (it might have been already created) */
10184	if (mSnapshotData.mSnapshot->stateFilePath())
10185	RTFileDelete (Utf8Str (mSnapshotData.mSnapshot->stateFilePath()));
10186
10187	mSnapshotData.mSnapshot->uninit();
10188	}
10189
10190	/* clear out the snapshot data */
10191	mSnapshotData.mLastState = MachineState_Null;
10192	mSnapshotData.mSnapshot.setNull();
10193	mSnapshotData.mServerProgress.setNull();
10194
10195	/* uninitialize the combined progress (to remove it from the VBox collection) */
10196	if (!mSnapshotData.mCombinedProgress.isNull())
10197	{
10198	mSnapshotData.mCombinedProgress->uninit();
10199	mSnapshotData.mCombinedProgress.setNull();
10200	}
10201
10202	LogFlowThisFuncLeave();
10203	return rc;
10204	}
10205
10206	/**
10207	* Take snapshot task handler. Must be called only by
10208	* TakeSnapshotTask::handler()!
10209	*
10210	* The sole purpose of this task is to asynchronously create differencing VDIs
10211	* and copy the saved state file (when necessary). The VM process will wait for
10212	* this task to complete using the mSnapshotData.mServerProgress returned to it.
10213	*
10214	* @note Locks this object for writing.
10215	*/
10216	void SessionMachine::takeSnapshotHandler (TakeSnapshotTask & /* aTask */)
10217	{
10218	LogFlowThisFuncEnter();
10219
10220	AutoCaller autoCaller (this);
10221
10222	LogFlowThisFunc (("state=%d\n", autoCaller.state()));
10223	if (!autoCaller.isOk())
10224	{
10225	/* we might have been uninitialized because the session was accidentally
10226	* closed by the client, so don't assert */
10227	LogFlowThisFuncLeave();
10228	return;
10229	}
10230
10231	AutoWriteLock alock (this);
10232
10233	HRESULT rc = S_OK;
10234
10235	bool online = Global::IsOnline (mSnapshotData.mLastState);
10236
10237	LogFlowThisFunc (("Creating differencing hard disks (online=%d)...\n",
10238	online));
10239
10240	mHDData.backup();
10241
10242	/* create new differencing hard disks and attach them to this machine */
10243	rc = createImplicitDiffs (mUserData->mSnapshotFolderFull,
10244	mSnapshotData.mServerProgress,
10245	online);
10246
10247	if (SUCCEEDED (rc) && mSnapshotData.mLastState == MachineState_Saved)
10248	{
10249	Utf8Str stateFrom = mSSData->mStateFilePath;
10250	Utf8Str stateTo = mSnapshotData.mSnapshot->stateFilePath();
10251
10252	LogFlowThisFunc (("Copying the execution state from '%s' to '%s'...\n",
10253	stateFrom.raw(), stateTo.raw()));
10254
10255	mSnapshotData.mServerProgress->setNextOperation(Bstr(tr("Copying the execution state")),
10256	1); // weight
10257
10258	/* Leave the lock before a lengthy operation (mMachineState is
10259	* MachineState_Saving here) */
10260
10261	alock.leave();
10262
10263	/* copy the state file */
10264	int vrc = RTFileCopyEx (stateFrom, stateTo, 0, progressCallback,
10265	static_cast <Progress *> (mSnapshotData.mServerProgress));
10266
10267	alock.enter();
10268
10269	if (RT_FAILURE (vrc))
10270	rc = setError (E_FAIL,
10271	tr ("Could not copy the state file '%s' to '%s' (%Rrc)"),
10272	stateFrom.raw(), stateTo.raw(), vrc);
10273	}
10274
10275	/* we have to call endTakingSnapshot() ourselves if the snapshot was taken
10276	* offline because the VM process will not do it in this case
10277	*/
10278	if (!online)
10279	{
10280	LogFlowThisFunc (("Finalizing the taken snapshot (rc=%Rhrc)...\n", rc));
10281
10282	{
10283	ErrorInfoKeeper eik;
10284
10285	setMachineState (mSnapshotData.mLastState);
10286	updateMachineStateOnClient();
10287	}
10288
10289	/* finalize the progress after setting the state, for consistency */
10290	mSnapshotData.mServerProgress->notifyComplete (rc);
10291
10292	endTakingSnapshot (SUCCEEDED (rc));
10293	}
10294	else
10295	{
10296	mSnapshotData.mServerProgress->notifyComplete (rc);
10297	}
10298
10299	LogFlowThisFuncLeave();
10300	}
10301
10302	/**
10303	* Helper struct for SessionMachine::discardSnapshotHandler().
10304	*/
10305	struct HardDiskDiscardRec
10306	{
10307	HardDiskDiscardRec() : chain (NULL) {}
10308
10309	HardDiskDiscardRec (const ComObjPtr<HardDisk> &aHd,
10310	HardDisk::MergeChain *aChain = NULL)
10311	: hd (aHd), chain (aChain) {}
10312
10313	HardDiskDiscardRec (const ComObjPtr<HardDisk> &aHd,
10314	HardDisk::MergeChain *aChain,
10315	const ComObjPtr<HardDisk> &aReplaceHd,
10316	const ComObjPtr<HardDiskAttachment> &aReplaceHda,
10317	const Guid &aSnapshotId)
10318	: hd (aHd), chain (aChain)
10319	, replaceHd (aReplaceHd), replaceHda (aReplaceHda)
10320	, snapshotId (aSnapshotId) {}
10321
10322	ComObjPtr<HardDisk> hd;
10323	HardDisk::MergeChain *chain;
10324	/* these are for the replace hard disk case: */
10325	ComObjPtr<HardDisk> replaceHd;
10326	ComObjPtr<HardDiskAttachment> replaceHda;
10327	Guid snapshotId;
10328	};
10329
10330	typedef std::list <HardDiskDiscardRec> HardDiskDiscardRecList;
10331
10332	/**
10333	* Discard snapshot task handler. Must be called only by
10334	* DiscardSnapshotTask::handler()!
10335	*
10336	* When aTask.subTask is true, the associated progress object is left
10337	* uncompleted on success. On failure, the progress is marked as completed
10338	* regardless of this parameter.
10339	*
10340	* @note Locks mParent + this + child objects for writing!
10341	*/
10342	void SessionMachine::discardSnapshotHandler (DiscardSnapshotTask &aTask)
10343	{
10344	LogFlowThisFuncEnter();
10345
10346	AutoCaller autoCaller (this);
10347
10348	LogFlowThisFunc (("state=%d\n", autoCaller.state()));
10349	if (!autoCaller.isOk())
10350	{
10351	/* we might have been uninitialized because the session was accidentally
10352	* closed by the client, so don't assert */
10353	aTask.progress->notifyComplete (
10354	E_FAIL, COM_IIDOF (IMachine), getComponentName(),
10355	tr ("The session has been accidentally closed"));
10356
10357	LogFlowThisFuncLeave();
10358	return;
10359	}
10360
10361	/* saveSettings() needs mParent lock */
10362	AutoWriteLock vboxLock (mParent);
10363
10364	/* @todo We don't need mParent lock so far so unlock() it. Better is to
10365	* provide an AutoWriteLock argument that lets create a non-locking
10366	* instance */
10367	vboxLock.unlock();
10368
10369	/* Preseve the {parent, child} lock order for this and snapshot stuff */
10370	AutoMultiWriteLock3 alock (this->lockHandle(),
10371	aTask.snapshot->lockHandle(),
10372	aTask.snapshot->childrenLock());
10373
10374	ComObjPtr <SnapshotMachine> sm = aTask.snapshot->data().mMachine;
10375	/* no need to lock the snapshot machine since it is const by definiton */
10376
10377	HRESULT rc = S_OK;
10378
10379	/* save the snapshot ID (for callbacks) */
10380	Guid snapshotId = aTask.snapshot->data().mId;
10381
10382	HardDiskDiscardRecList toDiscard;
10383
10384	bool settingsChanged = false;
10385
10386	try
10387	{
10388	/* first pass: */
10389	LogFlowThisFunc (("1: Checking hard disk merge prerequisites...\n"));
10390
10391	for (HDData::AttachmentList::const_iterator it =
10392	sm->mHDData->mAttachments.begin();
10393	it != sm->mHDData->mAttachments.end();
10394	++ it)
10395	{
10396	ComObjPtr<HardDiskAttachment> hda = *it;
10397	ComObjPtr<HardDisk> hd = hda->hardDisk();
10398
10399	/* HardDisk::prepareDiscard() reqiuires a write lock */
10400	AutoWriteLock hdLock (hd);
10401
10402	if (hd->type() != HardDiskType_Normal)
10403	{
10404	/* skip writethrough hard disks */
10405
10406	Assert (hd->type() == HardDiskType_Writethrough);
10407
10408	rc = aTask.progress->setNextOperation(BstrFmt(tr("Skipping writethrough hard disk '%s'"),
10409	hd->root()->name().raw()),
10410	1); // weight
10411	CheckComRCThrowRC (rc);
10412
10413	continue;
10414	}
10415
10416	HardDisk::MergeChain *chain = NULL;
10417
10418	/* needs to be discarded (merged with the child if any), check
10419	* prerequisites */
10420	rc = hd->prepareDiscard (chain);
10421	CheckComRCThrowRC (rc);
10422
10423	if (hd->parent().isNull() && chain != NULL)
10424	{
10425	/* it's a base hard disk so it will be a backward merge of its
10426	* only child to it (prepareDiscard() does necessary checks). We
10427	* need then to update the attachment that refers to the child
10428	* to refer to the parent insead. Don't forget to detach the
10429	* child (otherwise mergeTo() called by discard() will assert
10430	* because it will be going to delete the child) */
10431
10432	/* The below assert would be nice but I don't want to move
10433	* HardDisk::MergeChain to the header just for that
10434	* Assert (!chain->isForward()); */
10435
10436	Assert (hd->children().size() == 1);
10437
10438	ComObjPtr<HardDisk> replaceHd = hd->children().front();
10439
10440	Assert (replaceHd->backRefs().front().machineId == mData->mUuid);
10441	Assert (replaceHd->backRefs().front().snapshotIds.size() <= 1);
10442
10443	Guid snapshotId;
10444	if (replaceHd->backRefs().front().snapshotIds.size() == 1)
10445	snapshotId = replaceHd->backRefs().front().snapshotIds.front();
10446
10447	HRESULT rc2 = S_OK;
10448
10449	/* adjust back references */
10450	rc2 = replaceHd->detachFrom (mData->mUuid, snapshotId);
10451	AssertComRC (rc2);
10452
10453	rc2 = hd->attachTo (mData->mUuid, snapshotId);
10454	AssertComRC (rc2);
10455
10456	/* replace the hard disk in the attachment object */
10457	HDData::AttachmentList::iterator it;
10458	if (snapshotId.isEmpty())
10459	{
10460	/* in current state */
10461	it = std::find_if (mHDData->mAttachments.begin(),
10462	mHDData->mAttachments.end(),
10463	HardDiskAttachment::RefersTo (replaceHd));
10464	AssertBreak (it != mHDData->mAttachments.end());
10465	}
10466	else
10467	{
10468	/* in snapshot */
10469	ComObjPtr <Snapshot> snapshot;
10470	rc2 = findSnapshot (snapshotId, snapshot);
10471	AssertComRC (rc2);
10472
10473	/* don't lock the snapshot; cannot be modified outside */
10474	HDData::AttachmentList &snapAtts =
10475	snapshot->data().mMachine->mHDData->mAttachments;
10476	it = std::find_if (snapAtts.begin(),
10477	snapAtts.end(),
10478	HardDiskAttachment::RefersTo (replaceHd));
10479	AssertBreak (it != snapAtts.end());
10480	}
10481
10482	AutoWriteLock attLock (*it);
10483	(it)->updateHardDisk (hd, false / aImplicit */);
10484
10485	toDiscard.push_back (HardDiskDiscardRec (hd, chain, replaceHd,
10486	*it, snapshotId));
10487	continue;
10488	}
10489
10490	toDiscard.push_back (HardDiskDiscardRec (hd, chain));
10491	}
10492
10493	/* Now we checked that we can successfully merge all normal hard disks
10494	* (unless a runtime error like end-of-disc happens). Prior to
10495	* performing the actual merge, we want to discard the snapshot itself
10496	* and remove it from the XML file to make sure that a possible merge
10497	* ruintime error will not make this snapshot inconsistent because of
10498	* the partially merged or corrupted hard disks */
10499
10500	/* second pass: */
10501	LogFlowThisFunc (("2: Discarding snapshot...\n"));
10502
10503	{
10504	/* for now, the snapshot must have only one child when discarded,
10505	* or no children at all */
10506	ComAssertThrow (aTask.snapshot->children().size() <= 1, E_FAIL);
10507
10508	ComObjPtr <Snapshot> parentSnapshot = aTask.snapshot->parent();
10509
10510	/// @todo (dmik):
10511	// when we introduce clones later, discarding the snapshot
10512	// will affect the current and first snapshots of clones, if they are
10513	// direct children of this snapshot. So we will need to lock machines
10514	// associated with child snapshots as well and update mCurrentSnapshot
10515	// and/or mFirstSnapshot fields.
10516
10517	if (aTask.snapshot == mData->mCurrentSnapshot)
10518	{
10519	/* currently, the parent snapshot must refer to the same machine */
10520	/// @todo NEWMEDIA not really clear why
10521	ComAssertThrow (
10522	!parentSnapshot \|\|
10523	parentSnapshot->data().mMachine->mData->mUuid == mData->mUuid,
10524	E_FAIL);
10525	mData->mCurrentSnapshot = parentSnapshot;
10526
10527	/* we've changed the base of the current state so mark it as
10528	* modified as it no longer guaranteed to be its copy */
10529	mData->mCurrentStateModified = TRUE;
10530	}
10531
10532	if (aTask.snapshot == mData->mFirstSnapshot)
10533	{
10534	if (aTask.snapshot->children().size() == 1)
10535	{
10536	ComObjPtr <Snapshot> childSnapshot =
10537	aTask.snapshot->children().front();
10538	ComAssertThrow (
10539	childSnapshot->data().mMachine->mData->mUuid == mData->mUuid,
10540	E_FAIL);
10541	mData->mFirstSnapshot = childSnapshot;
10542	}
10543	else
10544	mData->mFirstSnapshot.setNull();
10545	}
10546
10547	Bstr stateFilePath = aTask.snapshot->stateFilePath();
10548
10549	/* Note that discarding the snapshot will deassociate it from the
10550	* hard disks which will allow the merge+delete operation for them*/
10551	aTask.snapshot->discard();
10552
10553	rc = saveSnapshotSettings (parentSnapshot, SaveSS_UpdateAllOp \|
10554	SaveSS_CurrentId \|
10555	SaveSS_CurStateModified);
10556	CheckComRCThrowRC (rc);
10557
10558	/// @todo (dmik)
10559	// if we implement some warning mechanism later, we'll have
10560	// to return a warning if the state file path cannot be deleted
10561	if (stateFilePath)
10562	{
10563	aTask.progress->setNextOperation(Bstr(tr("Discarding the execution state")),
10564	1); // weight
10565
10566	RTFileDelete (Utf8Str (stateFilePath));
10567	}
10568
10569	/// @todo NEWMEDIA to provide a good level of fauilt tolerance, we
10570	/// should restore the shapshot in the snapshot tree if
10571	/// saveSnapshotSettings fails. Actually, we may call
10572	/// #saveSnapshotSettings() with a special flag that will tell it to
10573	/// skip the given snapshot as if it would have been discarded and
10574	/// only actually discard it if the save operation succeeds.
10575	}
10576
10577	/* here we come when we've irrevesibly discarded the snapshot which
10578	* means that the VM settigns (our relevant changes to mData) need to be
10579	* saved too */
10580	/// @todo NEWMEDIA maybe save everything in one operation in place of
10581	/// saveSnapshotSettings() above
10582	settingsChanged = true;
10583
10584	/* third pass: */
10585	LogFlowThisFunc (("3: Performing actual hard disk merging...\n"));
10586
10587	/* leave the locks before the potentially lengthy operation */
10588	alock.leave();
10589
10590	/// @todo NEWMEDIA turn the following errors into warnings because the
10591	/// snapshot itself has been already deleted (and interpret these
10592	/// warnings properly on the GUI side)
10593
10594	for (HardDiskDiscardRecList::iterator it = toDiscard.begin();
10595	it != toDiscard.end();)
10596	{
10597	rc = it->hd->discard (aTask.progress, it->chain);
10598	CheckComRCBreakRC (rc);
10599
10600	/* prevent from calling cancelDiscard() */
10601	it = toDiscard.erase (it);
10602	}
10603
10604	alock.enter();
10605
10606	CheckComRCThrowRC (rc);
10607	}
10608	catch (HRESULT aRC) { rc = aRC; }
10609
10610	if FAILED (rc)
10611	{
10612	HRESULT rc2 = S_OK;
10613
10614	/* un-prepare the remaining hard disks */
10615	for (HardDiskDiscardRecList::const_iterator it = toDiscard.begin();
10616	it != toDiscard.end(); ++ it)
10617	{
10618	it->hd->cancelDiscard (it->chain);
10619
10620	if (!it->replaceHd.isNull())
10621	{
10622	/* undo hard disk replacement */
10623
10624	rc2 = it->replaceHd->attachTo (mData->mUuid, it->snapshotId);
10625	AssertComRC (rc2);
10626
10627	rc2 = it->hd->detachFrom (mData->mUuid, it->snapshotId);
10628	AssertComRC (rc2);
10629
10630	AutoWriteLock attLock (it->replaceHda);
10631	it->replaceHda->updateHardDisk (it->replaceHd, false /* aImplicit */);
10632	}
10633	}
10634	}
10635
10636	if (!aTask.subTask \|\| FAILED (rc))
10637	{
10638	if (!aTask.subTask)
10639	{
10640	/* saveSettings() below needs a VirtualBox write lock and we need to
10641	* leave this object's lock to do this to follow the {parent-child}
10642	* locking rule. This is the last chance to do that while we are
10643	* still in a protective state which allows us to temporarily leave
10644	* the lock */
10645	alock.unlock();
10646	vboxLock.lock();
10647	alock.lock();
10648
10649	/* preserve existing error info */
10650	ErrorInfoKeeper eik;
10651
10652	/* restore the machine state */
10653	setMachineState (aTask.state);
10654	updateMachineStateOnClient();
10655
10656	if (settingsChanged)
10657	saveSettings (SaveS_InformCallbacksAnyway);
10658	}
10659
10660	/* set the result (this will try to fetch current error info on failure) */
10661	aTask.progress->notifyComplete (rc);
10662	}
10663
10664	if (SUCCEEDED (rc))
10665	mParent->onSnapshotDiscarded (mData->mUuid, snapshotId);
10666
10667	LogFlowThisFunc (("Done discarding snapshot (rc=%08X)\n", rc));
10668	LogFlowThisFuncLeave();
10669	}
10670
10671	/**
10672	* Discard current state task handler. Must be called only by
10673	* DiscardCurrentStateTask::handler()!
10674	*
10675	* @note Locks mParent + this object for writing.
10676	*/
10677	void SessionMachine::discardCurrentStateHandler (DiscardCurrentStateTask &aTask)
10678	{
10679	LogFlowThisFuncEnter();
10680
10681	AutoCaller autoCaller (this);
10682
10683	LogFlowThisFunc (("state=%d\n", autoCaller.state()));
10684	if (!autoCaller.isOk())
10685	{
10686	/* we might have been uninitialized because the session was accidentally
10687	* closed by the client, so don't assert */
10688	aTask.progress->notifyComplete (
10689	E_FAIL, COM_IIDOF (IMachine), getComponentName(),
10690	tr ("The session has been accidentally closed"));
10691
10692	LogFlowThisFuncLeave();
10693	return;
10694	}
10695
10696	/* saveSettings() needs mParent lock */
10697	AutoWriteLock vboxLock (mParent);
10698
10699	/* @todo We don't need mParent lock so far so unlock() it. Better is to
10700	* provide an AutoWriteLock argument that lets create a non-locking
10701	* instance */
10702	vboxLock.unlock();
10703
10704	AutoWriteLock alock (this);
10705
10706	/* discard all current changes to mUserData (name, OSType etc.) (note that
10707	* the machine is powered off, so there is no need to inform the direct
10708	* session) */
10709	if (isModified())
10710	rollback (false /* aNotify */);
10711
10712	HRESULT rc = S_OK;
10713
10714	bool errorInSubtask = false;
10715	bool stateRestored = false;
10716
10717	const bool isLastSnapshot = mData->mCurrentSnapshot->parent().isNull();
10718
10719	try
10720	{
10721	/* discard the saved state file if the machine was Saved prior to this
10722	* operation */
10723	if (aTask.state == MachineState_Saved)
10724	{
10725	Assert (!mSSData->mStateFilePath.isEmpty());
10726	RTFileDelete (Utf8Str (mSSData->mStateFilePath));
10727	mSSData->mStateFilePath.setNull();
10728	aTask.modifyLastState (MachineState_PoweredOff);
10729	rc = saveStateSettings (SaveSTS_StateFilePath);
10730	CheckComRCThrowRC (rc);
10731	}
10732
10733	if (aTask.discardCurrentSnapshot && !isLastSnapshot)
10734	{
10735	/* the "discard current snapshot and state" task is in action, the
10736	* current snapshot is not the last one. Discard the current
10737	* snapshot first */
10738
10739	DiscardSnapshotTask subTask (aTask, mData->mCurrentSnapshot);
10740	subTask.subTask = true;
10741	discardSnapshotHandler (subTask);
10742
10743	AutoCaller progressCaller (aTask.progress);
10744	AutoReadLock progressLock (aTask.progress);
10745	if (aTask.progress->completed())
10746	{
10747	/* the progress can be completed by a subtask only if there was
10748	* a failure */
10749	rc = aTask.progress->resultCode();
10750	Assert (FAILED (rc));
10751	errorInSubtask = true;
10752	throw rc;
10753	}
10754	}
10755
10756	RTTIMESPEC snapshotTimeStamp;
10757	RTTimeSpecSetMilli (&snapshotTimeStamp, 0);
10758
10759	{
10760	ComObjPtr <Snapshot> curSnapshot = mData->mCurrentSnapshot;
10761	AutoReadLock snapshotLock (curSnapshot);
10762
10763	/* remember the timestamp of the snapshot we're restoring from */
10764	snapshotTimeStamp = curSnapshot->data().mTimeStamp;
10765
10766	/* copy all hardware data from the current snapshot */
10767	copyFrom (curSnapshot->data().mMachine);
10768
10769	LogFlowThisFunc (("Restoring hard disks from the snapshot...\n"));
10770
10771	/* restore the attachmends from the snapshot */
10772	mHDData.backup();
10773	mHDData->mAttachments =
10774	curSnapshot->data().mMachine->mHDData->mAttachments;
10775
10776	/* leave the locks before the potentially lengthy operation */
10777	snapshotLock.unlock();
10778	alock.leave();
10779
10780	rc = createImplicitDiffs (mUserData->mSnapshotFolderFull,
10781	aTask.progress,
10782	false /* aOnline */);
10783
10784	alock.enter();
10785	snapshotLock.lock();
10786
10787	CheckComRCThrowRC (rc);
10788
10789	/* Note: on success, current (old) hard disks will be
10790	* deassociated/deleted on #commit() called from #saveSettings() at
10791	* the end. On failure, newly created implicit diffs will be
10792	* deleted by #rollback() at the end. */
10793
10794	/* should not have a saved state file associated at this point */
10795	Assert (mSSData->mStateFilePath.isNull());
10796
10797	if (curSnapshot->stateFilePath())
10798	{
10799	Utf8Str snapStateFilePath = curSnapshot->stateFilePath();
10800
10801	Utf8Str stateFilePath = Utf8StrFmt ("%ls%c{%RTuuid}.sav",
10802	mUserData->mSnapshotFolderFull.raw(),
10803	RTPATH_DELIMITER, mData->mUuid.raw());
10804
10805	LogFlowThisFunc (("Copying saved state file from '%s' to '%s'...\n",
10806	snapStateFilePath.raw(), stateFilePath.raw()));
10807
10808	aTask.progress->setNextOperation(Bstr(tr("Restoring the execution state")),
10809	1); // weight
10810
10811	/* leave the lock before the potentially lengthy operation */
10812	snapshotLock.unlock();
10813	alock.leave();
10814
10815	/* copy the state file */
10816	int vrc = RTFileCopyEx (snapStateFilePath, stateFilePath,
10817	0, progressCallback, aTask.progress);
10818
10819	alock.enter();
10820	snapshotLock.lock();
10821
10822	if (RT_SUCCESS (vrc))
10823	{
10824	mSSData->mStateFilePath = stateFilePath;
10825	}
10826	else
10827	{
10828	throw setError (E_FAIL,
10829	tr ("Could not copy the state file '%s' to '%s' (%Rrc)"),
10830	snapStateFilePath.raw(), stateFilePath.raw(), vrc);
10831	}
10832	}
10833	}
10834
10835	/* grab differencing hard disks from the old attachments that will
10836	* become unused and need to be auto-deleted */
10837
10838	std::list< ComObjPtr<HardDisk> > diffs;
10839
10840	for (HDData::AttachmentList::const_iterator
10841	it = mHDData.backedUpData()->mAttachments.begin();
10842	it != mHDData.backedUpData()->mAttachments.end(); ++ it)
10843	{
10844	ComObjPtr<HardDisk> hd = (*it)->hardDisk();
10845
10846	/* while the hard disk is attached, the number of children or the
10847	* parent cannot change, so no lock */
10848	if (!hd->parent().isNull() && hd->children().size() == 0)
10849	diffs.push_back (hd);
10850	}
10851
10852	int saveFlags = 0;
10853
10854	if (aTask.discardCurrentSnapshot && isLastSnapshot)
10855	{
10856	/* commit changes to have unused diffs deassociated from this
10857	* machine before deletion (see below) */
10858	commit();
10859
10860	/* delete the unused diffs now (and uninit them) because discard
10861	* may fail otherwise (too many children of the hard disk to be
10862	* discarded) */
10863	for (std::list< ComObjPtr<HardDisk> >::const_iterator
10864	it = diffs.begin(); it != diffs.end(); ++ it)
10865	{
10866	/// @todo for now, we ignore errors since we've already
10867	/// and therefore cannot fail. Later, we may want to report a
10868	/// warning through the Progress object
10869	HRESULT rc2 = (*it)->deleteStorageAndWait();
10870	if (SUCCEEDED (rc2))
10871	(*it)->uninit();
10872	}
10873
10874	/* prevent further deletion */
10875	diffs.clear();
10876
10877	/* discard the current snapshot and state task is in action, the
10878	* current snapshot is the last one. Discard the current snapshot
10879	* after discarding the current state. */
10880
10881	DiscardSnapshotTask subTask (aTask, mData->mCurrentSnapshot);
10882	subTask.subTask = true;
10883	discardSnapshotHandler (subTask);
10884
10885	AutoCaller progressCaller (aTask.progress);
10886	AutoReadLock progressLock (aTask.progress);
10887	if (aTask.progress->completed())
10888	{
10889	/* the progress can be completed by a subtask only if there
10890	* was a failure */
10891	rc = aTask.progress->resultCode();
10892	Assert (FAILED (rc));
10893	errorInSubtask = true;
10894	}
10895
10896	/* we've committed already, so inform callbacks anyway to ensure
10897	* they don't miss some change */
10898	/// @todo NEWMEDIA check if we need this informCallbacks at all
10899	/// after updating discardCurrentSnapshot functionality
10900	saveFlags \|= SaveS_InformCallbacksAnyway;
10901	}
10902
10903	/* @todo saveSettings() below needs a VirtualBox write lock and we need
10904	* to leave this object's lock to do this to follow the {parent-child}
10905	* locking rule. This is the last chance to do that while we are still
10906	* in a protective state which allows us to temporarily leave the lock*/
10907	alock.unlock();
10908	vboxLock.lock();
10909	alock.lock();
10910
10911	/* we have already discarded the current state, so set the execution
10912	* state accordingly no matter of the discard snapshot result */
10913	if (mSSData->mStateFilePath)
10914	setMachineState (MachineState_Saved);
10915	else
10916	setMachineState (MachineState_PoweredOff);
10917
10918	updateMachineStateOnClient();
10919	stateRestored = true;
10920
10921	/* assign the timestamp from the snapshot */
10922	Assert (RTTimeSpecGetMilli (&snapshotTimeStamp) != 0);
10923	mData->mLastStateChange = snapshotTimeStamp;
10924
10925	/* save all settings, reset the modified flag and commit. Note that we
10926	* do so even if the subtask failed (errorInSubtask=true) because we've
10927	* already committed machine data and deleted old diffs before
10928	* discarding the current snapshot so there is no way to rollback */
10929	HRESULT rc2 = saveSettings (SaveS_ResetCurStateModified \| saveFlags);
10930
10931	/// @todo NEWMEDIA return multiple errors
10932	if (errorInSubtask)
10933	throw rc;
10934
10935	rc = rc2;
10936
10937	if (SUCCEEDED (rc))
10938	{
10939	/* now, delete the unused diffs (only on success!) and uninit them*/
10940	for (std::list< ComObjPtr<HardDisk> >::const_iterator
10941	it = diffs.begin(); it != diffs.end(); ++ it)
10942	{
10943	/// @todo for now, we ignore errors since we've already
10944	/// discarded and therefore cannot fail. Later, we may want to
10945	/// report a warning through the Progress object
10946	HRESULT rc2 = (*it)->deleteStorageAndWait();
10947	if (SUCCEEDED (rc2))
10948	(*it)->uninit();
10949	}
10950	}
10951	}
10952	catch (HRESULT aRC) { rc = aRC; }
10953
10954	if (FAILED (rc))
10955	{
10956	/* preserve existing error info */
10957	ErrorInfoKeeper eik;
10958
10959	if (!errorInSubtask)
10960	{
10961	/* undo all changes on failure unless the subtask has done so */
10962	rollback (false /* aNotify */);
10963	}
10964
10965	if (!stateRestored)
10966	{
10967	/* restore the machine state */
10968	setMachineState (aTask.state);
10969	updateMachineStateOnClient();
10970	}
10971	}
10972
10973	if (!errorInSubtask)
10974	{
10975	/* set the result (this will try to fetch current error info on failure) */
10976	aTask.progress->notifyComplete (rc);
10977	}
10978
10979	if (SUCCEEDED (rc))
10980	mParent->onSnapshotDiscarded (mData->mUuid, Guid());
10981
10982	LogFlowThisFunc (("Done discarding current state (rc=%08X)\n", rc));
10983
10984	LogFlowThisFuncLeave();
10985	}
10986
10987	/**
10988	* Locks the attached media.
10989	*
10990	* All attached hard disks are locked for writing and DVD/floppy are locked for
10991	* reading. Parents of attached hard disks (if any) are locked for reading.
10992	*
10993	* This method also performs accessibility check of all media it locks: if some
10994	* media is inaccessible, the method will return a failure and a bunch of
10995	* extended error info objects per each inaccessible medium.
10996	*
10997	* Note that this method is atomic: if it returns a success, all media are
10998	* locked as described above; on failure no media is locked at all (all
10999	* succeeded individual locks will be undone).
11000	*
11001	* This method is intended to be called when the machine is in Starting or
11002	* Restoring state and asserts otherwise.
11003	*
11004	* The locks made by this method must be undone by calling #unlockMedia() when
11005	* no more needed.
11006	*/
11007	HRESULT SessionMachine::lockMedia()
11008	{
11009	AutoCaller autoCaller (this);
11010	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
11011
11012	AutoWriteLock alock (this);
11013
11014	AssertReturn (mData->mMachineState == MachineState_Starting \|\|
11015	mData->mMachineState == MachineState_Restoring, E_FAIL);
11016
11017	typedef std::list <ComPtr <IMedium> > MediaList;
11018	MediaList mediaToCheck;
11019	MediaState_T mediaState;
11020
11021	try
11022	{
11023	HRESULT rc = S_OK;
11024
11025	/* lock hard disks */
11026	for (HDData::AttachmentList::const_iterator it =
11027	mHDData->mAttachments.begin();
11028	it != mHDData->mAttachments.end(); ++ it)
11029	{
11030	ComObjPtr<HardDisk> hd = (*it)->hardDisk();
11031
11032	bool first = true;
11033
11034	/** @todo split out the media locking, and put it into
11035	* HardDiskImpl.cpp, as it needs this functionality too. */
11036	while (!hd.isNull())
11037	{
11038	if (first)
11039	{
11040	rc = hd->LockWrite (&mediaState);
11041	CheckComRCThrowRC (rc);
11042
11043	mData->mSession.mLockedMedia.push_back (
11044	Data::Session::LockedMedia::value_type (
11045	ComPtr <IHardDisk> (hd), true));
11046
11047	first = false;
11048	}
11049	else
11050	{
11051	rc = hd->LockRead (&mediaState);
11052	CheckComRCThrowRC (rc);
11053
11054	mData->mSession.mLockedMedia.push_back (
11055	Data::Session::LockedMedia::value_type (
11056	ComPtr <IHardDisk> (hd), false));
11057	}
11058
11059	if (mediaState == MediaState_Inaccessible)
11060	mediaToCheck.push_back (ComPtr <IHardDisk> (hd));
11061
11062	/* no locks or callers here since there should be no way to
11063	* change the hard disk parent at this point (as it is still
11064	* attached to the machine) */
11065	hd = hd->parent();
11066	}
11067	}
11068
11069	/* lock the DVD image for reading if mounted */
11070	{
11071	AutoReadLock driveLock (mDVDDrive);
11072	if (mDVDDrive->data()->state == DriveState_ImageMounted)
11073	{
11074	ComObjPtr <DVDImage> image = mDVDDrive->data()->image;
11075
11076	rc = image->LockRead (&mediaState);
11077	CheckComRCThrowRC (rc);
11078
11079	mData->mSession.mLockedMedia.push_back (
11080	Data::Session::LockedMedia::value_type (
11081	ComPtr <IDVDImage> (image), false));
11082
11083	if (mediaState == MediaState_Inaccessible)
11084	mediaToCheck.push_back (ComPtr <IDVDImage> (image));
11085	}
11086	}
11087
11088	/* lock the floppy image for reading if mounted */
11089	{
11090	AutoReadLock driveLock (mFloppyDrive);
11091	if (mFloppyDrive->data()->state == DriveState_ImageMounted)
11092	{
11093	ComObjPtr <FloppyImage> image = mFloppyDrive->data()->image;
11094
11095	rc = image->LockRead (&mediaState);
11096	CheckComRCThrowRC (rc);
11097
11098	mData->mSession.mLockedMedia.push_back (
11099	Data::Session::LockedMedia::value_type (
11100	ComPtr <IFloppyImage> (image), false));
11101
11102	if (mediaState == MediaState_Inaccessible)
11103	mediaToCheck.push_back (ComPtr <IFloppyImage> (image));
11104	}
11105	}
11106
11107	/* SUCCEEDED locking all media, now check accessibility */
11108
11109	ErrorInfoKeeper eik (true /* aIsNull */);
11110	MultiResult mrc (S_OK);
11111
11112	/* perform a check of inaccessible media deferred above */
11113	for (MediaList::const_iterator
11114	it = mediaToCheck.begin();
11115	it != mediaToCheck.end(); ++ it)
11116	{
11117	MediaState_T mediaState;
11118	rc = (*it)->COMGETTER(State) (&mediaState);
11119	CheckComRCThrowRC (rc);
11120
11121	Assert (mediaState == MediaState_LockedRead \|\|
11122	mediaState == MediaState_LockedWrite);
11123
11124	/* Note that we locked the medium already, so use the error
11125	* value to see if there was an accessibility failure */
11126
11127	Bstr error;
11128	rc = (*it)->COMGETTER(LastAccessError) (error.asOutParam());
11129	CheckComRCThrowRC (rc);
11130
11131	if (!error.isEmpty())
11132	{
11133	Bstr loc;
11134	rc = (*it)->COMGETTER(Location) (loc.asOutParam());
11135	CheckComRCThrowRC (rc);
11136
11137	/* collect multiple errors */
11138	eik.restore();
11139
11140	/* be in sync with MediumBase::setStateError() */
11141	Assert (!error.isEmpty());
11142	mrc = setError (E_FAIL,
11143	tr ("Medium '%ls' is not accessible. %ls"),
11144	loc.raw(), error.raw());
11145
11146	eik.fetch();
11147	}
11148	}
11149
11150	eik.restore();
11151	CheckComRCThrowRC ((HRESULT) mrc);
11152	}
11153	catch (HRESULT aRC)
11154	{
11155	/* Unlock all locked media on failure */
11156	unlockMedia();
11157	return aRC;
11158	}
11159
11160	return S_OK;
11161	}
11162
11163	/**
11164	* Undoes the locks made by by #lockMedia().
11165	*/
11166	void SessionMachine::unlockMedia()
11167	{
11168	AutoCaller autoCaller (this);
11169	AssertComRCReturnVoid (autoCaller.rc());
11170
11171	AutoWriteLock alock (this);
11172
11173	/* we may be holding important error info on the current thread;
11174	* preserve it */
11175	ErrorInfoKeeper eik;
11176
11177	HRESULT rc = S_OK;
11178
11179	for (Data::Session::LockedMedia::const_iterator
11180	it = mData->mSession.mLockedMedia.begin();
11181	it != mData->mSession.mLockedMedia.end(); ++ it)
11182	{
11183	MediaState_T state;
11184	if (it->second)
11185	rc = it->first->UnlockWrite (&state);
11186	else
11187	rc = it->first->UnlockRead (&state);
11188
11189	/* The second can happen if an object was re-locked in
11190	* Machine::fixupHardDisks(). The last can happen when e.g a DVD/Floppy
11191	* image was unmounted at runtime. */
11192	Assert (SUCCEEDED (rc) \|\| state == MediaState_LockedRead \|\| state == MediaState_Created);
11193	}
11194
11195	mData->mSession.mLockedMedia.clear();
11196	}
11197
11198	/**
11199	* Helper to change the machine state (reimplementation).
11200	*
11201	* @note Locks this object for writing.
11202	*/
11203	HRESULT SessionMachine::setMachineState (MachineState_T aMachineState)
11204	{
11205	LogFlowThisFuncEnter();
11206	LogFlowThisFunc (("aMachineState=%d\n", aMachineState));
11207
11208	AutoCaller autoCaller (this);
11209	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
11210
11211	AutoWriteLock alock (this);
11212
11213	MachineState_T oldMachineState = mData->mMachineState;
11214
11215	AssertMsgReturn (oldMachineState != aMachineState,
11216	("oldMachineState=%d, aMachineState=%d\n",
11217	oldMachineState, aMachineState), E_FAIL);
11218
11219	HRESULT rc = S_OK;
11220
11221	int stsFlags = 0;
11222	bool deleteSavedState = false;
11223
11224	/* detect some state transitions */
11225
11226	if ((oldMachineState == MachineState_Saved &&
11227	aMachineState == MachineState_Restoring) \|\|
11228	(oldMachineState < MachineState_Running /* any other OFF state */ &&
11229	aMachineState == MachineState_Starting))
11230	{
11231	/* The EMT thread is about to start */
11232
11233	/* Nothing to do here for now... */
11234
11235	/// @todo NEWMEDIA don't let mDVDDrive and other children
11236	/// change anything when in the Starting/Restoring state
11237	}
11238	else
11239	if (oldMachineState >= MachineState_Running &&
11240	oldMachineState != MachineState_Discarding &&
11241	oldMachineState != MachineState_SettingUp &&
11242	aMachineState < MachineState_Running &&
11243	/* ignore PoweredOff->Saving->PoweredOff transition when taking a
11244	* snapshot */
11245	(mSnapshotData.mSnapshot.isNull() \|\|
11246	mSnapshotData.mLastState >= MachineState_Running))
11247	{
11248	/* The EMT thread has just stopped, unlock attached media. Note that as
11249	* opposed to locking that is done from Console, we do unlocking here
11250	* because the VM process may have aborted before having a chance to
11251	* properly unlock all media it locked. */
11252
11253	unlockMedia();
11254	}
11255
11256	if (oldMachineState == MachineState_Restoring)
11257	{
11258	if (aMachineState != MachineState_Saved)
11259	{
11260	/*
11261	* delete the saved state file once the machine has finished
11262	* restoring from it (note that Console sets the state from
11263	* Restoring to Saved if the VM couldn't restore successfully,
11264	* to give the user an ability to fix an error and retry --
11265	* we keep the saved state file in this case)
11266	*/
11267	deleteSavedState = true;
11268	}
11269	}
11270	else
11271	if (oldMachineState == MachineState_Saved &&
11272	(aMachineState == MachineState_PoweredOff \|\|
11273	aMachineState == MachineState_Aborted))
11274	{
11275	/*
11276	* delete the saved state after Console::DiscardSavedState() is called
11277	* or if the VM process (owning a direct VM session) crashed while the
11278	* VM was Saved
11279	*/
11280
11281	/// @todo (dmik)
11282	// Not sure that deleting the saved state file just because of the
11283	// client death before it attempted to restore the VM is a good
11284	// thing. But when it crashes we need to go to the Aborted state
11285	// which cannot have the saved state file associated... The only
11286	// way to fix this is to make the Aborted condition not a VM state
11287	// but a bool flag: i.e., when a crash occurs, set it to true and
11288	// change the state to PoweredOff or Saved depending on the
11289	// saved state presence.
11290
11291	deleteSavedState = true;
11292	mData->mCurrentStateModified = TRUE;
11293	stsFlags \|= SaveSTS_CurStateModified;
11294	}
11295
11296	if (aMachineState == MachineState_Starting \|\|
11297	aMachineState == MachineState_Restoring)
11298	{
11299	/* set the current state modified flag to indicate that the current
11300	* state is no more identical to the state in the
11301	* current snapshot */
11302	if (!mData->mCurrentSnapshot.isNull())
11303	{
11304	mData->mCurrentStateModified = TRUE;
11305	stsFlags \|= SaveSTS_CurStateModified;
11306	}
11307	}
11308
11309	if (deleteSavedState)
11310	{
11311	if (mRemoveSavedState)
11312	{
11313	Assert (!mSSData->mStateFilePath.isEmpty());
11314	RTFileDelete (Utf8Str (mSSData->mStateFilePath));
11315	}
11316	mSSData->mStateFilePath.setNull();
11317	stsFlags \|= SaveSTS_StateFilePath;
11318	}
11319
11320	/* redirect to the underlying peer machine */
11321	mPeer->setMachineState (aMachineState);
11322
11323	if (aMachineState == MachineState_PoweredOff \|\|
11324	aMachineState == MachineState_Aborted \|\|
11325	aMachineState == MachineState_Saved)
11326	{
11327	/* the machine has stopped execution
11328	* (or the saved state file was adopted) */
11329	stsFlags \|= SaveSTS_StateTimeStamp;
11330	}
11331
11332	if ((oldMachineState == MachineState_PoweredOff \|\|
11333	oldMachineState == MachineState_Aborted) &&
11334	aMachineState == MachineState_Saved)
11335	{
11336	/* the saved state file was adopted */
11337	Assert (!mSSData->mStateFilePath.isNull());
11338	stsFlags \|= SaveSTS_StateFilePath;
11339	}
11340
11341	rc = saveStateSettings (stsFlags);
11342
11343	if ((oldMachineState != MachineState_PoweredOff &&
11344	oldMachineState != MachineState_Aborted) &&
11345	(aMachineState == MachineState_PoweredOff \|\|
11346	aMachineState == MachineState_Aborted))
11347	{
11348	/* we've been shut down for any reason */
11349	/* no special action so far */
11350	}
11351
11352	LogFlowThisFunc (("rc=%08X\n", rc));
11353	LogFlowThisFuncLeave();
11354	return rc;
11355	}
11356
11357	/**
11358	* Sends the current machine state value to the VM process.
11359	*
11360	* @note Locks this object for reading, then calls a client process.
11361	*/
11362	HRESULT SessionMachine::updateMachineStateOnClient()
11363	{
11364	AutoCaller autoCaller (this);
11365	AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
11366
11367	ComPtr <IInternalSessionControl> directControl;
11368	{
11369	AutoReadLock alock (this);
11370	AssertReturn (!!mData, E_FAIL);
11371	directControl = mData->mSession.mDirectControl;
11372
11373	/* directControl may be already set to NULL here in #OnSessionEnd()
11374	* called too early by the direct session process while there is still
11375	* some operation (like discarding the snapshot) in progress. The client
11376	* process in this case is waiting inside Session::close() for the
11377	* "end session" process object to complete, while #uninit() called by
11378	* #checkForDeath() on the Watcher thread is waiting for the pending
11379	* operation to complete. For now, we accept this inconsitent behavior
11380	* and simply do nothing here. */
11381
11382	if (mData->mSession.mState == SessionState_Closing)
11383	return S_OK;
11384
11385	AssertReturn (!directControl.isNull(), E_FAIL);
11386	}
11387
11388	return directControl->UpdateMachineState (mData->mMachineState);
11389	}
11390
11391	/* static */
11392	DECLCALLBACK(int) SessionMachine::taskHandler (RTTHREAD /* thread /, void pvUser)
11393	{
11394	AssertReturn (pvUser, VERR_INVALID_POINTER);
11395
11396	Task task = static_cast <Task > (pvUser);
11397	task->handler();
11398
11399	// it's our responsibility to delete the task
11400	delete task;
11401
11402	return 0;
11403	}
11404
11405	/////////////////////////////////////////////////////////////////////////////
11406	// SnapshotMachine class
11407	/////////////////////////////////////////////////////////////////////////////
11408
11409	DEFINE_EMPTY_CTOR_DTOR (SnapshotMachine)
11410
11411	HRESULT SnapshotMachine::FinalConstruct()
11412	{
11413	LogFlowThisFunc (("\n"));
11414
11415	/* set the proper type to indicate we're the SnapshotMachine instance */
11416	unconst (mType) = IsSnapshotMachine;
11417
11418	return S_OK;
11419	}
11420
11421	void SnapshotMachine::FinalRelease()
11422	{
11423	LogFlowThisFunc (("\n"));
11424
11425	uninit();
11426	}
11427
11428	/**
11429	* Initializes the SnapshotMachine object when taking a snapshot.
11430	*
11431	* @param aSessionMachine machine to take a snapshot from
11432	* @param aSnapshotId snapshot ID of this snapshot machine
11433	* @param aStateFilePath file where the execution state will be later saved
11434	* (or NULL for the offline snapshot)
11435	*
11436	* @note The aSessionMachine must be locked for writing.
11437	*/
11438	HRESULT SnapshotMachine::init (SessionMachine *aSessionMachine,
11439	IN_GUID aSnapshotId,
11440	IN_BSTR aStateFilePath)
11441	{
11442	LogFlowThisFuncEnter();
11443	LogFlowThisFunc (("mName={%ls}\n", aSessionMachine->mUserData->mName.raw()));
11444
11445	AssertReturn (aSessionMachine && !Guid (aSnapshotId).isEmpty(), E_INVALIDARG);
11446
11447	/* Enclose the state transition NotReady->InInit->Ready */
11448	AutoInitSpan autoInitSpan (this);
11449	AssertReturn (autoInitSpan.isOk(), E_FAIL);
11450
11451	AssertReturn (aSessionMachine->isWriteLockOnCurrentThread(), E_FAIL);
11452
11453	mSnapshotId = aSnapshotId;
11454
11455	/* memorize the primary Machine instance (i.e. not SessionMachine!) */
11456	unconst (mPeer) = aSessionMachine->mPeer;
11457	/* share the parent pointer */
11458	unconst (mParent) = mPeer->mParent;
11459
11460	/* take the pointer to Data to share */
11461	mData.share (mPeer->mData);
11462
11463	/* take the pointer to UserData to share (our UserData must always be the
11464	* same as Machine's data) */
11465	mUserData.share (mPeer->mUserData);
11466	/* make a private copy of all other data (recent changes from SessionMachine) */
11467	mHWData.attachCopy (aSessionMachine->mHWData);
11468	mHDData.attachCopy (aSessionMachine->mHDData);
11469
11470	/* SSData is always unique for SnapshotMachine */
11471	mSSData.allocate();
11472	mSSData->mStateFilePath = aStateFilePath;
11473
11474	HRESULT rc = S_OK;
11475
11476	/* create copies of all shared folders (mHWData after attiching a copy
11477	* contains just references to original objects) */
11478	for (HWData::SharedFolderList::iterator
11479	it = mHWData->mSharedFolders.begin();
11480	it != mHWData->mSharedFolders.end();
11481	++ it)
11482	{
11483	ComObjPtr <SharedFolder> folder;
11484	folder.createObject();
11485	rc = folder->initCopy (this, *it);
11486	CheckComRCReturnRC (rc);
11487	*it = folder;
11488	}
11489
11490	/* associate hard disks with the snapshot
11491	* (Machine::uninitDataAndChildObjects() will deassociate at destruction) */
11492	for (HDData::AttachmentList::const_iterator
11493	it = mHDData->mAttachments.begin();
11494	it != mHDData->mAttachments.end();
11495	++ it)
11496	{
11497	rc = (*it)->hardDisk()->attachTo (mData->mUuid, mSnapshotId);
11498	AssertComRC (rc);
11499	}
11500
11501	/* create copies of all storage controllers (mStorageControllerData
11502	* after attaching a copy contains just references to original objects) */
11503	mStorageControllers.allocate();
11504	for (StorageControllerList::const_iterator
11505	it = aSessionMachine->mStorageControllers->begin();
11506	it != aSessionMachine->mStorageControllers->end();
11507	++ it)
11508	{
11509	ComObjPtr <StorageController> ctrl;
11510	ctrl.createObject();
11511	ctrl->initCopy (this, *it);
11512	mStorageControllers->push_back(ctrl);
11513	}
11514
11515	/* create all other child objects that will be immutable private copies */
11516
11517	unconst (mBIOSSettings).createObject();
11518	mBIOSSettings->initCopy (this, mPeer->mBIOSSettings);
11519
11520	#ifdef VBOX_WITH_VRDP
11521	unconst (mVRDPServer).createObject();
11522	mVRDPServer->initCopy (this, mPeer->mVRDPServer);
11523	#endif
11524
11525	unconst (mDVDDrive).createObject();
11526	mDVDDrive->initCopy (this, mPeer->mDVDDrive);
11527
11528	unconst (mFloppyDrive).createObject();
11529	mFloppyDrive->initCopy (this, mPeer->mFloppyDrive);
11530
11531	unconst (mAudioAdapter).createObject();
11532	mAudioAdapter->initCopy (this, mPeer->mAudioAdapter);
11533
11534	unconst (mUSBController).createObject();
11535	mUSBController->initCopy (this, mPeer->mUSBController);
11536
11537	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
11538	{
11539	unconst (mNetworkAdapters [slot]).createObject();
11540	mNetworkAdapters [slot]->initCopy (this, mPeer->mNetworkAdapters [slot]);
11541	}
11542
11543	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
11544	{
11545	unconst (mSerialPorts [slot]).createObject();
11546	mSerialPorts [slot]->initCopy (this, mPeer->mSerialPorts [slot]);
11547	}
11548
11549	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
11550	{
11551	unconst (mParallelPorts [slot]).createObject();
11552	mParallelPorts [slot]->initCopy (this, mPeer->mParallelPorts [slot]);
11553	}
11554
11555	/* Confirm a successful initialization when it's the case */
11556	autoInitSpan.setSucceeded();
11557
11558	LogFlowThisFuncLeave();
11559	return S_OK;
11560	}
11561
11562	/**
11563	* Initializes the SnapshotMachine object when loading from the settings file.
11564	*
11565	* @param aMachine machine the snapshot belngs to
11566	* @param aHWNode <Hardware> node
11567	* @param aHDAsNode <HardDiskAttachments> node
11568	* @param aSnapshotId snapshot ID of this snapshot machine
11569	* @param aStateFilePath file where the execution state is saved
11570	* (or NULL for the offline snapshot)
11571	*
11572	* @note Doesn't lock anything.
11573	*/
11574	HRESULT SnapshotMachine::init (Machine *aMachine,
11575	const settings::Key &aHWNode,
11576	const settings::Key &aHDAsNode,
11577	IN_GUID aSnapshotId, IN_BSTR aStateFilePath)
11578	{
11579	LogFlowThisFuncEnter();
11580	LogFlowThisFunc (("mName={%ls}\n", aMachine->mUserData->mName.raw()));
11581
11582	AssertReturn (aMachine && !aHWNode.isNull() && !aHDAsNode.isNull() &&
11583	!Guid (aSnapshotId).isEmpty(),
11584	E_INVALIDARG);
11585
11586	/* Enclose the state transition NotReady->InInit->Ready */
11587	AutoInitSpan autoInitSpan (this);
11588	AssertReturn (autoInitSpan.isOk(), E_FAIL);
11589
11590	/* Don't need to lock aMachine when VirtualBox is starting up */
11591
11592	mSnapshotId = aSnapshotId;
11593
11594	/* memorize the primary Machine instance */
11595	unconst (mPeer) = aMachine;
11596	/* share the parent pointer */
11597	unconst (mParent) = mPeer->mParent;
11598
11599	/* take the pointer to Data to share */
11600	mData.share (mPeer->mData);
11601	/*
11602	* take the pointer to UserData to share
11603	* (our UserData must always be the same as Machine's data)
11604	*/
11605	mUserData.share (mPeer->mUserData);
11606	/* allocate private copies of all other data (will be loaded from settings) */
11607	mHWData.allocate();
11608	mHDData.allocate();
11609	mStorageControllers.allocate();
11610
11611	/* SSData is always unique for SnapshotMachine */
11612	mSSData.allocate();
11613	mSSData->mStateFilePath = aStateFilePath;
11614
11615	/* create all other child objects that will be immutable private copies */
11616
11617	unconst (mBIOSSettings).createObject();
11618	mBIOSSettings->init (this);
11619
11620	#ifdef VBOX_WITH_VRDP
11621	unconst (mVRDPServer).createObject();
11622	mVRDPServer->init (this);
11623	#endif
11624
11625	unconst (mDVDDrive).createObject();
11626	mDVDDrive->init (this);
11627
11628	unconst (mFloppyDrive).createObject();
11629	mFloppyDrive->init (this);
11630
11631	unconst (mAudioAdapter).createObject();
11632	mAudioAdapter->init (this);
11633
11634	unconst (mUSBController).createObject();
11635	mUSBController->init (this);
11636
11637	for (ULONG slot = 0; slot < RT_ELEMENTS (mNetworkAdapters); slot ++)
11638	{
11639	unconst (mNetworkAdapters [slot]).createObject();
11640	mNetworkAdapters [slot]->init (this, slot);
11641	}
11642
11643	for (ULONG slot = 0; slot < RT_ELEMENTS (mSerialPorts); slot ++)
11644	{
11645	unconst (mSerialPorts [slot]).createObject();
11646	mSerialPorts [slot]->init (this, slot);
11647	}
11648
11649	for (ULONG slot = 0; slot < RT_ELEMENTS (mParallelPorts); slot ++)
11650	{
11651	unconst (mParallelPorts [slot]).createObject();
11652	mParallelPorts [slot]->init (this, slot);
11653	}
11654
11655	/* load hardware and harddisk settings */
11656
11657	HRESULT rc = loadHardware (aHWNode);
11658	if (SUCCEEDED (rc))
11659	rc = loadStorageControllers (aHDAsNode, true /* aRegistered */, &mSnapshotId);
11660
11661	if (SUCCEEDED (rc))
11662	{
11663	/* commit all changes made during the initialization */
11664	commit();
11665	}
11666
11667	/* Confirm a successful initialization when it's the case */
11668	if (SUCCEEDED (rc))
11669	autoInitSpan.setSucceeded();
11670
11671	LogFlowThisFuncLeave();
11672	return rc;
11673	}
11674
11675	/**
11676	* Uninitializes this SnapshotMachine object.
11677	*/
11678	void SnapshotMachine::uninit()
11679	{
11680	LogFlowThisFuncEnter();
11681
11682	/* Enclose the state transition Ready->InUninit->NotReady */
11683	AutoUninitSpan autoUninitSpan (this);
11684	if (autoUninitSpan.uninitDone())
11685	return;
11686
11687	uninitDataAndChildObjects();
11688
11689	/* free the essential data structure last */
11690	mData.free();
11691
11692	unconst (mParent).setNull();
11693	unconst (mPeer).setNull();
11694
11695	LogFlowThisFuncLeave();
11696	}
11697
11698	// util::Lockable interface
11699	////////////////////////////////////////////////////////////////////////////////
11700
11701	/**
11702	* Overrides VirtualBoxBase::lockHandle() in order to share the lock handle
11703	* with the primary Machine instance (mPeer).
11704	*/
11705	RWLockHandle *SnapshotMachine::lockHandle() const
11706	{
11707	AssertReturn (!mPeer.isNull(), NULL);
11708	return mPeer->lockHandle();
11709	}
11710
11711	// public methods only for internal purposes
11712	////////////////////////////////////////////////////////////////////////////////
11713
11714	/**
11715	* Called by the snapshot object associated with this SnapshotMachine when
11716	* snapshot data such as name or description is changed.
11717	*
11718	* @note Locks this object for writing.
11719	*/
11720	HRESULT SnapshotMachine::onSnapshotChange (Snapshot *aSnapshot)
11721	{
11722	AutoWriteLock alock (this);
11723
11724	mPeer->saveSnapshotSettings (aSnapshot, SaveSS_UpdateAttrsOp);
11725
11726	/* inform callbacks */
11727	mParent->onSnapshotChange (mData->mUuid, aSnapshot->data().mId);
11728
11729	return S_OK;
11730	}
11731	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/MachineImpl.cpp@ 21077

Download in other formats: