MachineImpl.cpp@ 12020

Last change on this file since 12020 was 12020, checked in by vboxsync, 16 years ago
Nested paging support activated; default changed to false
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 341.4 KB

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

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

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

Download in other formats: