VirtualBox

source: vbox/trunk/src/VBox/Main/src-server/MachineImpl.cpp@ 57134

Last change on this file since 57134 was 57134, checked in by vboxsync, 10 years ago

Main/Machine: fix session state checking helpers (properly distinguishing "only VM sessions" from "all sessions"), to hopefully fix the Windows session crash detection
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 509.9 KB
Line 
1/* $Id: MachineImpl.cpp 57134 2015-07-30 17:56:59Z vboxsync $ */
2/** @file
3 * Implementation of IMachine in VBoxSVC.
4 */
5
6/*
7 * Copyright (C) 2004-2015 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.215389.xyz. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18/* Make sure all the stdint.h macros are included - must come first! */
19#ifndef __STDC_LIMIT_MACROS
20# define __STDC_LIMIT_MACROS
21#endif
22#ifndef __STDC_CONSTANT_MACROS
23# define __STDC_CONSTANT_MACROS
24#endif
25
26#include "Logging.h"
27#include "VirtualBoxImpl.h"
28#include "MachineImpl.h"
29#include "ClientToken.h"
30#include "ProgressImpl.h"
31#include "ProgressProxyImpl.h"
32#include "MediumAttachmentImpl.h"
33#include "MediumImpl.h"
34#include "MediumLock.h"
35#include "USBControllerImpl.h"
36#include "USBDeviceFiltersImpl.h"
37#include "HostImpl.h"
38#include "SharedFolderImpl.h"
39#include "GuestOSTypeImpl.h"
40#include "VirtualBoxErrorInfoImpl.h"
41#include "StorageControllerImpl.h"
42#include "DisplayImpl.h"
43#include "DisplayUtils.h"
44#include "MachineImplCloneVM.h"
45#include "AutostartDb.h"
46#include "SystemPropertiesImpl.h"
47
48// generated header
49#include "VBoxEvents.h"
50
51#ifdef VBOX_WITH_USB
52# include "USBProxyService.h"
53#endif
54
55#include "AutoCaller.h"
56#include "HashedPw.h"
57#include "Performance.h"
58
59#include <iprt/asm.h>
60#include <iprt/path.h>
61#include <iprt/dir.h>
62#include <iprt/env.h>
63#include <iprt/lockvalidator.h>
64#include <iprt/process.h>
65#include <iprt/cpp/utils.h>
66#include <iprt/cpp/xml.h> /* xml::XmlFileWriter::s_psz*Suff. */
67#include <iprt/sha.h>
68#include <iprt/string.h>
69#include <iprt/base64.h>
70
71#include <VBox/com/array.h>
72#include <VBox/com/list.h>
73
74#include <VBox/err.h>
75#include <VBox/param.h>
76#include <VBox/settings.h>
77#include <VBox/vmm/ssm.h>
78
79#ifdef VBOX_WITH_GUEST_PROPS
80# include <VBox/HostServices/GuestPropertySvc.h>
81# include <VBox/com/array.h>
82#endif
83
84#include "VBox/com/MultiResult.h"
85
86#include <algorithm>
87
88#ifdef VBOX_WITH_DTRACE_R3_MAIN
89# include "dtrace/VBoxAPI.h"
90#endif
91
92#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
93# define HOSTSUFF_EXE ".exe"
94#else /* !RT_OS_WINDOWS */
95# define HOSTSUFF_EXE ""
96#endif /* !RT_OS_WINDOWS */
97
98// defines / prototypes
99/////////////////////////////////////////////////////////////////////////////
100
101/////////////////////////////////////////////////////////////////////////////
102// Machine::Data structure
103/////////////////////////////////////////////////////////////////////////////
104
105Machine::Data::Data()
106{
107 mRegistered = FALSE;
108 pMachineConfigFile = NULL;
109 /* Contains hints on what has changed when the user is using the VM (config
110 * changes, running the VM, ...). This is used to decide if a config needs
111 * to be written to disk. */
112 flModifications = 0;
113 /* VM modification usually also trigger setting the current state to
114 * "Modified". Although this is not always the case. An e.g. is the VM
115 * initialization phase or when snapshot related data is changed. The
116 * actually behavior is controlled by the following flag. */
117 m_fAllowStateModification = false;
118 mAccessible = FALSE;
119 /* mUuid is initialized in Machine::init() */
120
121 mMachineState = MachineState_PoweredOff;
122 RTTimeNow(&mLastStateChange);
123
124 mMachineStateDeps = 0;
125 mMachineStateDepsSem = NIL_RTSEMEVENTMULTI;
126 mMachineStateChangePending = 0;
127
128 mCurrentStateModified = TRUE;
129 mGuestPropertiesModified = FALSE;
130
131 mSession.mPID = NIL_RTPROCESS;
132 mSession.mLockType = LockType_Null;
133 mSession.mState = SessionState_Unlocked;
134}
135
136Machine::Data::~Data()
137{
138 if (mMachineStateDepsSem != NIL_RTSEMEVENTMULTI)
139 {
140 RTSemEventMultiDestroy(mMachineStateDepsSem);
141 mMachineStateDepsSem = NIL_RTSEMEVENTMULTI;
142 }
143 if (pMachineConfigFile)
144 {
145 delete pMachineConfigFile;
146 pMachineConfigFile = NULL;
147 }
148}
149
150/////////////////////////////////////////////////////////////////////////////
151// Machine::HWData structure
152/////////////////////////////////////////////////////////////////////////////
153
154Machine::HWData::HWData()
155{
156 /* default values for a newly created machine */
157 mHWVersion = "2"; /** @todo get the default from the schema if that is possible. */
158 mMemorySize = 128;
159 mCPUCount = 1;
160 mCPUHotPlugEnabled = false;
161 mMemoryBalloonSize = 0;
162 mPageFusionEnabled = false;
163 mGraphicsControllerType = GraphicsControllerType_VBoxVGA;
164 mVRAMSize = 8;
165 mAccelerate3DEnabled = false;
166 mAccelerate2DVideoEnabled = false;
167 mMonitorCount = 1;
168 mVideoCaptureWidth = 1024;
169 mVideoCaptureHeight = 768;
170 mVideoCaptureRate = 512;
171 mVideoCaptureFPS = 25;
172 mVideoCaptureMaxTime = 0;
173 mVideoCaptureMaxFileSize = 0;
174 mVideoCaptureEnabled = false;
175 for (unsigned i = 0; i < RT_ELEMENTS(maVideoCaptureScreens); ++i)
176 maVideoCaptureScreens[i] = true;
177
178 mHWVirtExEnabled = true;
179 mHWVirtExNestedPagingEnabled = true;
180#if HC_ARCH_BITS == 64 && !defined(RT_OS_LINUX)
181 mHWVirtExLargePagesEnabled = true;
182#else
183 /* Not supported on 32 bits hosts. */
184 mHWVirtExLargePagesEnabled = false;
185#endif
186 mHWVirtExVPIDEnabled = true;
187 mHWVirtExUXEnabled = true;
188 mHWVirtExForceEnabled = false;
189#if HC_ARCH_BITS == 64 || defined(RT_OS_WINDOWS) || defined(RT_OS_DARWIN)
190 mPAEEnabled = true;
191#else
192 mPAEEnabled = false;
193#endif
194 mLongMode = HC_ARCH_BITS == 64 ? settings::Hardware::LongMode_Enabled : settings::Hardware::LongMode_Disabled;
195 mTripleFaultReset = false;
196 mHPETEnabled = false;
197 mCpuExecutionCap = 100; /* Maximum CPU execution cap by default. */
198 mCpuIdPortabilityLevel = 0;
199
200 /* default boot order: floppy - DVD - HDD */
201 mBootOrder[0] = DeviceType_Floppy;
202 mBootOrder[1] = DeviceType_DVD;
203 mBootOrder[2] = DeviceType_HardDisk;
204 for (size_t i = 3; i < RT_ELEMENTS(mBootOrder); ++i)
205 mBootOrder[i] = DeviceType_Null;
206
207 mClipboardMode = ClipboardMode_Disabled;
208 mDnDMode = DnDMode_Disabled;
209
210 mFirmwareType = FirmwareType_BIOS;
211 mKeyboardHIDType = KeyboardHIDType_PS2Keyboard;
212 mPointingHIDType = PointingHIDType_PS2Mouse;
213 mChipsetType = ChipsetType_PIIX3;
214 mParavirtProvider = ParavirtProvider_Default;
215 mEmulatedUSBCardReaderEnabled = FALSE;
216
217 for (size_t i = 0; i < RT_ELEMENTS(mCPUAttached); ++i)
218 mCPUAttached[i] = false;
219
220 mIOCacheEnabled = true;
221 mIOCacheSize = 5; /* 5MB */
222}
223
224Machine::HWData::~HWData()
225{
226}
227
228/////////////////////////////////////////////////////////////////////////////
229// Machine::HDData structure
230/////////////////////////////////////////////////////////////////////////////
231
232Machine::MediaData::MediaData()
233{
234}
235
236Machine::MediaData::~MediaData()
237{
238}
239
240/////////////////////////////////////////////////////////////////////////////
241// Machine class
242/////////////////////////////////////////////////////////////////////////////
243
244// constructor / destructor
245/////////////////////////////////////////////////////////////////////////////
246
247Machine::Machine() :
248#ifdef VBOX_WITH_RESOURCE_USAGE_API
249 mCollectorGuest(NULL),
250#endif
251 mPeer(NULL),
252 mParent(NULL),
253 mSerialPorts(),
254 mParallelPorts(),
255 uRegistryNeedsSaving(0)
256{}
257
258Machine::~Machine()
259{}
260
261HRESULT Machine::FinalConstruct()
262{
263 LogFlowThisFunc(("\n"));
264 return BaseFinalConstruct();
265}
266
267void Machine::FinalRelease()
268{
269 LogFlowThisFunc(("\n"));
270 uninit();
271 BaseFinalRelease();
272}
273
274/**
275 * Initializes a new machine instance; this init() variant creates a new, empty machine.
276 * This gets called from VirtualBox::CreateMachine().
277 *
278 * @param aParent Associated parent object
279 * @param strConfigFile Local file system path to the VM settings file (can
280 * be relative to the VirtualBox config directory).
281 * @param strName name for the machine
282 * @param llGroups list of groups for the machine
283 * @param aOsType OS Type of this machine or NULL.
284 * @param aId UUID for the new machine.
285 * @param fForceOverwrite Whether to overwrite an existing machine settings file.
286 *
287 * @return Success indicator. if not S_OK, the machine object is invalid
288 */
289HRESULT Machine::init(VirtualBox *aParent,
290 const Utf8Str &strConfigFile,
291 const Utf8Str &strName,
292 const StringsList &llGroups,
293 GuestOSType *aOsType,
294 const Guid &aId,
295 bool fForceOverwrite,
296 bool fDirectoryIncludesUUID)
297{
298 LogFlowThisFuncEnter();
299 LogFlowThisFunc(("(Init_New) aConfigFile='%s'\n", strConfigFile.c_str()));
300
301 /* Enclose the state transition NotReady->InInit->Ready */
302 AutoInitSpan autoInitSpan(this);
303 AssertReturn(autoInitSpan.isOk(), E_FAIL);
304
305 HRESULT rc = initImpl(aParent, strConfigFile);
306 if (FAILED(rc)) return rc;
307
308 rc = i_tryCreateMachineConfigFile(fForceOverwrite);
309 if (FAILED(rc)) return rc;
310
311 if (SUCCEEDED(rc))
312 {
313 // create an empty machine config
314 mData->pMachineConfigFile = new settings::MachineConfigFile(NULL);
315
316 rc = initDataAndChildObjects();
317 }
318
319 if (SUCCEEDED(rc))
320 {
321 // set to true now to cause uninit() to call uninitDataAndChildObjects() on failure
322 mData->mAccessible = TRUE;
323
324 unconst(mData->mUuid) = aId;
325
326 mUserData->s.strName = strName;
327
328 mUserData->s.llGroups = llGroups;
329
330 mUserData->s.fDirectoryIncludesUUID = fDirectoryIncludesUUID;
331 // the "name sync" flag determines whether the machine directory gets renamed along
332 // with the machine file; say so if the settings file name is the same as the
333 // settings file parent directory (machine directory)
334 mUserData->s.fNameSync = i_isInOwnDir();
335
336 // initialize the default snapshots folder
337 rc = COMSETTER(SnapshotFolder)(NULL);
338 AssertComRC(rc);
339
340 if (aOsType)
341 {
342 /* Store OS type */
343 mUserData->s.strOsType = aOsType->i_id();
344
345 /* Apply BIOS defaults */
346 mBIOSSettings->i_applyDefaults(aOsType);
347
348 /* Apply network adapters defaults */
349 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
350 mNetworkAdapters[slot]->i_applyDefaults(aOsType);
351
352 /* Apply serial port defaults */
353 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
354 mSerialPorts[slot]->i_applyDefaults(aOsType);
355
356 /* Let the OS type select 64-bit ness. */
357 mHWData->mLongMode = aOsType->i_is64Bit()
358 ? settings::Hardware::LongMode_Enabled : settings::Hardware::LongMode_Disabled;
359 }
360
361 /* At this point the changing of the current state modification
362 * flag is allowed. */
363 i_allowStateModification();
364
365 /* commit all changes made during the initialization */
366 i_commit();
367 }
368
369 /* Confirm a successful initialization when it's the case */
370 if (SUCCEEDED(rc))
371 {
372 if (mData->mAccessible)
373 autoInitSpan.setSucceeded();
374 else
375 autoInitSpan.setLimited();
376 }
377
378 LogFlowThisFunc(("mName='%s', mRegistered=%RTbool, mAccessible=%RTbool, rc=%08X\n",
379 !!mUserData ? mUserData->s.strName.c_str() : "NULL",
380 mData->mRegistered,
381 mData->mAccessible,
382 rc));
383
384 LogFlowThisFuncLeave();
385
386 return rc;
387}
388
389/**
390 * Initializes a new instance with data from machine XML (formerly Init_Registered).
391 * Gets called in two modes:
392 *
393 * -- from VirtualBox::initMachines() during VirtualBox startup; in that case, the
394 * UUID is specified and we mark the machine as "registered";
395 *
396 * -- from the public VirtualBox::OpenMachine() API, in which case the UUID is NULL
397 * and the machine remains unregistered until RegisterMachine() is called.
398 *
399 * @param aParent Associated parent object
400 * @param aConfigFile Local file system path to the VM settings file (can
401 * be relative to the VirtualBox config directory).
402 * @param aId UUID of the machine or NULL (see above).
403 *
404 * @return Success indicator. if not S_OK, the machine object is invalid
405 */
406HRESULT Machine::initFromSettings(VirtualBox *aParent,
407 const Utf8Str &strConfigFile,
408 const Guid *aId)
409{
410 LogFlowThisFuncEnter();
411 LogFlowThisFunc(("(Init_Registered) aConfigFile='%s\n", strConfigFile.c_str()));
412
413 /* Enclose the state transition NotReady->InInit->Ready */
414 AutoInitSpan autoInitSpan(this);
415 AssertReturn(autoInitSpan.isOk(), E_FAIL);
416
417 HRESULT rc = initImpl(aParent, strConfigFile);
418 if (FAILED(rc)) return rc;
419
420 if (aId)
421 {
422 // loading a registered VM:
423 unconst(mData->mUuid) = *aId;
424 mData->mRegistered = TRUE;
425 // now load the settings from XML:
426 rc = i_registeredInit();
427 // this calls initDataAndChildObjects() and loadSettings()
428 }
429 else
430 {
431 // opening an unregistered VM (VirtualBox::OpenMachine()):
432 rc = initDataAndChildObjects();
433
434 if (SUCCEEDED(rc))
435 {
436 // set to true now to cause uninit() to call uninitDataAndChildObjects() on failure
437 mData->mAccessible = TRUE;
438
439 try
440 {
441 // load and parse machine XML; this will throw on XML or logic errors
442 mData->pMachineConfigFile = new settings::MachineConfigFile(&mData->m_strConfigFileFull);
443
444 // reject VM UUID duplicates, they can happen if someone
445 // tries to register an already known VM config again
446 if (aParent->i_findMachine(mData->pMachineConfigFile->uuid,
447 true /* fPermitInaccessible */,
448 false /* aDoSetError */,
449 NULL) != VBOX_E_OBJECT_NOT_FOUND)
450 {
451 throw setError(E_FAIL,
452 tr("Trying to open a VM config '%s' which has the same UUID as an existing virtual machine"),
453 mData->m_strConfigFile.c_str());
454 }
455
456 // use UUID from machine config
457 unconst(mData->mUuid) = mData->pMachineConfigFile->uuid;
458
459 rc = i_loadMachineDataFromSettings(*mData->pMachineConfigFile,
460 NULL /* puuidRegistry */);
461 if (FAILED(rc)) throw rc;
462
463 /* At this point the changing of the current state modification
464 * flag is allowed. */
465 i_allowStateModification();
466
467 i_commit();
468 }
469 catch (HRESULT err)
470 {
471 /* we assume that error info is set by the thrower */
472 rc = err;
473 }
474 catch (...)
475 {
476 rc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
477 }
478 }
479 }
480
481 /* Confirm a successful initialization when it's the case */
482 if (SUCCEEDED(rc))
483 {
484 if (mData->mAccessible)
485 autoInitSpan.setSucceeded();
486 else
487 {
488 autoInitSpan.setLimited();
489
490 // uninit media from this machine's media registry, or else
491 // reloading the settings will fail
492 mParent->i_unregisterMachineMedia(i_getId());
493 }
494 }
495
496 LogFlowThisFunc(("mName='%s', mRegistered=%RTbool, mAccessible=%RTbool "
497 "rc=%08X\n",
498 !!mUserData ? mUserData->s.strName.c_str() : "NULL",
499 mData->mRegistered, mData->mAccessible, rc));
500
501 LogFlowThisFuncLeave();
502
503 return rc;
504}
505
506/**
507 * Initializes a new instance from a machine config that is already in memory
508 * (import OVF case). Since we are importing, the UUID in the machine
509 * config is ignored and we always generate a fresh one.
510 *
511 * @param strName Name for the new machine; this overrides what is specified in config and is used
512 * for the settings file as well.
513 * @param config Machine configuration loaded and parsed from XML.
514 *
515 * @return Success indicator. if not S_OK, the machine object is invalid
516 */
517HRESULT Machine::init(VirtualBox *aParent,
518 const Utf8Str &strName,
519 const settings::MachineConfigFile &config)
520{
521 LogFlowThisFuncEnter();
522
523 /* Enclose the state transition NotReady->InInit->Ready */
524 AutoInitSpan autoInitSpan(this);
525 AssertReturn(autoInitSpan.isOk(), E_FAIL);
526
527 Utf8Str strConfigFile;
528 aParent->i_getDefaultMachineFolder(strConfigFile);
529 strConfigFile.append(RTPATH_DELIMITER);
530 strConfigFile.append(strName);
531 strConfigFile.append(RTPATH_DELIMITER);
532 strConfigFile.append(strName);
533 strConfigFile.append(".vbox");
534
535 HRESULT rc = initImpl(aParent, strConfigFile);
536 if (FAILED(rc)) return rc;
537
538 rc = i_tryCreateMachineConfigFile(false /* fForceOverwrite */);
539 if (FAILED(rc)) return rc;
540
541 rc = initDataAndChildObjects();
542
543 if (SUCCEEDED(rc))
544 {
545 // set to true now to cause uninit() to call uninitDataAndChildObjects() on failure
546 mData->mAccessible = TRUE;
547
548 // create empty machine config for instance data
549 mData->pMachineConfigFile = new settings::MachineConfigFile(NULL);
550
551 // generate fresh UUID, ignore machine config
552 unconst(mData->mUuid).create();
553
554 rc = i_loadMachineDataFromSettings(config,
555 &mData->mUuid); // puuidRegistry: initialize media with this registry ID
556
557 // override VM name as well, it may be different
558 mUserData->s.strName = strName;
559
560 if (SUCCEEDED(rc))
561 {
562 /* At this point the changing of the current state modification
563 * flag is allowed. */
564 i_allowStateModification();
565
566 /* commit all changes made during the initialization */
567 i_commit();
568 }
569 }
570
571 /* Confirm a successful initialization when it's the case */
572 if (SUCCEEDED(rc))
573 {
574 if (mData->mAccessible)
575 autoInitSpan.setSucceeded();
576 else
577 {
578 /* Ignore all errors from unregistering, they would destroy
579- * the more interesting error information we already have,
580- * pinpointing the issue with the VM config. */
581 ErrorInfoKeeper eik;
582
583 autoInitSpan.setLimited();
584
585 // uninit media from this machine's media registry, or else
586 // reloading the settings will fail
587 mParent->i_unregisterMachineMedia(i_getId());
588 }
589 }
590
591 LogFlowThisFunc(("mName='%s', mRegistered=%RTbool, mAccessible=%RTbool "
592 "rc=%08X\n",
593 !!mUserData ? mUserData->s.strName.c_str() : "NULL",
594 mData->mRegistered, mData->mAccessible, rc));
595
596 LogFlowThisFuncLeave();
597
598 return rc;
599}
600
601/**
602 * Shared code between the various init() implementations.
603 * @param aParent
604 * @return
605 */
606HRESULT Machine::initImpl(VirtualBox *aParent,
607 const Utf8Str &strConfigFile)
608{
609 LogFlowThisFuncEnter();
610
611 AssertReturn(aParent, E_INVALIDARG);
612 AssertReturn(!strConfigFile.isEmpty(), E_INVALIDARG);
613
614 HRESULT rc = S_OK;
615
616 /* share the parent weakly */
617 unconst(mParent) = aParent;
618
619 /* allocate the essential machine data structure (the rest will be
620 * allocated later by initDataAndChildObjects() */
621 mData.allocate();
622
623 /* memorize the config file name (as provided) */
624 mData->m_strConfigFile = strConfigFile;
625
626 /* get the full file name */
627 int vrc1 = mParent->i_calculateFullPath(strConfigFile, mData->m_strConfigFileFull);
628 if (RT_FAILURE(vrc1))
629 return setError(VBOX_E_FILE_ERROR,
630 tr("Invalid machine settings file name '%s' (%Rrc)"),
631 strConfigFile.c_str(),
632 vrc1);
633
634 LogFlowThisFuncLeave();
635
636 return rc;
637}
638
639/**
640 * Tries to create a machine settings file in the path stored in the machine
641 * instance data. Used when a new machine is created to fail gracefully if
642 * the settings file could not be written (e.g. because machine dir is read-only).
643 * @return
644 */
645HRESULT Machine::i_tryCreateMachineConfigFile(bool fForceOverwrite)
646{
647 HRESULT rc = S_OK;
648
649 // when we create a new machine, we must be able to create the settings file
650 RTFILE f = NIL_RTFILE;
651 int vrc = RTFileOpen(&f, mData->m_strConfigFileFull.c_str(), RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
652 if ( RT_SUCCESS(vrc)
653 || vrc == VERR_SHARING_VIOLATION
654 )
655 {
656 if (RT_SUCCESS(vrc))
657 RTFileClose(f);
658 if (!fForceOverwrite)
659 rc = setError(VBOX_E_FILE_ERROR,
660 tr("Machine settings file '%s' already exists"),
661 mData->m_strConfigFileFull.c_str());
662 else
663 {
664 /* try to delete the config file, as otherwise the creation
665 * of a new settings file will fail. */
666 int vrc2 = RTFileDelete(mData->m_strConfigFileFull.c_str());
667 if (RT_FAILURE(vrc2))
668 rc = setError(VBOX_E_FILE_ERROR,
669 tr("Could not delete the existing settings file '%s' (%Rrc)"),
670 mData->m_strConfigFileFull.c_str(), vrc2);
671 }
672 }
673 else if ( vrc != VERR_FILE_NOT_FOUND
674 && vrc != VERR_PATH_NOT_FOUND
675 )
676 rc = setError(VBOX_E_FILE_ERROR,
677 tr("Invalid machine settings file name '%s' (%Rrc)"),
678 mData->m_strConfigFileFull.c_str(),
679 vrc);
680 return rc;
681}
682
683/**
684 * Initializes the registered machine by loading the settings file.
685 * This method is separated from #init() in order to make it possible to
686 * retry the operation after VirtualBox startup instead of refusing to
687 * startup the whole VirtualBox server in case if the settings file of some
688 * registered VM is invalid or inaccessible.
689 *
690 * @note Must be always called from this object's write lock
691 * (unless called from #init() that doesn't need any locking).
692 * @note Locks the mUSBController method for writing.
693 * @note Subclasses must not call this method.
694 */
695HRESULT Machine::i_registeredInit()
696{
697 AssertReturn(!i_isSessionMachine(), E_FAIL);
698 AssertReturn(!i_isSnapshotMachine(), E_FAIL);
699 AssertReturn(mData->mUuid.isValid(), E_FAIL);
700 AssertReturn(!mData->mAccessible, E_FAIL);
701
702 HRESULT rc = initDataAndChildObjects();
703
704 if (SUCCEEDED(rc))
705 {
706 /* Temporarily reset the registered flag in order to let setters
707 * potentially called from loadSettings() succeed (isMutable() used in
708 * all setters will return FALSE for a Machine instance if mRegistered
709 * is TRUE). */
710 mData->mRegistered = FALSE;
711
712 try
713 {
714 // load and parse machine XML; this will throw on XML or logic errors
715 mData->pMachineConfigFile = new settings::MachineConfigFile(&mData->m_strConfigFileFull);
716
717 if (mData->mUuid != mData->pMachineConfigFile->uuid)
718 throw setError(E_FAIL,
719 tr("Machine UUID {%RTuuid} in '%s' doesn't match its UUID {%s} in the registry file '%s'"),
720 mData->pMachineConfigFile->uuid.raw(),
721 mData->m_strConfigFileFull.c_str(),
722 mData->mUuid.toString().c_str(),
723 mParent->i_settingsFilePath().c_str());
724
725 rc = i_loadMachineDataFromSettings(*mData->pMachineConfigFile,
726 NULL /* const Guid *puuidRegistry */);
727 if (FAILED(rc)) throw rc;
728 }
729 catch (HRESULT err)
730 {
731 /* we assume that error info is set by the thrower */
732 rc = err;
733 }
734 catch (...)
735 {
736 rc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
737 }
738
739 /* Restore the registered flag (even on failure) */
740 mData->mRegistered = TRUE;
741 }
742
743 if (SUCCEEDED(rc))
744 {
745 /* Set mAccessible to TRUE only if we successfully locked and loaded
746 * the settings file */
747 mData->mAccessible = TRUE;
748
749 /* commit all changes made during loading the settings file */
750 i_commit(); // @todo r=dj why do we need a commit during init?!? this is very expensive
751 /// @todo r=klaus for some reason the settings loading logic backs up
752 // the settings, and therefore a commit is needed. Should probably be changed.
753 }
754 else
755 {
756 /* If the machine is registered, then, instead of returning a
757 * failure, we mark it as inaccessible and set the result to
758 * success to give it a try later */
759
760 /* fetch the current error info */
761 mData->mAccessError = com::ErrorInfo();
762 Log1Warning(("Machine {%RTuuid} is inaccessible! [%ls]\n", mData->mUuid.raw(), mData->mAccessError.getText().raw()));
763
764 /* rollback all changes */
765 i_rollback(false /* aNotify */);
766
767 // uninit media from this machine's media registry, or else
768 // reloading the settings will fail
769 mParent->i_unregisterMachineMedia(i_getId());
770
771 /* uninitialize the common part to make sure all data is reset to
772 * default (null) values */
773 uninitDataAndChildObjects();
774
775 rc = S_OK;
776 }
777
778 return rc;
779}
780
781/**
782 * Uninitializes the instance.
783 * Called either from FinalRelease() or by the parent when it gets destroyed.
784 *
785 * @note The caller of this method must make sure that this object
786 * a) doesn't have active callers on the current thread and b) is not locked
787 * by the current thread; otherwise uninit() will hang either a) due to
788 * AutoUninitSpan waiting for a number of calls to drop to zero or b) due to
789 * a dead-lock caused by this thread waiting for all callers on the other
790 * threads are done but preventing them from doing so by holding a lock.
791 */
792void Machine::uninit()
793{
794 LogFlowThisFuncEnter();
795
796 Assert(!isWriteLockOnCurrentThread());
797
798 Assert(!uRegistryNeedsSaving);
799 if (uRegistryNeedsSaving)
800 {
801 AutoCaller autoCaller(this);
802 if (SUCCEEDED(autoCaller.rc()))
803 {
804 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
805 i_saveSettings(NULL, Machine::SaveS_Force);
806 }
807 }
808
809 /* Enclose the state transition Ready->InUninit->NotReady */
810 AutoUninitSpan autoUninitSpan(this);
811 if (autoUninitSpan.uninitDone())
812 return;
813
814 Assert(!i_isSnapshotMachine());
815 Assert(!i_isSessionMachine());
816 Assert(!!mData);
817
818 LogFlowThisFunc(("initFailed()=%d\n", autoUninitSpan.initFailed()));
819 LogFlowThisFunc(("mRegistered=%d\n", mData->mRegistered));
820
821 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
822
823 if (!mData->mSession.mMachine.isNull())
824 {
825 /* Theoretically, this can only happen if the VirtualBox server has been
826 * terminated while there were clients running that owned open direct
827 * sessions. Since in this case we are definitely called by
828 * VirtualBox::uninit(), we may be sure that SessionMachine::uninit()
829 * won't happen on the client watcher thread (because it does
830 * VirtualBox::addCaller() for the duration of the
831 * SessionMachine::checkForDeath() call, so that VirtualBox::uninit()
832 * cannot happen until the VirtualBox caller is released). This is
833 * important, because SessionMachine::uninit() cannot correctly operate
834 * after we return from this method (it expects the Machine instance is
835 * still valid). We'll call it ourselves below.
836 */
837 Log1WarningThisFunc(("Session machine is not NULL (%p), the direct session is still open!\n",
838 (SessionMachine*)mData->mSession.mMachine));
839
840 if (Global::IsOnlineOrTransient(mData->mMachineState))
841 {
842 Log1WarningThisFunc(("Setting state to Aborted!\n"));
843 /* set machine state using SessionMachine reimplementation */
844 static_cast<Machine*>(mData->mSession.mMachine)->i_setMachineState(MachineState_Aborted);
845 }
846
847 /*
848 * Uninitialize SessionMachine using public uninit() to indicate
849 * an unexpected uninitialization.
850 */
851 mData->mSession.mMachine->uninit();
852 /* SessionMachine::uninit() must set mSession.mMachine to null */
853 Assert(mData->mSession.mMachine.isNull());
854 }
855
856 // uninit media from this machine's media registry, if they're still there
857 Guid uuidMachine(i_getId());
858
859 /* the lock is no more necessary (SessionMachine is uninitialized) */
860 alock.release();
861
862 /* XXX This will fail with
863 * "cannot be closed because it is still attached to 1 virtual machines"
864 * because at this point we did not call uninitDataAndChildObjects() yet
865 * and therefore also removeBackReference() for all these mediums was not called! */
866
867 if (uuidMachine.isValid() && !uuidMachine.isZero()) // can be empty if we're called from a failure of Machine::init
868 mParent->i_unregisterMachineMedia(uuidMachine);
869
870 // has machine been modified?
871 if (mData->flModifications)
872 {
873 Log1WarningThisFunc(("Discarding unsaved settings changes!\n"));
874 i_rollback(false /* aNotify */);
875 }
876
877 if (mData->mAccessible)
878 uninitDataAndChildObjects();
879
880 /* free the essential data structure last */
881 mData.free();
882
883 LogFlowThisFuncLeave();
884}
885
886// Wrapped IMachine properties
887/////////////////////////////////////////////////////////////////////////////
888HRESULT Machine::getParent(ComPtr<IVirtualBox> &aParent)
889{
890 /* mParent is constant during life time, no need to lock */
891 ComObjPtr<VirtualBox> pVirtualBox(mParent);
892 aParent = pVirtualBox;
893
894 return S_OK;
895}
896
897
898HRESULT Machine::getAccessible(BOOL *aAccessible)
899{
900 /* In some cases (medium registry related), it is necessary to be able to
901 * go through the list of all machines. Happens when an inaccessible VM
902 * has a sensible medium registry. */
903 AutoReadLock mllock(mParent->i_getMachinesListLockHandle() COMMA_LOCKVAL_SRC_POS);
904 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
905
906 HRESULT rc = S_OK;
907
908 if (!mData->mAccessible)
909 {
910 /* try to initialize the VM once more if not accessible */
911
912 AutoReinitSpan autoReinitSpan(this);
913 AssertReturn(autoReinitSpan.isOk(), E_FAIL);
914
915#ifdef DEBUG
916 LogFlowThisFunc(("Dumping media backreferences\n"));
917 mParent->i_dumpAllBackRefs();
918#endif
919
920 if (mData->pMachineConfigFile)
921 {
922 // reset the XML file to force loadSettings() (called from registeredInit())
923 // to parse it again; the file might have changed
924 delete mData->pMachineConfigFile;
925 mData->pMachineConfigFile = NULL;
926 }
927
928 rc = i_registeredInit();
929
930 if (SUCCEEDED(rc) && mData->mAccessible)
931 {
932 autoReinitSpan.setSucceeded();
933
934 /* make sure interesting parties will notice the accessibility
935 * state change */
936 mParent->i_onMachineStateChange(mData->mUuid, mData->mMachineState);
937 mParent->i_onMachineDataChange(mData->mUuid);
938 }
939 }
940
941 if (SUCCEEDED(rc))
942 *aAccessible = mData->mAccessible;
943
944 LogFlowThisFuncLeave();
945
946 return rc;
947}
948
949HRESULT Machine::getAccessError(ComPtr<IVirtualBoxErrorInfo> &aAccessError)
950{
951 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
952
953 if (mData->mAccessible || !mData->mAccessError.isBasicAvailable())
954 {
955 /* return shortly */
956 aAccessError = NULL;
957 return S_OK;
958 }
959
960 HRESULT rc = S_OK;
961
962 ComObjPtr<VirtualBoxErrorInfo> errorInfo;
963 rc = errorInfo.createObject();
964 if (SUCCEEDED(rc))
965 {
966 errorInfo->init(mData->mAccessError.getResultCode(),
967 mData->mAccessError.getInterfaceID().ref(),
968 Utf8Str(mData->mAccessError.getComponent()).c_str(),
969 Utf8Str(mData->mAccessError.getText()));
970 aAccessError = errorInfo;
971 }
972
973 return rc;
974}
975
976HRESULT Machine::getName(com::Utf8Str &aName)
977{
978 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
979
980 aName = mUserData->s.strName;
981
982 return S_OK;
983}
984
985HRESULT Machine::setName(const com::Utf8Str &aName)
986{
987 // prohibit setting a UUID only as the machine name, or else it can
988 // never be found by findMachine()
989 Guid test(aName);
990
991 if (test.isValid())
992 return setError(E_INVALIDARG, tr("A machine cannot have a UUID as its name"));
993
994 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
995
996 HRESULT rc = i_checkStateDependency(MutableStateDep);
997 if (FAILED(rc)) return rc;
998
999 i_setModified(IsModified_MachineData);
1000 mUserData.backup();
1001 mUserData->s.strName = aName;
1002
1003 return S_OK;
1004}
1005
1006HRESULT Machine::getDescription(com::Utf8Str &aDescription)
1007{
1008 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1009
1010 aDescription = mUserData->s.strDescription;
1011
1012 return S_OK;
1013}
1014
1015HRESULT Machine::setDescription(const com::Utf8Str &aDescription)
1016{
1017 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1018
1019 // this can be done in principle in any state as it doesn't affect the VM
1020 // significantly, but play safe by not messing around while complex
1021 // activities are going on
1022 HRESULT rc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
1023 if (FAILED(rc)) return rc;
1024
1025 i_setModified(IsModified_MachineData);
1026 mUserData.backup();
1027 mUserData->s.strDescription = aDescription;
1028
1029 return S_OK;
1030}
1031
1032HRESULT Machine::getId(com::Guid &aId)
1033{
1034 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1035
1036 aId = mData->mUuid;
1037
1038 return S_OK;
1039}
1040
1041HRESULT Machine::getGroups(std::vector<com::Utf8Str> &aGroups)
1042{
1043 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1044 aGroups.resize(mUserData->s.llGroups.size());
1045 size_t i = 0;
1046 for (StringsList::const_iterator it = mUserData->s.llGroups.begin();
1047 it != mUserData->s.llGroups.end(); ++it, ++i)
1048 aGroups[i] = (*it);
1049
1050 return S_OK;
1051}
1052
1053HRESULT Machine::setGroups(const std::vector<com::Utf8Str> &aGroups)
1054{
1055 StringsList llGroups;
1056 HRESULT rc = mParent->i_convertMachineGroups(aGroups, &llGroups);
1057 if (FAILED(rc))
1058 return rc;
1059
1060 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1061
1062 rc = i_checkStateDependency(MutableOrSavedStateDep);
1063 if (FAILED(rc)) return rc;
1064
1065 i_setModified(IsModified_MachineData);
1066 mUserData.backup();
1067 mUserData->s.llGroups = llGroups;
1068
1069 return S_OK;
1070}
1071
1072HRESULT Machine::getOSTypeId(com::Utf8Str &aOSTypeId)
1073{
1074 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1075
1076 aOSTypeId = mUserData->s.strOsType;
1077
1078 return S_OK;
1079}
1080
1081HRESULT Machine::setOSTypeId(const com::Utf8Str &aOSTypeId)
1082{
1083 /* look up the object by Id to check it is valid */
1084 ComPtr<IGuestOSType> guestOSType;
1085 HRESULT rc = mParent->GetGuestOSType(Bstr(aOSTypeId).raw(), guestOSType.asOutParam());
1086 if (FAILED(rc)) return rc;
1087
1088 /* when setting, always use the "etalon" value for consistency -- lookup
1089 * by ID is case-insensitive and the input value may have different case */
1090 Bstr osTypeId;
1091 rc = guestOSType->COMGETTER(Id)(osTypeId.asOutParam());
1092 if (FAILED(rc)) return rc;
1093
1094 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1095
1096 rc = i_checkStateDependency(MutableStateDep);
1097 if (FAILED(rc)) return rc;
1098
1099 i_setModified(IsModified_MachineData);
1100 mUserData.backup();
1101 mUserData->s.strOsType = osTypeId;
1102
1103 return S_OK;
1104}
1105
1106HRESULT Machine::getFirmwareType(FirmwareType_T *aFirmwareType)
1107{
1108 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1109
1110 *aFirmwareType = mHWData->mFirmwareType;
1111
1112 return S_OK;
1113}
1114
1115HRESULT Machine::setFirmwareType(FirmwareType_T aFirmwareType)
1116{
1117 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1118
1119 HRESULT rc = i_checkStateDependency(MutableStateDep);
1120 if (FAILED(rc)) return rc;
1121
1122 i_setModified(IsModified_MachineData);
1123 mHWData.backup();
1124 mHWData->mFirmwareType = aFirmwareType;
1125
1126 return S_OK;
1127}
1128
1129HRESULT Machine::getKeyboardHIDType(KeyboardHIDType_T *aKeyboardHIDType)
1130{
1131 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1132
1133 *aKeyboardHIDType = mHWData->mKeyboardHIDType;
1134
1135 return S_OK;
1136}
1137
1138HRESULT Machine::setKeyboardHIDType(KeyboardHIDType_T aKeyboardHIDType)
1139{
1140 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1141
1142 HRESULT rc = i_checkStateDependency(MutableStateDep);
1143 if (FAILED(rc)) return rc;
1144
1145 i_setModified(IsModified_MachineData);
1146 mHWData.backup();
1147 mHWData->mKeyboardHIDType = aKeyboardHIDType;
1148
1149 return S_OK;
1150}
1151
1152HRESULT Machine::getPointingHIDType(PointingHIDType_T *aPointingHIDType)
1153{
1154 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1155
1156 *aPointingHIDType = mHWData->mPointingHIDType;
1157
1158 return S_OK;
1159}
1160
1161HRESULT Machine::setPointingHIDType(PointingHIDType_T aPointingHIDType)
1162{
1163 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1164
1165 HRESULT rc = i_checkStateDependency(MutableStateDep);
1166 if (FAILED(rc)) return rc;
1167
1168 i_setModified(IsModified_MachineData);
1169 mHWData.backup();
1170 mHWData->mPointingHIDType = aPointingHIDType;
1171
1172 return S_OK;
1173}
1174
1175HRESULT Machine::getChipsetType(ChipsetType_T *aChipsetType)
1176{
1177 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1178
1179 *aChipsetType = mHWData->mChipsetType;
1180
1181 return S_OK;
1182}
1183
1184HRESULT Machine::setChipsetType(ChipsetType_T aChipsetType)
1185{
1186 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1187
1188 HRESULT rc = i_checkStateDependency(MutableStateDep);
1189 if (FAILED(rc)) return rc;
1190
1191 if (aChipsetType != mHWData->mChipsetType)
1192 {
1193 i_setModified(IsModified_MachineData);
1194 mHWData.backup();
1195 mHWData->mChipsetType = aChipsetType;
1196
1197 // Resize network adapter array, to be finalized on commit/rollback.
1198 // We must not throw away entries yet, otherwise settings are lost
1199 // without a way to roll back.
1200 size_t newCount = Global::getMaxNetworkAdapters(aChipsetType);
1201 size_t oldCount = mNetworkAdapters.size();
1202 if (newCount > oldCount)
1203 {
1204 mNetworkAdapters.resize(newCount);
1205 for (size_t slot = oldCount; slot < mNetworkAdapters.size(); slot++)
1206 {
1207 unconst(mNetworkAdapters[slot]).createObject();
1208 mNetworkAdapters[slot]->init(this, (ULONG)slot);
1209 }
1210 }
1211 }
1212
1213 return S_OK;
1214}
1215
1216HRESULT Machine::getParavirtProvider(ParavirtProvider_T *aParavirtProvider)
1217{
1218 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1219
1220 *aParavirtProvider = mHWData->mParavirtProvider;
1221
1222 return S_OK;
1223}
1224
1225HRESULT Machine::setParavirtProvider(ParavirtProvider_T aParavirtProvider)
1226{
1227 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1228
1229 HRESULT rc = i_checkStateDependency(MutableStateDep);
1230 if (FAILED(rc)) return rc;
1231
1232 if (aParavirtProvider != mHWData->mParavirtProvider)
1233 {
1234 i_setModified(IsModified_MachineData);
1235 mHWData.backup();
1236 mHWData->mParavirtProvider = aParavirtProvider;
1237 }
1238
1239 return S_OK;
1240}
1241
1242HRESULT Machine::getEffectiveParavirtProvider(ParavirtProvider_T *aParavirtProvider)
1243{
1244 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1245
1246 *aParavirtProvider = mHWData->mParavirtProvider;
1247 switch (mHWData->mParavirtProvider)
1248 {
1249 case ParavirtProvider_None:
1250 case ParavirtProvider_HyperV:
1251 case ParavirtProvider_KVM:
1252 case ParavirtProvider_Minimal:
1253 break;
1254
1255 /* Resolve dynamic provider types to the effective types. */
1256 default:
1257 {
1258 ComPtr<IGuestOSType> ptrGuestOSType;
1259 HRESULT hrc2 = mParent->GetGuestOSType(Bstr(mUserData->s.strOsType).raw(), ptrGuestOSType.asOutParam());
1260 AssertMsgReturn(SUCCEEDED(hrc2), ("Failed to get guest OS type. hrc2=%Rhrc\n", hrc2), hrc2);
1261
1262 Bstr guestTypeFamilyId;
1263 hrc2 = ptrGuestOSType->COMGETTER(FamilyId)(guestTypeFamilyId.asOutParam());
1264 AssertMsgReturn(SUCCEEDED(hrc2), ("Failed to get guest family. hrc2=%Rhrc\n", hrc2), hrc2);
1265 BOOL fOsXGuest = guestTypeFamilyId == Bstr("MacOS");
1266
1267 switch (mHWData->mParavirtProvider)
1268 {
1269 case ParavirtProvider_Legacy:
1270 {
1271 if (fOsXGuest)
1272 *aParavirtProvider = ParavirtProvider_Minimal;
1273 else
1274 *aParavirtProvider = ParavirtProvider_None;
1275 break;
1276 }
1277
1278 case ParavirtProvider_Default:
1279 {
1280 if (fOsXGuest)
1281 *aParavirtProvider = ParavirtProvider_Minimal;
1282 else if ( mUserData->s.strOsType == "Windows10"
1283 || mUserData->s.strOsType == "Windows10_64"
1284 || mUserData->s.strOsType == "Windows81"
1285 || mUserData->s.strOsType == "Windows81_64"
1286 || mUserData->s.strOsType == "Windows8"
1287 || mUserData->s.strOsType == "Windows8_64"
1288 || mUserData->s.strOsType == "Windows7"
1289 || mUserData->s.strOsType == "Windows7_64"
1290 || mUserData->s.strOsType == "WindowsVista"
1291 || mUserData->s.strOsType == "WindowsVista_64"
1292 || mUserData->s.strOsType == "Windows2012"
1293 || mUserData->s.strOsType == "Windows2012_64"
1294 || mUserData->s.strOsType == "Windows2008"
1295 || mUserData->s.strOsType == "Windows2008_64")
1296 {
1297 *aParavirtProvider = ParavirtProvider_HyperV;
1298 }
1299 else if ( mUserData->s.strOsType == "Linux26" // Linux22 and Linux24 omitted as they're too old
1300 || mUserData->s.strOsType == "Linux26_64" // for having any KVM paravirtualization support.
1301 || mUserData->s.strOsType == "Linux"
1302 || mUserData->s.strOsType == "Linux_64"
1303 || mUserData->s.strOsType == "ArchLinux"
1304 || mUserData->s.strOsType == "ArchLinux_64"
1305 || mUserData->s.strOsType == "Debian"
1306 || mUserData->s.strOsType == "Debian_64"
1307 || mUserData->s.strOsType == "Fedora"
1308 || mUserData->s.strOsType == "Fedora_64"
1309 || mUserData->s.strOsType == "Gentoo"
1310 || mUserData->s.strOsType == "Gentoo_64"
1311 || mUserData->s.strOsType == "Mandriva"
1312 || mUserData->s.strOsType == "Mandriva_64"
1313 || mUserData->s.strOsType == "OpenSUSE"
1314 || mUserData->s.strOsType == "OpenSUSE_64"
1315 || mUserData->s.strOsType == "Oracle"
1316 || mUserData->s.strOsType == "Oracle_64"
1317 || mUserData->s.strOsType == "RedHat"
1318 || mUserData->s.strOsType == "RedHat_64"
1319 || mUserData->s.strOsType == "Turbolinux"
1320 || mUserData->s.strOsType == "Turbolinux_64"
1321 || mUserData->s.strOsType == "Ubuntu"
1322 || mUserData->s.strOsType == "Ubuntu_64"
1323 || mUserData->s.strOsType == "Xandros"
1324 || mUserData->s.strOsType == "Xandros_64")
1325 {
1326 *aParavirtProvider = ParavirtProvider_KVM;
1327 }
1328 else
1329 *aParavirtProvider = ParavirtProvider_None;
1330 break;
1331 }
1332 }
1333 break;
1334 }
1335 }
1336
1337 Assert( *aParavirtProvider == ParavirtProvider_None
1338 || *aParavirtProvider == ParavirtProvider_Minimal
1339 || *aParavirtProvider == ParavirtProvider_HyperV
1340 || *aParavirtProvider == ParavirtProvider_KVM);
1341 return S_OK;
1342}
1343
1344HRESULT Machine::getHardwareVersion(com::Utf8Str &aHardwareVersion)
1345{
1346 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1347
1348 aHardwareVersion = mHWData->mHWVersion;
1349
1350 return S_OK;
1351}
1352
1353HRESULT Machine::setHardwareVersion(const com::Utf8Str &aHardwareVersion)
1354{
1355 /* check known version */
1356 Utf8Str hwVersion = aHardwareVersion;
1357 if ( hwVersion.compare("1") != 0
1358 && hwVersion.compare("2") != 0)
1359 return setError(E_INVALIDARG,
1360 tr("Invalid hardware version: %s\n"), aHardwareVersion.c_str());
1361
1362 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1363
1364 HRESULT rc = i_checkStateDependency(MutableStateDep);
1365 if (FAILED(rc)) return rc;
1366
1367 i_setModified(IsModified_MachineData);
1368 mHWData.backup();
1369 mHWData->mHWVersion = aHardwareVersion;
1370
1371 return S_OK;
1372}
1373
1374HRESULT Machine::getHardwareUUID(com::Guid &aHardwareUUID)
1375{
1376 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1377
1378 if (!mHWData->mHardwareUUID.isZero())
1379 aHardwareUUID = mHWData->mHardwareUUID;
1380 else
1381 aHardwareUUID = mData->mUuid;
1382
1383 return S_OK;
1384}
1385
1386HRESULT Machine::setHardwareUUID(const com::Guid &aHardwareUUID)
1387{
1388 if (!aHardwareUUID.isValid())
1389 return E_INVALIDARG;
1390
1391 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1392
1393 HRESULT rc = i_checkStateDependency(MutableStateDep);
1394 if (FAILED(rc)) return rc;
1395
1396 i_setModified(IsModified_MachineData);
1397 mHWData.backup();
1398 if (aHardwareUUID == mData->mUuid)
1399 mHWData->mHardwareUUID.clear();
1400 else
1401 mHWData->mHardwareUUID = aHardwareUUID;
1402
1403 return S_OK;
1404}
1405
1406HRESULT Machine::getMemorySize(ULONG *aMemorySize)
1407{
1408 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1409
1410 *aMemorySize = mHWData->mMemorySize;
1411
1412 return S_OK;
1413}
1414
1415HRESULT Machine::setMemorySize(ULONG aMemorySize)
1416{
1417 /* check RAM limits */
1418 if ( aMemorySize < MM_RAM_MIN_IN_MB
1419 || aMemorySize > MM_RAM_MAX_IN_MB
1420 )
1421 return setError(E_INVALIDARG,
1422 tr("Invalid RAM size: %lu MB (must be in range [%lu, %lu] MB)"),
1423 aMemorySize, MM_RAM_MIN_IN_MB, MM_RAM_MAX_IN_MB);
1424
1425 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1426
1427 HRESULT rc = i_checkStateDependency(MutableStateDep);
1428 if (FAILED(rc)) return rc;
1429
1430 i_setModified(IsModified_MachineData);
1431 mHWData.backup();
1432 mHWData->mMemorySize = aMemorySize;
1433
1434 return S_OK;
1435}
1436
1437HRESULT Machine::getCPUCount(ULONG *aCPUCount)
1438{
1439 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1440
1441 *aCPUCount = mHWData->mCPUCount;
1442
1443 return S_OK;
1444}
1445
1446HRESULT Machine::setCPUCount(ULONG aCPUCount)
1447{
1448 /* check CPU limits */
1449 if ( aCPUCount < SchemaDefs::MinCPUCount
1450 || aCPUCount > SchemaDefs::MaxCPUCount
1451 )
1452 return setError(E_INVALIDARG,
1453 tr("Invalid virtual CPU count: %lu (must be in range [%lu, %lu])"),
1454 aCPUCount, SchemaDefs::MinCPUCount, SchemaDefs::MaxCPUCount);
1455
1456 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1457
1458 /* We cant go below the current number of CPUs attached if hotplug is enabled*/
1459 if (mHWData->mCPUHotPlugEnabled)
1460 {
1461 for (unsigned idx = aCPUCount; idx < SchemaDefs::MaxCPUCount; idx++)
1462 {
1463 if (mHWData->mCPUAttached[idx])
1464 return setError(E_INVALIDARG,
1465 tr("There is still a CPU attached to socket %lu."
1466 "Detach the CPU before removing the socket"),
1467 aCPUCount, idx+1);
1468 }
1469 }
1470
1471 HRESULT rc = i_checkStateDependency(MutableStateDep);
1472 if (FAILED(rc)) return rc;
1473
1474 i_setModified(IsModified_MachineData);
1475 mHWData.backup();
1476 mHWData->mCPUCount = aCPUCount;
1477
1478 return S_OK;
1479}
1480
1481HRESULT Machine::getCPUExecutionCap(ULONG *aCPUExecutionCap)
1482{
1483 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1484
1485 *aCPUExecutionCap = mHWData->mCpuExecutionCap;
1486
1487 return S_OK;
1488}
1489
1490HRESULT Machine::setCPUExecutionCap(ULONG aCPUExecutionCap)
1491{
1492 HRESULT rc = S_OK;
1493
1494 /* check throttle limits */
1495 if ( aCPUExecutionCap < 1
1496 || aCPUExecutionCap > 100
1497 )
1498 return setError(E_INVALIDARG,
1499 tr("Invalid CPU execution cap value: %lu (must be in range [%lu, %lu])"),
1500 aCPUExecutionCap, 1, 100);
1501
1502 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1503
1504 alock.release();
1505 rc = i_onCPUExecutionCapChange(aCPUExecutionCap);
1506 alock.acquire();
1507 if (FAILED(rc)) return rc;
1508
1509 i_setModified(IsModified_MachineData);
1510 mHWData.backup();
1511 mHWData->mCpuExecutionCap = aCPUExecutionCap;
1512
1513 /** Save settings if online - @todo why is this required? -- @bugref{6818} */
1514 if (Global::IsOnline(mData->mMachineState))
1515 i_saveSettings(NULL);
1516
1517 return S_OK;
1518}
1519
1520HRESULT Machine::getCPUHotPlugEnabled(BOOL *aCPUHotPlugEnabled)
1521{
1522 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1523
1524 *aCPUHotPlugEnabled = mHWData->mCPUHotPlugEnabled;
1525
1526 return S_OK;
1527}
1528
1529HRESULT Machine::setCPUHotPlugEnabled(BOOL aCPUHotPlugEnabled)
1530{
1531 HRESULT rc = S_OK;
1532
1533 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1534
1535 rc = i_checkStateDependency(MutableStateDep);
1536 if (FAILED(rc)) return rc;
1537
1538 if (mHWData->mCPUHotPlugEnabled != aCPUHotPlugEnabled)
1539 {
1540 if (aCPUHotPlugEnabled)
1541 {
1542 i_setModified(IsModified_MachineData);
1543 mHWData.backup();
1544
1545 /* Add the amount of CPUs currently attached */
1546 for (unsigned i = 0; i < mHWData->mCPUCount; ++i)
1547 mHWData->mCPUAttached[i] = true;
1548 }
1549 else
1550 {
1551 /*
1552 * We can disable hotplug only if the amount of maximum CPUs is equal
1553 * to the amount of attached CPUs
1554 */
1555 unsigned cCpusAttached = 0;
1556 unsigned iHighestId = 0;
1557
1558 for (unsigned i = 0; i < SchemaDefs::MaxCPUCount; ++i)
1559 {
1560 if (mHWData->mCPUAttached[i])
1561 {
1562 cCpusAttached++;
1563 iHighestId = i;
1564 }
1565 }
1566
1567 if ( (cCpusAttached != mHWData->mCPUCount)
1568 || (iHighestId >= mHWData->mCPUCount))
1569 return setError(E_INVALIDARG,
1570 tr("CPU hotplugging can't be disabled because the maximum number of CPUs is not equal to the amount of CPUs attached"));
1571
1572 i_setModified(IsModified_MachineData);
1573 mHWData.backup();
1574 }
1575 }
1576
1577 mHWData->mCPUHotPlugEnabled = aCPUHotPlugEnabled;
1578
1579 return rc;
1580}
1581
1582HRESULT Machine::getCPUIDPortabilityLevel(ULONG *aCPUIDPortabilityLevel)
1583{
1584 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1585
1586 *aCPUIDPortabilityLevel = mHWData->mCpuIdPortabilityLevel;
1587
1588 return S_OK;
1589}
1590
1591HRESULT Machine::setCPUIDPortabilityLevel(ULONG aCPUIDPortabilityLevel)
1592{
1593 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1594
1595 HRESULT hrc = i_checkStateDependency(MutableStateDep);
1596 if (SUCCEEDED(hrc))
1597 {
1598 i_setModified(IsModified_MachineData);
1599 mHWData.backup();
1600 mHWData->mCpuIdPortabilityLevel = aCPUIDPortabilityLevel;
1601 }
1602 return hrc;
1603}
1604
1605HRESULT Machine::getEmulatedUSBCardReaderEnabled(BOOL *aEmulatedUSBCardReaderEnabled)
1606{
1607#ifdef VBOX_WITH_USB_CARDREADER
1608 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1609
1610 *aEmulatedUSBCardReaderEnabled = mHWData->mEmulatedUSBCardReaderEnabled;
1611
1612 return S_OK;
1613#else
1614 NOREF(aEmulatedUSBCardReaderEnabled);
1615 return E_NOTIMPL;
1616#endif
1617}
1618
1619HRESULT Machine::setEmulatedUSBCardReaderEnabled(BOOL aEmulatedUSBCardReaderEnabled)
1620{
1621#ifdef VBOX_WITH_USB_CARDREADER
1622 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1623
1624 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
1625 if (FAILED(rc)) return rc;
1626
1627 i_setModified(IsModified_MachineData);
1628 mHWData.backup();
1629 mHWData->mEmulatedUSBCardReaderEnabled = aEmulatedUSBCardReaderEnabled;
1630
1631 return S_OK;
1632#else
1633 NOREF(aEmulatedUSBCardReaderEnabled);
1634 return E_NOTIMPL;
1635#endif
1636}
1637
1638HRESULT Machine::getHPETEnabled(BOOL *aHPETEnabled)
1639{
1640 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1641
1642 *aHPETEnabled = mHWData->mHPETEnabled;
1643
1644 return S_OK;
1645}
1646
1647HRESULT Machine::setHPETEnabled(BOOL aHPETEnabled)
1648{
1649 HRESULT rc = S_OK;
1650
1651 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1652
1653 rc = i_checkStateDependency(MutableStateDep);
1654 if (FAILED(rc)) return rc;
1655
1656 i_setModified(IsModified_MachineData);
1657 mHWData.backup();
1658
1659 mHWData->mHPETEnabled = aHPETEnabled;
1660
1661 return rc;
1662}
1663
1664HRESULT Machine::getVideoCaptureEnabled(BOOL *aVideoCaptureEnabled)
1665{
1666 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1667
1668 *aVideoCaptureEnabled = mHWData->mVideoCaptureEnabled;
1669 return S_OK;
1670}
1671
1672HRESULT Machine::setVideoCaptureEnabled(BOOL aVideoCaptureEnabled)
1673{
1674 HRESULT rc = S_OK;
1675
1676 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1677
1678 i_setModified(IsModified_MachineData);
1679 mHWData.backup();
1680 mHWData->mVideoCaptureEnabled = aVideoCaptureEnabled;
1681
1682 alock.release();
1683 rc = i_onVideoCaptureChange();
1684 alock.acquire();
1685 if (FAILED(rc))
1686 {
1687 /*
1688 * Normally we would do the actual change _after_ i_onVideoCaptureChange() succeeded.
1689 * We cannot do this because that function uses Machine::GetVideoCaptureEnabled to
1690 * determine if it should start or stop capturing. Therefore we need to manually
1691 * undo change.
1692 */
1693 mHWData->mVideoCaptureEnabled = mHWData.backedUpData()->mVideoCaptureEnabled;
1694 return rc;
1695 }
1696
1697 /** Save settings if online - @todo why is this required? -- @bugref{6818} */
1698 if (Global::IsOnline(mData->mMachineState))
1699 i_saveSettings(NULL);
1700
1701 return rc;
1702}
1703
1704HRESULT Machine::getVideoCaptureScreens(std::vector<BOOL> &aVideoCaptureScreens)
1705{
1706 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1707 aVideoCaptureScreens.resize(mHWData->mMonitorCount);
1708 for (unsigned i = 0; i < mHWData->mMonitorCount; ++i)
1709 aVideoCaptureScreens[i] = mHWData->maVideoCaptureScreens[i];
1710 return S_OK;
1711}
1712
1713HRESULT Machine::setVideoCaptureScreens(const std::vector<BOOL> &aVideoCaptureScreens)
1714{
1715 AssertReturn(aVideoCaptureScreens.size() <= RT_ELEMENTS(mHWData->maVideoCaptureScreens), E_INVALIDARG);
1716 bool fChanged = false;
1717
1718 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1719
1720 for (unsigned i = 0; i < aVideoCaptureScreens.size(); ++i)
1721 {
1722 if (mHWData->maVideoCaptureScreens[i] != RT_BOOL(aVideoCaptureScreens[i]))
1723 {
1724 mHWData->maVideoCaptureScreens[i] = RT_BOOL(aVideoCaptureScreens[i]);
1725 fChanged = true;
1726 }
1727 }
1728 if (fChanged)
1729 {
1730 alock.release();
1731 HRESULT rc = i_onVideoCaptureChange();
1732 alock.acquire();
1733 if (FAILED(rc)) return rc;
1734 i_setModified(IsModified_MachineData);
1735
1736 /** Save settings if online - @todo why is this required? -- @bugref{6818} */
1737 if (Global::IsOnline(mData->mMachineState))
1738 i_saveSettings(NULL);
1739 }
1740
1741 return S_OK;
1742}
1743
1744HRESULT Machine::getVideoCaptureFile(com::Utf8Str &aVideoCaptureFile)
1745{
1746 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1747 if (mHWData->mVideoCaptureFile.isEmpty())
1748 i_getDefaultVideoCaptureFile(aVideoCaptureFile);
1749 else
1750 aVideoCaptureFile = mHWData->mVideoCaptureFile;
1751 return S_OK;
1752}
1753
1754HRESULT Machine::setVideoCaptureFile(const com::Utf8Str &aVideoCaptureFile)
1755{
1756 Utf8Str strFile(aVideoCaptureFile);
1757 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1758
1759 if ( Global::IsOnline(mData->mMachineState)
1760 && mHWData->mVideoCaptureEnabled)
1761 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1762
1763 if (!RTPathStartsWithRoot(strFile.c_str()))
1764 return setError(E_INVALIDARG, tr("Video capture file name '%s' is not absolute"), strFile.c_str());
1765
1766 if (!strFile.isEmpty())
1767 {
1768 Utf8Str defaultFile;
1769 i_getDefaultVideoCaptureFile(defaultFile);
1770 if (!RTPathCompare(strFile.c_str(), defaultFile.c_str()))
1771 strFile.setNull();
1772 }
1773
1774 i_setModified(IsModified_MachineData);
1775 mHWData.backup();
1776 mHWData->mVideoCaptureFile = strFile;
1777
1778 return S_OK;
1779}
1780
1781HRESULT Machine::getVideoCaptureWidth(ULONG *aVideoCaptureWidth)
1782{
1783 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1784 *aVideoCaptureWidth = mHWData->mVideoCaptureWidth;
1785 return S_OK;
1786}
1787
1788HRESULT Machine::setVideoCaptureWidth(ULONG aVideoCaptureWidth)
1789{
1790 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1791
1792 if ( Global::IsOnline(mData->mMachineState)
1793 && mHWData->mVideoCaptureEnabled)
1794 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1795
1796 i_setModified(IsModified_MachineData);
1797 mHWData.backup();
1798 mHWData->mVideoCaptureWidth = aVideoCaptureWidth;
1799
1800 return S_OK;
1801}
1802
1803HRESULT Machine::getVideoCaptureHeight(ULONG *aVideoCaptureHeight)
1804{
1805 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1806 *aVideoCaptureHeight = mHWData->mVideoCaptureHeight;
1807 return S_OK;
1808}
1809
1810HRESULT Machine::setVideoCaptureHeight(ULONG aVideoCaptureHeight)
1811{
1812 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1813
1814 if ( Global::IsOnline(mData->mMachineState)
1815 && mHWData->mVideoCaptureEnabled)
1816 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1817
1818 i_setModified(IsModified_MachineData);
1819 mHWData.backup();
1820 mHWData->mVideoCaptureHeight = aVideoCaptureHeight;
1821
1822 return S_OK;
1823}
1824
1825HRESULT Machine::getVideoCaptureRate(ULONG *aVideoCaptureRate)
1826{
1827 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1828 *aVideoCaptureRate = mHWData->mVideoCaptureRate;
1829 return S_OK;
1830}
1831
1832HRESULT Machine::setVideoCaptureRate(ULONG aVideoCaptureRate)
1833{
1834 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1835
1836 if ( Global::IsOnline(mData->mMachineState)
1837 && mHWData->mVideoCaptureEnabled)
1838 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1839
1840 i_setModified(IsModified_MachineData);
1841 mHWData.backup();
1842 mHWData->mVideoCaptureRate = aVideoCaptureRate;
1843
1844 return S_OK;
1845}
1846
1847HRESULT Machine::getVideoCaptureFPS(ULONG *aVideoCaptureFPS)
1848{
1849 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1850 *aVideoCaptureFPS = mHWData->mVideoCaptureFPS;
1851 return S_OK;
1852}
1853
1854HRESULT Machine::setVideoCaptureFPS(ULONG aVideoCaptureFPS)
1855{
1856 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1857
1858 if ( Global::IsOnline(mData->mMachineState)
1859 && mHWData->mVideoCaptureEnabled)
1860 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1861
1862 i_setModified(IsModified_MachineData);
1863 mHWData.backup();
1864 mHWData->mVideoCaptureFPS = aVideoCaptureFPS;
1865
1866 return S_OK;
1867}
1868
1869HRESULT Machine::getVideoCaptureMaxTime(ULONG *aVideoCaptureMaxTime)
1870{
1871 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1872 *aVideoCaptureMaxTime = mHWData->mVideoCaptureMaxTime;
1873 return S_OK;
1874}
1875
1876HRESULT Machine::setVideoCaptureMaxTime(ULONG aVideoCaptureMaxTime)
1877{
1878 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1879
1880 if ( Global::IsOnline(mData->mMachineState)
1881 && mHWData->mVideoCaptureEnabled)
1882 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1883
1884 i_setModified(IsModified_MachineData);
1885 mHWData.backup();
1886 mHWData->mVideoCaptureMaxTime = aVideoCaptureMaxTime;
1887
1888 return S_OK;
1889}
1890
1891HRESULT Machine::getVideoCaptureMaxFileSize(ULONG *aVideoCaptureMaxFileSize)
1892{
1893 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1894 *aVideoCaptureMaxFileSize = mHWData->mVideoCaptureMaxFileSize;
1895 return S_OK;
1896}
1897
1898HRESULT Machine::setVideoCaptureMaxFileSize(ULONG aVideoCaptureMaxFileSize)
1899{
1900 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1901
1902 if ( Global::IsOnline(mData->mMachineState)
1903 && mHWData->mVideoCaptureEnabled)
1904 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1905
1906 i_setModified(IsModified_MachineData);
1907 mHWData.backup();
1908 mHWData->mVideoCaptureMaxFileSize = aVideoCaptureMaxFileSize;
1909
1910 return S_OK;
1911}
1912
1913HRESULT Machine::getVideoCaptureOptions(com::Utf8Str &aVideoCaptureOptions)
1914{
1915 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1916
1917 aVideoCaptureOptions = mHWData->mVideoCaptureOptions;
1918 return S_OK;
1919}
1920
1921HRESULT Machine::setVideoCaptureOptions(const com::Utf8Str &aVideoCaptureOptions)
1922{
1923 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1924
1925 if ( Global::IsOnline(mData->mMachineState)
1926 && mHWData->mVideoCaptureEnabled)
1927 return setError(E_INVALIDARG, tr("Cannot change parameters while capturing is enabled"));
1928
1929 i_setModified(IsModified_MachineData);
1930 mHWData.backup();
1931 mHWData->mVideoCaptureOptions = aVideoCaptureOptions;
1932
1933 return S_OK;
1934}
1935
1936HRESULT Machine::getGraphicsControllerType(GraphicsControllerType_T *aGraphicsControllerType)
1937{
1938 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1939
1940 *aGraphicsControllerType = mHWData->mGraphicsControllerType;
1941
1942 return S_OK;
1943}
1944
1945HRESULT Machine::setGraphicsControllerType(GraphicsControllerType_T aGraphicsControllerType)
1946{
1947 switch (aGraphicsControllerType)
1948 {
1949 case GraphicsControllerType_Null:
1950 case GraphicsControllerType_VBoxVGA:
1951#ifdef VBOX_WITH_VMSVGA
1952 case GraphicsControllerType_VMSVGA:
1953#endif
1954 break;
1955 default:
1956 return setError(E_INVALIDARG, tr("The graphics controller type (%d) is invalid"), aGraphicsControllerType);
1957 }
1958
1959 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1960
1961 HRESULT rc = i_checkStateDependency(MutableStateDep);
1962 if (FAILED(rc)) return rc;
1963
1964 i_setModified(IsModified_MachineData);
1965 mHWData.backup();
1966 mHWData->mGraphicsControllerType = aGraphicsControllerType;
1967
1968 return S_OK;
1969}
1970
1971HRESULT Machine::getVRAMSize(ULONG *aVRAMSize)
1972{
1973 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1974
1975 *aVRAMSize = mHWData->mVRAMSize;
1976
1977 return S_OK;
1978}
1979
1980HRESULT Machine::setVRAMSize(ULONG aVRAMSize)
1981{
1982 /* check VRAM limits */
1983 if (aVRAMSize < SchemaDefs::MinGuestVRAM ||
1984 aVRAMSize > SchemaDefs::MaxGuestVRAM)
1985 return setError(E_INVALIDARG,
1986 tr("Invalid VRAM size: %lu MB (must be in range [%lu, %lu] MB)"),
1987 aVRAMSize, SchemaDefs::MinGuestVRAM, SchemaDefs::MaxGuestVRAM);
1988
1989 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1990
1991 HRESULT rc = i_checkStateDependency(MutableStateDep);
1992 if (FAILED(rc)) return rc;
1993
1994 i_setModified(IsModified_MachineData);
1995 mHWData.backup();
1996 mHWData->mVRAMSize = aVRAMSize;
1997
1998 return S_OK;
1999}
2000
2001/** @todo this method should not be public */
2002HRESULT Machine::getMemoryBalloonSize(ULONG *aMemoryBalloonSize)
2003{
2004 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2005
2006 *aMemoryBalloonSize = mHWData->mMemoryBalloonSize;
2007
2008 return S_OK;
2009}
2010
2011/**
2012 * Set the memory balloon size.
2013 *
2014 * This method is also called from IGuest::COMSETTER(MemoryBalloonSize) so
2015 * we have to make sure that we never call IGuest from here.
2016 */
2017HRESULT Machine::setMemoryBalloonSize(ULONG aMemoryBalloonSize)
2018{
2019 /* This must match GMMR0Init; currently we only support memory ballooning on all 64-bit hosts except Mac OS X */
2020#if HC_ARCH_BITS == 64 && (defined(RT_OS_WINDOWS) || defined(RT_OS_SOLARIS) || defined(RT_OS_LINUX) || defined(RT_OS_FREEBSD))
2021 /* check limits */
2022 if (aMemoryBalloonSize >= VMMDEV_MAX_MEMORY_BALLOON(mHWData->mMemorySize))
2023 return setError(E_INVALIDARG,
2024 tr("Invalid memory balloon size: %lu MB (must be in range [%lu, %lu] MB)"),
2025 aMemoryBalloonSize, 0, VMMDEV_MAX_MEMORY_BALLOON(mHWData->mMemorySize));
2026
2027 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2028
2029 i_setModified(IsModified_MachineData);
2030 mHWData.backup();
2031 mHWData->mMemoryBalloonSize = aMemoryBalloonSize;
2032
2033 return S_OK;
2034#else
2035 NOREF(aMemoryBalloonSize);
2036 return setError(E_NOTIMPL, tr("Memory ballooning is only supported on 64-bit hosts"));
2037#endif
2038}
2039
2040HRESULT Machine::getPageFusionEnabled(BOOL *aPageFusionEnabled)
2041{
2042 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2043
2044 *aPageFusionEnabled = mHWData->mPageFusionEnabled;
2045 return S_OK;
2046}
2047
2048HRESULT Machine::setPageFusionEnabled(BOOL aPageFusionEnabled)
2049{
2050#ifdef VBOX_WITH_PAGE_SHARING
2051 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2052
2053 /** @todo must support changes for running vms and keep this in sync with IGuest. */
2054 i_setModified(IsModified_MachineData);
2055 mHWData.backup();
2056 mHWData->mPageFusionEnabled = aPageFusionEnabled;
2057 return S_OK;
2058#else
2059 NOREF(aPageFusionEnabled);
2060 return setError(E_NOTIMPL, tr("Page fusion is only supported on 64-bit hosts"));
2061#endif
2062}
2063
2064HRESULT Machine::getAccelerate3DEnabled(BOOL *aAccelerate3DEnabled)
2065{
2066 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2067
2068 *aAccelerate3DEnabled = mHWData->mAccelerate3DEnabled;
2069
2070 return S_OK;
2071}
2072
2073HRESULT Machine::setAccelerate3DEnabled(BOOL aAccelerate3DEnabled)
2074{
2075 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2076
2077 HRESULT rc = i_checkStateDependency(MutableStateDep);
2078 if (FAILED(rc)) return rc;
2079
2080 /** @todo check validity! */
2081
2082 i_setModified(IsModified_MachineData);
2083 mHWData.backup();
2084 mHWData->mAccelerate3DEnabled = aAccelerate3DEnabled;
2085
2086 return S_OK;
2087}
2088
2089
2090HRESULT Machine::getAccelerate2DVideoEnabled(BOOL *aAccelerate2DVideoEnabled)
2091{
2092 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2093
2094 *aAccelerate2DVideoEnabled = mHWData->mAccelerate2DVideoEnabled;
2095
2096 return S_OK;
2097}
2098
2099HRESULT Machine::setAccelerate2DVideoEnabled(BOOL aAccelerate2DVideoEnabled)
2100{
2101 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2102
2103 HRESULT rc = i_checkStateDependency(MutableStateDep);
2104 if (FAILED(rc)) return rc;
2105
2106 /** @todo check validity! */
2107 i_setModified(IsModified_MachineData);
2108 mHWData.backup();
2109 mHWData->mAccelerate2DVideoEnabled = aAccelerate2DVideoEnabled;
2110
2111 return S_OK;
2112}
2113
2114HRESULT Machine::getMonitorCount(ULONG *aMonitorCount)
2115{
2116 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2117
2118 *aMonitorCount = mHWData->mMonitorCount;
2119
2120 return S_OK;
2121}
2122
2123HRESULT Machine::setMonitorCount(ULONG aMonitorCount)
2124{
2125 /* make sure monitor count is a sensible number */
2126 if (aMonitorCount < 1 || aMonitorCount > SchemaDefs::MaxGuestMonitors)
2127 return setError(E_INVALIDARG,
2128 tr("Invalid monitor count: %lu (must be in range [%lu, %lu])"),
2129 aMonitorCount, 1, SchemaDefs::MaxGuestMonitors);
2130
2131 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2132
2133 HRESULT rc = i_checkStateDependency(MutableStateDep);
2134 if (FAILED(rc)) return rc;
2135
2136 i_setModified(IsModified_MachineData);
2137 mHWData.backup();
2138 mHWData->mMonitorCount = aMonitorCount;
2139
2140 return S_OK;
2141}
2142
2143HRESULT Machine::getBIOSSettings(ComPtr<IBIOSSettings> &aBIOSSettings)
2144{
2145 /* mBIOSSettings is constant during life time, no need to lock */
2146 aBIOSSettings = mBIOSSettings;
2147
2148 return S_OK;
2149}
2150
2151HRESULT Machine::getCPUProperty(CPUPropertyType_T aProperty, BOOL *aValue)
2152{
2153 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2154
2155 switch (aProperty)
2156 {
2157 case CPUPropertyType_PAE:
2158 *aValue = mHWData->mPAEEnabled;
2159 break;
2160
2161 case CPUPropertyType_LongMode:
2162 if (mHWData->mLongMode == settings::Hardware::LongMode_Enabled)
2163 *aValue = TRUE;
2164 else if (mHWData->mLongMode == settings::Hardware::LongMode_Disabled)
2165 *aValue = FALSE;
2166#if HC_ARCH_BITS == 64
2167 else
2168 *aValue = TRUE;
2169#else
2170 else
2171 {
2172 *aValue = FALSE;
2173
2174 ComPtr<IGuestOSType> ptrGuestOSType;
2175 HRESULT hrc2 = mParent->GetGuestOSType(Bstr(mUserData->s.strOsType).raw(), ptrGuestOSType.asOutParam());
2176 if (SUCCEEDED(hrc2))
2177 {
2178 BOOL fIs64Bit = FALSE;
2179 hrc2 = ptrGuestOSType->COMGETTER(Is64Bit)(&fIs64Bit); AssertComRC(hrc2);
2180 if (SUCCEEDED(hrc2) && fIs64Bit)
2181 {
2182 ComObjPtr<Host> ptrHost = mParent->i_host();
2183 alock.release();
2184
2185 hrc2 = ptrHost->GetProcessorFeature(ProcessorFeature_LongMode, aValue); AssertComRC(hrc2);
2186 if (FAILED(hrc2))
2187 *aValue = FALSE;
2188 }
2189 }
2190 }
2191#endif
2192 break;
2193
2194 case CPUPropertyType_TripleFaultReset:
2195 *aValue = mHWData->mTripleFaultReset;
2196 break;
2197
2198 default:
2199 return E_INVALIDARG;
2200 }
2201 return S_OK;
2202}
2203
2204HRESULT Machine::setCPUProperty(CPUPropertyType_T aProperty, BOOL aValue)
2205{
2206 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2207
2208 HRESULT rc = i_checkStateDependency(MutableStateDep);
2209 if (FAILED(rc)) return rc;
2210
2211 switch (aProperty)
2212 {
2213 case CPUPropertyType_PAE:
2214 i_setModified(IsModified_MachineData);
2215 mHWData.backup();
2216 mHWData->mPAEEnabled = !!aValue;
2217 break;
2218
2219 case CPUPropertyType_LongMode:
2220 i_setModified(IsModified_MachineData);
2221 mHWData.backup();
2222 mHWData->mLongMode = !aValue ? settings::Hardware::LongMode_Disabled : settings::Hardware::LongMode_Enabled;
2223 break;
2224
2225 case CPUPropertyType_TripleFaultReset:
2226 i_setModified(IsModified_MachineData);
2227 mHWData.backup();
2228 mHWData->mTripleFaultReset = !!aValue;
2229 break;
2230
2231 default:
2232 return E_INVALIDARG;
2233 }
2234 return S_OK;
2235}
2236
2237HRESULT Machine::getCPUIDLeaf(ULONG aId, ULONG *aValEax, ULONG *aValEbx, ULONG *aValEcx, ULONG *aValEdx)
2238{
2239 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2240
2241 switch(aId)
2242 {
2243 case 0x0:
2244 case 0x1:
2245 case 0x2:
2246 case 0x3:
2247 case 0x4:
2248 case 0x5:
2249 case 0x6:
2250 case 0x7:
2251 case 0x8:
2252 case 0x9:
2253 case 0xA:
2254 if (mHWData->mCpuIdStdLeafs[aId].ulId != aId)
2255 return E_INVALIDARG;
2256
2257 *aValEax = mHWData->mCpuIdStdLeafs[aId].ulEax;
2258 *aValEbx = mHWData->mCpuIdStdLeafs[aId].ulEbx;
2259 *aValEcx = mHWData->mCpuIdStdLeafs[aId].ulEcx;
2260 *aValEdx = mHWData->mCpuIdStdLeafs[aId].ulEdx;
2261 break;
2262
2263 case 0x80000000:
2264 case 0x80000001:
2265 case 0x80000002:
2266 case 0x80000003:
2267 case 0x80000004:
2268 case 0x80000005:
2269 case 0x80000006:
2270 case 0x80000007:
2271 case 0x80000008:
2272 case 0x80000009:
2273 case 0x8000000A:
2274 if (mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulId != aId)
2275 return E_INVALIDARG;
2276
2277 *aValEax = mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEax;
2278 *aValEbx = mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEbx;
2279 *aValEcx = mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEcx;
2280 *aValEdx = mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEdx;
2281 break;
2282
2283 default:
2284 return setError(E_INVALIDARG, tr("CpuId override leaf %#x is out of range"), aId);
2285 }
2286 return S_OK;
2287}
2288
2289
2290HRESULT Machine::setCPUIDLeaf(ULONG aId, ULONG aValEax, ULONG aValEbx, ULONG aValEcx, ULONG aValEdx)
2291{
2292 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2293
2294 HRESULT rc = i_checkStateDependency(MutableStateDep);
2295 if (FAILED(rc)) return rc;
2296
2297 switch(aId)
2298 {
2299 case 0x0:
2300 case 0x1:
2301 case 0x2:
2302 case 0x3:
2303 case 0x4:
2304 case 0x5:
2305 case 0x6:
2306 case 0x7:
2307 case 0x8:
2308 case 0x9:
2309 case 0xA:
2310 AssertCompile(RT_ELEMENTS(mHWData->mCpuIdStdLeafs) == 0xB);
2311 AssertRelease(aId < RT_ELEMENTS(mHWData->mCpuIdStdLeafs));
2312 i_setModified(IsModified_MachineData);
2313 mHWData.backup();
2314 mHWData->mCpuIdStdLeafs[aId].ulId = aId;
2315 mHWData->mCpuIdStdLeafs[aId].ulEax = aValEax;
2316 mHWData->mCpuIdStdLeafs[aId].ulEbx = aValEbx;
2317 mHWData->mCpuIdStdLeafs[aId].ulEcx = aValEcx;
2318 mHWData->mCpuIdStdLeafs[aId].ulEdx = aValEdx;
2319 break;
2320
2321 case 0x80000000:
2322 case 0x80000001:
2323 case 0x80000002:
2324 case 0x80000003:
2325 case 0x80000004:
2326 case 0x80000005:
2327 case 0x80000006:
2328 case 0x80000007:
2329 case 0x80000008:
2330 case 0x80000009:
2331 case 0x8000000A:
2332 AssertCompile(RT_ELEMENTS(mHWData->mCpuIdExtLeafs) == 0xB);
2333 AssertRelease(aId - 0x80000000 < RT_ELEMENTS(mHWData->mCpuIdExtLeafs));
2334 i_setModified(IsModified_MachineData);
2335 mHWData.backup();
2336 mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulId = aId;
2337 mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEax = aValEax;
2338 mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEbx = aValEbx;
2339 mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEcx = aValEcx;
2340 mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulEdx = aValEdx;
2341 break;
2342
2343 default:
2344 return setError(E_INVALIDARG, tr("CpuId override leaf %#x is out of range"), aId);
2345 }
2346 return S_OK;
2347}
2348
2349HRESULT Machine::removeCPUIDLeaf(ULONG aId)
2350{
2351 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2352
2353 HRESULT rc = i_checkStateDependency(MutableStateDep);
2354 if (FAILED(rc)) return rc;
2355
2356 switch(aId)
2357 {
2358 case 0x0:
2359 case 0x1:
2360 case 0x2:
2361 case 0x3:
2362 case 0x4:
2363 case 0x5:
2364 case 0x6:
2365 case 0x7:
2366 case 0x8:
2367 case 0x9:
2368 case 0xA:
2369 AssertCompile(RT_ELEMENTS(mHWData->mCpuIdStdLeafs) == 0xB);
2370 AssertRelease(aId < RT_ELEMENTS(mHWData->mCpuIdStdLeafs));
2371 i_setModified(IsModified_MachineData);
2372 mHWData.backup();
2373 /* Invalidate leaf. */
2374 mHWData->mCpuIdStdLeafs[aId].ulId = UINT32_MAX;
2375 break;
2376
2377 case 0x80000000:
2378 case 0x80000001:
2379 case 0x80000002:
2380 case 0x80000003:
2381 case 0x80000004:
2382 case 0x80000005:
2383 case 0x80000006:
2384 case 0x80000007:
2385 case 0x80000008:
2386 case 0x80000009:
2387 case 0x8000000A:
2388 AssertCompile(RT_ELEMENTS(mHWData->mCpuIdExtLeafs) == 0xB);
2389 AssertRelease(aId - 0x80000000 < RT_ELEMENTS(mHWData->mCpuIdExtLeafs));
2390 i_setModified(IsModified_MachineData);
2391 mHWData.backup();
2392 /* Invalidate leaf. */
2393 mHWData->mCpuIdExtLeafs[aId - 0x80000000].ulId = UINT32_MAX;
2394 break;
2395
2396 default:
2397 return setError(E_INVALIDARG, tr("CpuId override leaf %#x is out of range"), aId);
2398 }
2399 return S_OK;
2400}
2401
2402HRESULT Machine::removeAllCPUIDLeaves()
2403{
2404 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2405
2406 HRESULT rc = i_checkStateDependency(MutableStateDep);
2407 if (FAILED(rc)) return rc;
2408
2409 i_setModified(IsModified_MachineData);
2410 mHWData.backup();
2411
2412 /* Invalidate all standard leafs. */
2413 for (unsigned i = 0; i < RT_ELEMENTS(mHWData->mCpuIdStdLeafs); ++i)
2414 mHWData->mCpuIdStdLeafs[i].ulId = UINT32_MAX;
2415
2416 /* Invalidate all extended leafs. */
2417 for (unsigned i = 0; i < RT_ELEMENTS(mHWData->mCpuIdExtLeafs); ++i)
2418 mHWData->mCpuIdExtLeafs[i].ulId = UINT32_MAX;
2419
2420 return S_OK;
2421}
2422HRESULT Machine::getHWVirtExProperty(HWVirtExPropertyType_T aProperty, BOOL *aValue)
2423{
2424 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2425
2426 switch(aProperty)
2427 {
2428 case HWVirtExPropertyType_Enabled:
2429 *aValue = mHWData->mHWVirtExEnabled;
2430 break;
2431
2432 case HWVirtExPropertyType_VPID:
2433 *aValue = mHWData->mHWVirtExVPIDEnabled;
2434 break;
2435
2436 case HWVirtExPropertyType_NestedPaging:
2437 *aValue = mHWData->mHWVirtExNestedPagingEnabled;
2438 break;
2439
2440 case HWVirtExPropertyType_UnrestrictedExecution:
2441 *aValue = mHWData->mHWVirtExUXEnabled;
2442 break;
2443
2444 case HWVirtExPropertyType_LargePages:
2445 *aValue = mHWData->mHWVirtExLargePagesEnabled;
2446#if defined(DEBUG_bird) && defined(RT_OS_LINUX) /* This feature is deadly here */
2447 *aValue = FALSE;
2448#endif
2449 break;
2450
2451 case HWVirtExPropertyType_Force:
2452 *aValue = mHWData->mHWVirtExForceEnabled;
2453 break;
2454
2455 default:
2456 return E_INVALIDARG;
2457 }
2458 return S_OK;
2459}
2460
2461HRESULT Machine::setHWVirtExProperty(HWVirtExPropertyType_T aProperty, BOOL aValue)
2462{
2463 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2464
2465 HRESULT rc = i_checkStateDependency(MutableStateDep);
2466 if (FAILED(rc)) return rc;
2467
2468 switch(aProperty)
2469 {
2470 case HWVirtExPropertyType_Enabled:
2471 i_setModified(IsModified_MachineData);
2472 mHWData.backup();
2473 mHWData->mHWVirtExEnabled = !!aValue;
2474 break;
2475
2476 case HWVirtExPropertyType_VPID:
2477 i_setModified(IsModified_MachineData);
2478 mHWData.backup();
2479 mHWData->mHWVirtExVPIDEnabled = !!aValue;
2480 break;
2481
2482 case HWVirtExPropertyType_NestedPaging:
2483 i_setModified(IsModified_MachineData);
2484 mHWData.backup();
2485 mHWData->mHWVirtExNestedPagingEnabled = !!aValue;
2486 break;
2487
2488 case HWVirtExPropertyType_UnrestrictedExecution:
2489 i_setModified(IsModified_MachineData);
2490 mHWData.backup();
2491 mHWData->mHWVirtExUXEnabled = !!aValue;
2492 break;
2493
2494 case HWVirtExPropertyType_LargePages:
2495 i_setModified(IsModified_MachineData);
2496 mHWData.backup();
2497 mHWData->mHWVirtExLargePagesEnabled = !!aValue;
2498 break;
2499
2500 case HWVirtExPropertyType_Force:
2501 i_setModified(IsModified_MachineData);
2502 mHWData.backup();
2503 mHWData->mHWVirtExForceEnabled = !!aValue;
2504 break;
2505
2506 default:
2507 return E_INVALIDARG;
2508 }
2509
2510 return S_OK;
2511}
2512
2513HRESULT Machine::getSnapshotFolder(com::Utf8Str &aSnapshotFolder)
2514{
2515 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2516
2517 i_calculateFullPath(mUserData->s.strSnapshotFolder, aSnapshotFolder);
2518
2519 return S_OK;
2520}
2521
2522HRESULT Machine::setSnapshotFolder(const com::Utf8Str &aSnapshotFolder)
2523{
2524 /* @todo (r=dmik):
2525 * 1. Allow to change the name of the snapshot folder containing snapshots
2526 * 2. Rename the folder on disk instead of just changing the property
2527 * value (to be smart and not to leave garbage). Note that it cannot be
2528 * done here because the change may be rolled back. Thus, the right
2529 * place is #saveSettings().
2530 */
2531
2532 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2533
2534 HRESULT rc = i_checkStateDependency(MutableStateDep);
2535 if (FAILED(rc)) return rc;
2536
2537 if (!mData->mCurrentSnapshot.isNull())
2538 return setError(E_FAIL,
2539 tr("The snapshot folder of a machine with snapshots cannot be changed (please delete all snapshots first)"));
2540
2541 Utf8Str strSnapshotFolder(aSnapshotFolder); // keep original
2542
2543 if (strSnapshotFolder.isEmpty())
2544 strSnapshotFolder = "Snapshots";
2545 int vrc = i_calculateFullPath(strSnapshotFolder,
2546 strSnapshotFolder);
2547 if (RT_FAILURE(vrc))
2548 return setError(E_FAIL,
2549 tr("Invalid snapshot folder '%s' (%Rrc)"),
2550 strSnapshotFolder.c_str(), vrc);
2551
2552 i_setModified(IsModified_MachineData);
2553 mUserData.backup();
2554
2555 i_copyPathRelativeToMachine(strSnapshotFolder, mUserData->s.strSnapshotFolder);
2556
2557 return S_OK;
2558}
2559
2560HRESULT Machine::getMediumAttachments(std::vector<ComPtr<IMediumAttachment> > &aMediumAttachments)
2561{
2562 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2563
2564 aMediumAttachments.resize(mMediaData->mAttachments.size());
2565 size_t i = 0;
2566 for (MediaData::AttachmentList::iterator it = mMediaData->mAttachments.begin();
2567 it != mMediaData->mAttachments.end(); ++it, ++i)
2568 aMediumAttachments[i] = *it;
2569
2570 return S_OK;
2571}
2572
2573HRESULT Machine::getVRDEServer(ComPtr<IVRDEServer> &aVRDEServer)
2574{
2575 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2576
2577 Assert(!!mVRDEServer);
2578
2579 aVRDEServer = mVRDEServer;
2580
2581 return S_OK;
2582}
2583
2584HRESULT Machine::getAudioAdapter(ComPtr<IAudioAdapter> &aAudioAdapter)
2585{
2586 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2587
2588 aAudioAdapter = mAudioAdapter;
2589
2590 return S_OK;
2591}
2592
2593HRESULT Machine::getUSBControllers(std::vector<ComPtr<IUSBController> > &aUSBControllers)
2594{
2595#ifdef VBOX_WITH_VUSB
2596 clearError();
2597 MultiResult rc(S_OK);
2598
2599# ifdef VBOX_WITH_USB
2600 rc = mParent->i_host()->i_checkUSBProxyService();
2601 if (FAILED(rc)) return rc;
2602# endif
2603
2604 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2605
2606 USBControllerList data = *mUSBControllers.data();
2607 aUSBControllers.resize(data.size());
2608 size_t i = 0;
2609 for (USBControllerList::iterator it = data.begin(); it != data.end(); ++i, ++it)
2610 aUSBControllers[i] = *it;
2611
2612 return S_OK;
2613#else
2614 /* Note: The GUI depends on this method returning E_NOTIMPL with no
2615 * extended error info to indicate that USB is simply not available
2616 * (w/o treating it as a failure), for example, as in OSE */
2617 NOREF(aUSBControllers);
2618 ReturnComNotImplemented();
2619#endif /* VBOX_WITH_VUSB */
2620}
2621
2622HRESULT Machine::getUSBDeviceFilters(ComPtr<IUSBDeviceFilters> &aUSBDeviceFilters)
2623{
2624#ifdef VBOX_WITH_VUSB
2625 clearError();
2626 MultiResult rc(S_OK);
2627
2628# ifdef VBOX_WITH_USB
2629 rc = mParent->i_host()->i_checkUSBProxyService();
2630 if (FAILED(rc)) return rc;
2631# endif
2632
2633 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2634
2635 aUSBDeviceFilters = mUSBDeviceFilters;
2636 return rc;
2637#else
2638 /* Note: The GUI depends on this method returning E_NOTIMPL with no
2639 * extended error info to indicate that USB is simply not available
2640 * (w/o treating it as a failure), for example, as in OSE */
2641 NOREF(aUSBDeviceFilters);
2642 ReturnComNotImplemented();
2643#endif /* VBOX_WITH_VUSB */
2644}
2645
2646HRESULT Machine::getSettingsFilePath(com::Utf8Str &aSettingsFilePath)
2647{
2648 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2649
2650 aSettingsFilePath = mData->m_strConfigFileFull;
2651
2652 return S_OK;
2653}
2654
2655HRESULT Machine::getSettingsModified(BOOL *aSettingsModified)
2656{
2657 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2658
2659 HRESULT rc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
2660 if (FAILED(rc)) return rc;
2661
2662 if (!mData->pMachineConfigFile->fileExists())
2663 // this is a new machine, and no config file exists yet:
2664 *aSettingsModified = TRUE;
2665 else
2666 *aSettingsModified = (mData->flModifications != 0);
2667
2668 return S_OK;
2669}
2670
2671HRESULT Machine::getSessionState(SessionState_T *aSessionState)
2672{
2673 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2674
2675 *aSessionState = mData->mSession.mState;
2676
2677 return S_OK;
2678}
2679
2680HRESULT Machine::getSessionName(com::Utf8Str &aSessionName)
2681{
2682 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2683
2684 aSessionName = mData->mSession.mName;
2685
2686 return S_OK;
2687}
2688
2689HRESULT Machine::getSessionPID(ULONG *aSessionPID)
2690{
2691 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2692
2693 *aSessionPID = mData->mSession.mPID;
2694
2695 return S_OK;
2696}
2697
2698HRESULT Machine::getState(MachineState_T *aState)
2699{
2700 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2701
2702 *aState = mData->mMachineState;
2703 Assert(mData->mMachineState != MachineState_Null);
2704
2705 return S_OK;
2706}
2707
2708HRESULT Machine::getLastStateChange(LONG64 *aLastStateChange)
2709{
2710 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2711
2712 *aLastStateChange = RTTimeSpecGetMilli(&mData->mLastStateChange);
2713
2714 return S_OK;
2715}
2716
2717HRESULT Machine::getStateFilePath(com::Utf8Str &aStateFilePath)
2718{
2719 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2720
2721 aStateFilePath = mSSData->strStateFilePath;
2722
2723 return S_OK;
2724}
2725
2726HRESULT Machine::getLogFolder(com::Utf8Str &aLogFolder)
2727{
2728 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2729
2730 i_getLogFolder(aLogFolder);
2731
2732 return S_OK;
2733}
2734
2735HRESULT Machine::getCurrentSnapshot(ComPtr<ISnapshot> &aCurrentSnapshot)
2736{
2737 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2738
2739 aCurrentSnapshot = mData->mCurrentSnapshot;
2740
2741 return S_OK;
2742}
2743
2744HRESULT Machine::getSnapshotCount(ULONG *aSnapshotCount)
2745{
2746 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2747
2748 *aSnapshotCount = mData->mFirstSnapshot.isNull()
2749 ? 0
2750 : mData->mFirstSnapshot->i_getAllChildrenCount() + 1;
2751
2752 return S_OK;
2753}
2754
2755HRESULT Machine::getCurrentStateModified(BOOL *aCurrentStateModified)
2756{
2757 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2758
2759 /* Note: for machines with no snapshots, we always return FALSE
2760 * (mData->mCurrentStateModified will be TRUE in this case, for historical
2761 * reasons :) */
2762
2763 *aCurrentStateModified = mData->mFirstSnapshot.isNull()
2764 ? FALSE
2765 : mData->mCurrentStateModified;
2766
2767 return S_OK;
2768}
2769
2770HRESULT Machine::getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders)
2771{
2772 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2773
2774 aSharedFolders.resize(mHWData->mSharedFolders.size());
2775 size_t i = 0;
2776 for (std::list<ComObjPtr<SharedFolder> >::iterator it = mHWData->mSharedFolders.begin();
2777 it != mHWData->mSharedFolders.end(); ++i, ++it)
2778 aSharedFolders[i] = *it;
2779
2780 return S_OK;
2781}
2782
2783HRESULT Machine::getClipboardMode(ClipboardMode_T *aClipboardMode)
2784{
2785 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2786
2787 *aClipboardMode = mHWData->mClipboardMode;
2788
2789 return S_OK;
2790}
2791
2792HRESULT Machine::setClipboardMode(ClipboardMode_T aClipboardMode)
2793{
2794 HRESULT rc = S_OK;
2795
2796 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2797
2798 alock.release();
2799 rc = i_onClipboardModeChange(aClipboardMode);
2800 alock.acquire();
2801 if (FAILED(rc)) return rc;
2802
2803 i_setModified(IsModified_MachineData);
2804 mHWData.backup();
2805 mHWData->mClipboardMode = aClipboardMode;
2806
2807 /** Save settings if online - @todo why is this required? -- @bugref{6818} */
2808 if (Global::IsOnline(mData->mMachineState))
2809 i_saveSettings(NULL);
2810
2811 return S_OK;
2812}
2813
2814HRESULT Machine::getDnDMode(DnDMode_T *aDnDMode)
2815{
2816 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2817
2818 *aDnDMode = mHWData->mDnDMode;
2819
2820 return S_OK;
2821}
2822
2823HRESULT Machine::setDnDMode(DnDMode_T aDnDMode)
2824{
2825 HRESULT rc = S_OK;
2826
2827 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2828
2829 alock.release();
2830 rc = i_onDnDModeChange(aDnDMode);
2831
2832 alock.acquire();
2833 if (FAILED(rc)) return rc;
2834
2835 i_setModified(IsModified_MachineData);
2836 mHWData.backup();
2837 mHWData->mDnDMode = aDnDMode;
2838
2839 /** Save settings if online - @todo why is this required? -- @bugref{6818} */
2840 if (Global::IsOnline(mData->mMachineState))
2841 i_saveSettings(NULL);
2842
2843 return S_OK;
2844}
2845
2846HRESULT Machine::getStorageControllers(std::vector<ComPtr<IStorageController> > &aStorageControllers)
2847{
2848 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2849 StorageControllerList data = *mStorageControllers.data();
2850 size_t i = 0;
2851 aStorageControllers.resize(data.size());
2852 for (StorageControllerList::iterator it = data.begin(); it != data.end(); ++it, ++i)
2853 aStorageControllers[i] = *it;
2854 return S_OK;
2855}
2856
2857HRESULT Machine::getTeleporterEnabled(BOOL *aEnabled)
2858{
2859 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2860
2861 *aEnabled = mUserData->s.fTeleporterEnabled;
2862
2863 return S_OK;
2864}
2865
2866HRESULT Machine::setTeleporterEnabled(BOOL aTeleporterEnabled)
2867{
2868 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2869
2870 /* Only allow it to be set to true when PoweredOff or Aborted.
2871 (Clearing it is always permitted.) */
2872 if ( aTeleporterEnabled
2873 && mData->mRegistered
2874 && ( !i_isSessionMachine()
2875 || ( mData->mMachineState != MachineState_PoweredOff
2876 && mData->mMachineState != MachineState_Teleported
2877 && mData->mMachineState != MachineState_Aborted
2878 )
2879 )
2880 )
2881 return setError(VBOX_E_INVALID_VM_STATE,
2882 tr("The machine is not powered off (state is %s)"),
2883 Global::stringifyMachineState(mData->mMachineState));
2884
2885 i_setModified(IsModified_MachineData);
2886 mUserData.backup();
2887 mUserData->s.fTeleporterEnabled = !! aTeleporterEnabled;
2888
2889 return S_OK;
2890}
2891
2892HRESULT Machine::getTeleporterPort(ULONG *aTeleporterPort)
2893{
2894 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2895
2896 *aTeleporterPort = (ULONG)mUserData->s.uTeleporterPort;
2897
2898 return S_OK;
2899}
2900
2901HRESULT Machine::setTeleporterPort(ULONG aTeleporterPort)
2902{
2903 if (aTeleporterPort >= _64K)
2904 return setError(E_INVALIDARG, tr("Invalid port number %d"), aTeleporterPort);
2905
2906 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2907
2908 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
2909 if (FAILED(rc)) return rc;
2910
2911 i_setModified(IsModified_MachineData);
2912 mUserData.backup();
2913 mUserData->s.uTeleporterPort = (uint32_t)aTeleporterPort;
2914
2915 return S_OK;
2916}
2917
2918HRESULT Machine::getTeleporterAddress(com::Utf8Str &aTeleporterAddress)
2919{
2920 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2921
2922 aTeleporterAddress = mUserData->s.strTeleporterAddress;
2923
2924 return S_OK;
2925}
2926
2927HRESULT Machine::setTeleporterAddress(const com::Utf8Str &aTeleporterAddress)
2928{
2929 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2930
2931 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
2932 if (FAILED(rc)) return rc;
2933
2934 i_setModified(IsModified_MachineData);
2935 mUserData.backup();
2936 mUserData->s.strTeleporterAddress = aTeleporterAddress;
2937
2938 return S_OK;
2939}
2940
2941HRESULT Machine::getTeleporterPassword(com::Utf8Str &aTeleporterPassword)
2942{
2943 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2944 aTeleporterPassword = mUserData->s.strTeleporterPassword;
2945
2946 return S_OK;
2947}
2948
2949HRESULT Machine::setTeleporterPassword(const com::Utf8Str &aTeleporterPassword)
2950{
2951 /*
2952 * Hash the password first.
2953 */
2954 com::Utf8Str aT = aTeleporterPassword;
2955
2956 if (!aT.isEmpty())
2957 {
2958 if (VBoxIsPasswordHashed(&aT))
2959 return setError(E_INVALIDARG, tr("Cannot set an already hashed password, only plain text password please"));
2960 VBoxHashPassword(&aT);
2961 }
2962
2963 /*
2964 * Do the update.
2965 */
2966 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2967 HRESULT hrc = i_checkStateDependency(MutableOrSavedStateDep);
2968 if (SUCCEEDED(hrc))
2969 {
2970 i_setModified(IsModified_MachineData);
2971 mUserData.backup();
2972 mUserData->s.strTeleporterPassword = aT;
2973 }
2974
2975 return hrc;
2976}
2977
2978HRESULT Machine::getFaultToleranceState(FaultToleranceState_T *aFaultToleranceState)
2979{
2980 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
2981
2982 *aFaultToleranceState = mUserData->s.enmFaultToleranceState;
2983 return S_OK;
2984}
2985
2986HRESULT Machine::setFaultToleranceState(FaultToleranceState_T aFaultToleranceState)
2987{
2988 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
2989
2990 /* @todo deal with running state change. */
2991 HRESULT rc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
2992 if (FAILED(rc)) return rc;
2993
2994 i_setModified(IsModified_MachineData);
2995 mUserData.backup();
2996 mUserData->s.enmFaultToleranceState = aFaultToleranceState;
2997 return S_OK;
2998}
2999
3000HRESULT Machine::getFaultToleranceAddress(com::Utf8Str &aFaultToleranceAddress)
3001{
3002 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3003
3004 aFaultToleranceAddress = mUserData->s.strFaultToleranceAddress;
3005 return S_OK;
3006}
3007
3008HRESULT Machine::setFaultToleranceAddress(const com::Utf8Str &aFaultToleranceAddress)
3009{
3010 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3011
3012 /* @todo deal with running state change. */
3013 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
3014 if (FAILED(rc)) return rc;
3015
3016 i_setModified(IsModified_MachineData);
3017 mUserData.backup();
3018 mUserData->s.strFaultToleranceAddress = aFaultToleranceAddress;
3019 return S_OK;
3020}
3021
3022HRESULT Machine::getFaultTolerancePort(ULONG *aFaultTolerancePort)
3023{
3024 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3025
3026 *aFaultTolerancePort = mUserData->s.uFaultTolerancePort;
3027 return S_OK;
3028}
3029
3030HRESULT Machine::setFaultTolerancePort(ULONG aFaultTolerancePort)
3031{
3032 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3033
3034 /* @todo deal with running state change. */
3035 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
3036 if (FAILED(rc)) return rc;
3037
3038 i_setModified(IsModified_MachineData);
3039 mUserData.backup();
3040 mUserData->s.uFaultTolerancePort = aFaultTolerancePort;
3041 return S_OK;
3042}
3043
3044HRESULT Machine::getFaultTolerancePassword(com::Utf8Str &aFaultTolerancePassword)
3045{
3046 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3047
3048 aFaultTolerancePassword = mUserData->s.strFaultTolerancePassword;
3049
3050 return S_OK;
3051}
3052
3053HRESULT Machine::setFaultTolerancePassword(const com::Utf8Str &aFaultTolerancePassword)
3054{
3055 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3056
3057 /* @todo deal with running state change. */
3058 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
3059 if (FAILED(rc)) return rc;
3060
3061 i_setModified(IsModified_MachineData);
3062 mUserData.backup();
3063 mUserData->s.strFaultTolerancePassword = aFaultTolerancePassword;
3064
3065 return S_OK;
3066}
3067
3068HRESULT Machine::getFaultToleranceSyncInterval(ULONG *aFaultToleranceSyncInterval)
3069{
3070 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3071
3072 *aFaultToleranceSyncInterval = mUserData->s.uFaultToleranceInterval;
3073 return S_OK;
3074}
3075
3076HRESULT Machine::setFaultToleranceSyncInterval(ULONG aFaultToleranceSyncInterval)
3077{
3078 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3079
3080 /* @todo deal with running state change. */
3081 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
3082 if (FAILED(rc)) return rc;
3083
3084 i_setModified(IsModified_MachineData);
3085 mUserData.backup();
3086 mUserData->s.uFaultToleranceInterval = aFaultToleranceSyncInterval;
3087 return S_OK;
3088}
3089
3090HRESULT Machine::getRTCUseUTC(BOOL *aRTCUseUTC)
3091{
3092 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3093
3094 *aRTCUseUTC = mUserData->s.fRTCUseUTC;
3095
3096 return S_OK;
3097}
3098
3099HRESULT Machine::setRTCUseUTC(BOOL aRTCUseUTC)
3100{
3101 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3102
3103 /* Only allow it to be set to true when PoweredOff or Aborted.
3104 (Clearing it is always permitted.) */
3105 if ( aRTCUseUTC
3106 && mData->mRegistered
3107 && ( !i_isSessionMachine()
3108 || ( mData->mMachineState != MachineState_PoweredOff
3109 && mData->mMachineState != MachineState_Teleported
3110 && mData->mMachineState != MachineState_Aborted
3111 )
3112 )
3113 )
3114 return setError(VBOX_E_INVALID_VM_STATE,
3115 tr("The machine is not powered off (state is %s)"),
3116 Global::stringifyMachineState(mData->mMachineState));
3117
3118 i_setModified(IsModified_MachineData);
3119 mUserData.backup();
3120 mUserData->s.fRTCUseUTC = !!aRTCUseUTC;
3121
3122 return S_OK;
3123}
3124
3125HRESULT Machine::getIOCacheEnabled(BOOL *aIOCacheEnabled)
3126{
3127 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3128
3129 *aIOCacheEnabled = mHWData->mIOCacheEnabled;
3130
3131 return S_OK;
3132}
3133
3134HRESULT Machine::setIOCacheEnabled(BOOL aIOCacheEnabled)
3135{
3136 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3137
3138 HRESULT rc = i_checkStateDependency(MutableStateDep);
3139 if (FAILED(rc)) return rc;
3140
3141 i_setModified(IsModified_MachineData);
3142 mHWData.backup();
3143 mHWData->mIOCacheEnabled = aIOCacheEnabled;
3144
3145 return S_OK;
3146}
3147
3148HRESULT Machine::getIOCacheSize(ULONG *aIOCacheSize)
3149{
3150 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3151
3152 *aIOCacheSize = mHWData->mIOCacheSize;
3153
3154 return S_OK;
3155}
3156
3157HRESULT Machine::setIOCacheSize(ULONG aIOCacheSize)
3158{
3159 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3160
3161 HRESULT rc = i_checkStateDependency(MutableStateDep);
3162 if (FAILED(rc)) return rc;
3163
3164 i_setModified(IsModified_MachineData);
3165 mHWData.backup();
3166 mHWData->mIOCacheSize = aIOCacheSize;
3167
3168 return S_OK;
3169}
3170
3171
3172/**
3173 * @note Locks objects!
3174 */
3175HRESULT Machine::lockMachine(const ComPtr<ISession> &aSession,
3176 LockType_T aLockType)
3177{
3178 /* check the session state */
3179 SessionState_T state;
3180 HRESULT rc = aSession->COMGETTER(State)(&state);
3181 if (FAILED(rc)) return rc;
3182
3183 if (state != SessionState_Unlocked)
3184 return setError(VBOX_E_INVALID_OBJECT_STATE,
3185 tr("The given session is busy"));
3186
3187 // get the client's IInternalSessionControl interface
3188 ComPtr<IInternalSessionControl> pSessionControl = aSession;
3189 ComAssertMsgRet(!!pSessionControl, ("No IInternalSessionControl interface"),
3190 E_INVALIDARG);
3191
3192 // session name (only used in some code paths)
3193 Utf8Str strSessionName;
3194
3195 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3196
3197 if (!mData->mRegistered)
3198 return setError(E_UNEXPECTED,
3199 tr("The machine '%s' is not registered"),
3200 mUserData->s.strName.c_str());
3201
3202 LogFlowThisFunc(("mSession.mState=%s\n", Global::stringifySessionState(mData->mSession.mState)));
3203
3204 SessionState_T oldState = mData->mSession.mState;
3205 /* Hack: in case the session is closing and there is a progress object
3206 * which allows waiting for the session to be closed, take the opportunity
3207 * and do a limited wait (max. 1 second). This helps a lot when the system
3208 * is busy and thus session closing can take a little while. */
3209 if ( mData->mSession.mState == SessionState_Unlocking
3210 && mData->mSession.mProgress)
3211 {
3212 alock.release();
3213 mData->mSession.mProgress->WaitForCompletion(1000);
3214 alock.acquire();
3215 LogFlowThisFunc(("after waiting: mSession.mState=%s\n", Global::stringifySessionState(mData->mSession.mState)));
3216 }
3217
3218 // try again now
3219 if ( (mData->mSession.mState == SessionState_Locked) // machine is write-locked already
3220 // (i.e. session machine exists)
3221 && (aLockType == LockType_Shared) // caller wants a shared link to the
3222 // existing session that holds the write lock:
3223 )
3224 {
3225 // OK, share the session... we are now dealing with three processes:
3226 // 1) VBoxSVC (where this code runs);
3227 // 2) process C: the caller's client process (who wants a shared session);
3228 // 3) process W: the process which already holds the write lock on the machine (write-locking session)
3229
3230 // copy pointers to W (the write-locking session) before leaving lock (these must not be NULL)
3231 ComPtr<IInternalSessionControl> pSessionW = mData->mSession.mDirectControl;
3232 ComAssertRet(!pSessionW.isNull(), E_FAIL);
3233 ComObjPtr<SessionMachine> pSessionMachine = mData->mSession.mMachine;
3234 AssertReturn(!pSessionMachine.isNull(), E_FAIL);
3235
3236 /*
3237 * Release the lock before calling the client process. It's safe here
3238 * since the only thing to do after we get the lock again is to add
3239 * the remote control to the list (which doesn't directly influence
3240 * anything).
3241 */
3242 alock.release();
3243
3244 // get the console of the session holding the write lock (this is a remote call)
3245 ComPtr<IConsole> pConsoleW;
3246 if (mData->mSession.mLockType == LockType_VM)
3247 {
3248 LogFlowThisFunc(("Calling GetRemoteConsole()...\n"));
3249 rc = pSessionW->COMGETTER(RemoteConsole)(pConsoleW.asOutParam());
3250 LogFlowThisFunc(("GetRemoteConsole() returned %08X\n", rc));
3251 if (FAILED(rc))
3252 // the failure may occur w/o any error info (from RPC), so provide one
3253 return setError(VBOX_E_VM_ERROR,
3254 tr("Failed to get a console object from the direct session (%Rhrc)"), rc);
3255 ComAssertRet(!pConsoleW.isNull(), E_FAIL);
3256 }
3257
3258 // share the session machine and W's console with the caller's session
3259 LogFlowThisFunc(("Calling AssignRemoteMachine()...\n"));
3260 rc = pSessionControl->AssignRemoteMachine(pSessionMachine, pConsoleW);
3261 LogFlowThisFunc(("AssignRemoteMachine() returned %08X\n", rc));
3262
3263 if (FAILED(rc))
3264 // the failure may occur w/o any error info (from RPC), so provide one
3265 return setError(VBOX_E_VM_ERROR,
3266 tr("Failed to assign the machine to the session (%Rhrc)"), rc);
3267 alock.acquire();
3268
3269 // need to revalidate the state after acquiring the lock again
3270 if (mData->mSession.mState != SessionState_Locked)
3271 {
3272 pSessionControl->Uninitialize();
3273 return setError(VBOX_E_INVALID_SESSION_STATE,
3274 tr("The machine '%s' was unlocked unexpectedly while attempting to share its session"),
3275 mUserData->s.strName.c_str());
3276 }
3277
3278 // add the caller's session to the list
3279 mData->mSession.mRemoteControls.push_back(pSessionControl);
3280 }
3281 else if ( mData->mSession.mState == SessionState_Locked
3282 || mData->mSession.mState == SessionState_Unlocking
3283 )
3284 {
3285 // sharing not permitted, or machine still unlocking:
3286 return setError(VBOX_E_INVALID_OBJECT_STATE,
3287 tr("The machine '%s' is already locked for a session (or being unlocked)"),
3288 mUserData->s.strName.c_str());
3289 }
3290 else
3291 {
3292 // machine is not locked: then write-lock the machine (create the session machine)
3293
3294 // must not be busy
3295 AssertReturn(!Global::IsOnlineOrTransient(mData->mMachineState), E_FAIL);
3296
3297 // get the caller's session PID
3298 RTPROCESS pid = NIL_RTPROCESS;
3299 AssertCompile(sizeof(ULONG) == sizeof(RTPROCESS));
3300 pSessionControl->COMGETTER(PID)((ULONG*)&pid);
3301 Assert(pid != NIL_RTPROCESS);
3302
3303 bool fLaunchingVMProcess = (mData->mSession.mState == SessionState_Spawning);
3304
3305 if (fLaunchingVMProcess)
3306 {
3307 if (mData->mSession.mPID == NIL_RTPROCESS)
3308 {
3309 // two or more clients racing for a lock, the one which set the
3310 // session state to Spawning will win, the others will get an
3311 // error as we can't decide here if waiting a little would help
3312 // (only for shared locks this would avoid an error)
3313 return setError(VBOX_E_INVALID_OBJECT_STATE,
3314 tr("The machine '%s' already has a lock request pending"),
3315 mUserData->s.strName.c_str());
3316 }
3317
3318 // this machine is awaiting for a spawning session to be opened:
3319 // then the calling process must be the one that got started by
3320 // LaunchVMProcess()
3321
3322 LogFlowThisFunc(("mSession.mPID=%d(0x%x)\n", mData->mSession.mPID, mData->mSession.mPID));
3323 LogFlowThisFunc(("session.pid=%d(0x%x)\n", pid, pid));
3324
3325#if defined(VBOX_WITH_HARDENING) && defined(RT_OS_WINDOWS)
3326 /* Hardened windows builds spawns three processes when a VM is
3327 launched, the 3rd one is the one that will end up here. */
3328 RTPROCESS ppid;
3329 int rc = RTProcQueryParent(pid, &ppid);
3330 if (RT_SUCCESS(rc))
3331 rc = RTProcQueryParent(ppid, &ppid);
3332 if ( (RT_SUCCESS(rc) && mData->mSession.mPID == ppid)
3333 || rc == VERR_ACCESS_DENIED)
3334 {
3335 LogFlowThisFunc(("mSession.mPID => %d(%#x) - windows hardening stub\n", mData->mSession.mPID, pid));
3336 mData->mSession.mPID = pid;
3337 }
3338#endif
3339
3340 if (mData->mSession.mPID != pid)
3341 return setError(E_ACCESSDENIED,
3342 tr("An unexpected process (PID=0x%08X) has tried to lock the "
3343 "machine '%s', while only the process started by LaunchVMProcess (PID=0x%08X) is allowed"),
3344 pid, mUserData->s.strName.c_str(), mData->mSession.mPID);
3345 }
3346
3347 // create the mutable SessionMachine from the current machine
3348 ComObjPtr<SessionMachine> sessionMachine;
3349 sessionMachine.createObject();
3350 rc = sessionMachine->init(this);
3351 AssertComRC(rc);
3352
3353 /* NOTE: doing return from this function after this point but
3354 * before the end is forbidden since it may call SessionMachine::uninit()
3355 * (through the ComObjPtr's destructor) which requests the VirtualBox write
3356 * lock while still holding the Machine lock in alock so that a deadlock
3357 * is possible due to the wrong lock order. */
3358
3359 if (SUCCEEDED(rc))
3360 {
3361 /*
3362 * Set the session state to Spawning to protect against subsequent
3363 * attempts to open a session and to unregister the machine after
3364 * we release the lock.
3365 */
3366 SessionState_T origState = mData->mSession.mState;
3367 mData->mSession.mState = SessionState_Spawning;
3368
3369#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
3370 /* Get the client token ID to be passed to the client process */
3371 Utf8Str strTokenId;
3372 sessionMachine->i_getTokenId(strTokenId);
3373 Assert(!strTokenId.isEmpty());
3374#else /* VBOX_WITH_GENERIC_SESSION_WATCHER */
3375 /* Get the client token to be passed to the client process */
3376 ComPtr<IToken> pToken(sessionMachine->i_getToken());
3377 /* The token is now "owned" by pToken, fix refcount */
3378 if (!pToken.isNull())
3379 pToken->Release();
3380#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
3381
3382 /*
3383 * Release the lock before calling the client process -- it will call
3384 * Machine/SessionMachine methods. Releasing the lock here is quite safe
3385 * because the state is Spawning, so that LaunchVMProcess() and
3386 * LockMachine() calls will fail. This method, called before we
3387 * acquire the lock again, will fail because of the wrong PID.
3388 *
3389 * Note that mData->mSession.mRemoteControls accessed outside
3390 * the lock may not be modified when state is Spawning, so it's safe.
3391 */
3392 alock.release();
3393
3394 LogFlowThisFunc(("Calling AssignMachine()...\n"));
3395#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
3396 rc = pSessionControl->AssignMachine(sessionMachine, aLockType, Bstr(strTokenId).raw());
3397#else /* VBOX_WITH_GENERIC_SESSION_WATCHER */
3398 rc = pSessionControl->AssignMachine(sessionMachine, aLockType, pToken);
3399 /* Now the token is owned by the client process. */
3400 pToken.setNull();
3401#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
3402 LogFlowThisFunc(("AssignMachine() returned %08X\n", rc));
3403
3404 /* The failure may occur w/o any error info (from RPC), so provide one */
3405 if (FAILED(rc))
3406 setError(VBOX_E_VM_ERROR,
3407 tr("Failed to assign the machine to the session (%Rhrc)"), rc);
3408
3409 // get session name, either to remember or to compare against
3410 // the already known session name.
3411 {
3412 Bstr bstrSessionName;
3413 HRESULT rc2 = aSession->COMGETTER(Name)(bstrSessionName.asOutParam());
3414 if (SUCCEEDED(rc2))
3415 strSessionName = bstrSessionName;
3416 }
3417
3418 if ( SUCCEEDED(rc)
3419 && fLaunchingVMProcess
3420 )
3421 {
3422 /* complete the remote session initialization */
3423
3424 /* get the console from the direct session */
3425 ComPtr<IConsole> console;
3426 rc = pSessionControl->COMGETTER(RemoteConsole)(console.asOutParam());
3427 ComAssertComRC(rc);
3428
3429 if (SUCCEEDED(rc) && !console)
3430 {
3431 ComAssert(!!console);
3432 rc = E_FAIL;
3433 }
3434
3435 /* assign machine & console to the remote session */
3436 if (SUCCEEDED(rc))
3437 {
3438 /*
3439 * after LaunchVMProcess(), the first and the only
3440 * entry in remoteControls is that remote session
3441 */
3442 LogFlowThisFunc(("Calling AssignRemoteMachine()...\n"));
3443 rc = mData->mSession.mRemoteControls.front()->AssignRemoteMachine(sessionMachine, console);
3444 LogFlowThisFunc(("AssignRemoteMachine() returned %08X\n", rc));
3445
3446 /* The failure may occur w/o any error info (from RPC), so provide one */
3447 if (FAILED(rc))
3448 setError(VBOX_E_VM_ERROR,
3449 tr("Failed to assign the machine to the remote session (%Rhrc)"), rc);
3450 }
3451
3452 if (FAILED(rc))
3453 pSessionControl->Uninitialize();
3454 }
3455
3456 /* acquire the lock again */
3457 alock.acquire();
3458
3459 /* Restore the session state */
3460 mData->mSession.mState = origState;
3461 }
3462
3463 // finalize spawning anyway (this is why we don't return on errors above)
3464 if (fLaunchingVMProcess)
3465 {
3466 Assert(mData->mSession.mName == strSessionName);
3467 /* Note that the progress object is finalized later */
3468 /** @todo Consider checking mData->mSession.mProgress for cancellation
3469 * around here. */
3470
3471 /* We don't reset mSession.mPID here because it is necessary for
3472 * SessionMachine::uninit() to reap the child process later. */
3473
3474 if (FAILED(rc))
3475 {
3476 /* Close the remote session, remove the remote control from the list
3477 * and reset session state to Closed (@note keep the code in sync
3478 * with the relevant part in checkForSpawnFailure()). */
3479
3480 Assert(mData->mSession.mRemoteControls.size() == 1);
3481 if (mData->mSession.mRemoteControls.size() == 1)
3482 {
3483 ErrorInfoKeeper eik;
3484 mData->mSession.mRemoteControls.front()->Uninitialize();
3485 }
3486
3487 mData->mSession.mRemoteControls.clear();
3488 mData->mSession.mState = SessionState_Unlocked;
3489 }
3490 }
3491 else
3492 {
3493 /* memorize PID of the directly opened session */
3494 if (SUCCEEDED(rc))
3495 mData->mSession.mPID = pid;
3496 }
3497
3498 if (SUCCEEDED(rc))
3499 {
3500 mData->mSession.mLockType = aLockType;
3501 /* memorize the direct session control and cache IUnknown for it */
3502 mData->mSession.mDirectControl = pSessionControl;
3503 mData->mSession.mState = SessionState_Locked;
3504 if (!fLaunchingVMProcess)
3505 mData->mSession.mName = strSessionName;
3506 /* associate the SessionMachine with this Machine */
3507 mData->mSession.mMachine = sessionMachine;
3508
3509 /* request an IUnknown pointer early from the remote party for later
3510 * identity checks (it will be internally cached within mDirectControl
3511 * at least on XPCOM) */
3512 ComPtr<IUnknown> unk = mData->mSession.mDirectControl;
3513 NOREF(unk);
3514 }
3515
3516 /* Release the lock since SessionMachine::uninit() locks VirtualBox which
3517 * would break the lock order */
3518 alock.release();
3519
3520 /* uninitialize the created session machine on failure */
3521 if (FAILED(rc))
3522 sessionMachine->uninit();
3523 }
3524
3525 if (SUCCEEDED(rc))
3526 {
3527 /*
3528 * tell the client watcher thread to update the set of
3529 * machines that have open sessions
3530 */
3531 mParent->i_updateClientWatcher();
3532
3533 if (oldState != SessionState_Locked)
3534 /* fire an event */
3535 mParent->i_onSessionStateChange(i_getId(), SessionState_Locked);
3536 }
3537
3538 return rc;
3539}
3540
3541/**
3542 * @note Locks objects!
3543 */
3544HRESULT Machine::launchVMProcess(const ComPtr<ISession> &aSession,
3545 const com::Utf8Str &aName,
3546 const com::Utf8Str &aEnvironment,
3547 ComPtr<IProgress> &aProgress)
3548{
3549 Utf8Str strFrontend(aName);
3550 /* "emergencystop" doesn't need the session, so skip the checks/interface
3551 * retrieval. This code doesn't quite fit in here, but introducing a
3552 * special API method would be even more effort, and would require explicit
3553 * support by every API client. It's better to hide the feature a bit. */
3554 if (strFrontend != "emergencystop")
3555 CheckComArgNotNull(aSession);
3556
3557 HRESULT rc = S_OK;
3558 if (strFrontend.isEmpty())
3559 {
3560 Bstr bstrFrontend;
3561 rc = COMGETTER(DefaultFrontend)(bstrFrontend.asOutParam());
3562 if (FAILED(rc))
3563 return rc;
3564 strFrontend = bstrFrontend;
3565 if (strFrontend.isEmpty())
3566 {
3567 ComPtr<ISystemProperties> systemProperties;
3568 rc = mParent->COMGETTER(SystemProperties)(systemProperties.asOutParam());
3569 if (FAILED(rc))
3570 return rc;
3571 rc = systemProperties->COMGETTER(DefaultFrontend)(bstrFrontend.asOutParam());
3572 if (FAILED(rc))
3573 return rc;
3574 strFrontend = bstrFrontend;
3575 }
3576 /* paranoia - emergencystop is not a valid default */
3577 if (strFrontend == "emergencystop")
3578 strFrontend = Utf8Str::Empty;
3579 }
3580 /* default frontend: Qt GUI */
3581 if (strFrontend.isEmpty())
3582 strFrontend = "GUI/Qt";
3583
3584 if (strFrontend != "emergencystop")
3585 {
3586 /* check the session state */
3587 SessionState_T state;
3588 rc = aSession->COMGETTER(State)(&state);
3589 if (FAILED(rc))
3590 return rc;
3591
3592 if (state != SessionState_Unlocked)
3593 return setError(VBOX_E_INVALID_OBJECT_STATE,
3594 tr("The given session is busy"));
3595
3596 /* get the IInternalSessionControl interface */
3597 ComPtr<IInternalSessionControl> control(aSession);
3598 ComAssertMsgRet(!control.isNull(),
3599 ("No IInternalSessionControl interface"),
3600 E_INVALIDARG);
3601
3602 /* get the teleporter enable state for the progress object init. */
3603 BOOL fTeleporterEnabled;
3604 rc = COMGETTER(TeleporterEnabled)(&fTeleporterEnabled);
3605 if (FAILED(rc))
3606 return rc;
3607
3608 /* create a progress object */
3609 ComObjPtr<ProgressProxy> progress;
3610 progress.createObject();
3611 rc = progress->init(mParent,
3612 static_cast<IMachine*>(this),
3613 Bstr(tr("Starting VM")).raw(),
3614 TRUE /* aCancelable */,
3615 fTeleporterEnabled ? 20 : 10 /* uTotalOperationsWeight */,
3616 BstrFmt(tr("Creating process for virtual machine \"%s\" (%s)"),
3617 mUserData->s.strName.c_str(), strFrontend.c_str()).raw(),
3618 2 /* uFirstOperationWeight */,
3619 fTeleporterEnabled ? 3 : 1 /* cOtherProgressObjectOperations */);
3620
3621 if (SUCCEEDED(rc))
3622 {
3623 rc = i_launchVMProcess(control, strFrontend, aEnvironment, progress);
3624 if (SUCCEEDED(rc))
3625 {
3626 aProgress = progress;
3627
3628 /* signal the client watcher thread */
3629 mParent->i_updateClientWatcher();
3630
3631 /* fire an event */
3632 mParent->i_onSessionStateChange(i_getId(), SessionState_Spawning);
3633 }
3634 }
3635 }
3636 else
3637 {
3638 /* no progress object - either instant success or failure */
3639 aProgress = NULL;
3640
3641 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3642
3643 if (mData->mSession.mState != SessionState_Locked)
3644 return setError(VBOX_E_INVALID_OBJECT_STATE,
3645 tr("The machine '%s' is not locked by a session"),
3646 mUserData->s.strName.c_str());
3647
3648 /* must have a VM process associated - do not kill normal API clients
3649 * with an open session */
3650 if (!Global::IsOnline(mData->mMachineState))
3651 return setError(VBOX_E_INVALID_OBJECT_STATE,
3652 tr("The machine '%s' does not have a VM process"),
3653 mUserData->s.strName.c_str());
3654
3655 /* forcibly terminate the VM process */
3656 if (mData->mSession.mPID != NIL_RTPROCESS)
3657 RTProcTerminate(mData->mSession.mPID);
3658
3659 /* signal the client watcher thread, as most likely the client has
3660 * been terminated */
3661 mParent->i_updateClientWatcher();
3662 }
3663
3664 return rc;
3665}
3666
3667HRESULT Machine::setBootOrder(ULONG aPosition, DeviceType_T aDevice)
3668{
3669 if (aPosition < 1 || aPosition > SchemaDefs::MaxBootPosition)
3670 return setError(E_INVALIDARG,
3671 tr("Invalid boot position: %lu (must be in range [1, %lu])"),
3672 aPosition, SchemaDefs::MaxBootPosition);
3673
3674 if (aDevice == DeviceType_USB)
3675 return setError(E_NOTIMPL,
3676 tr("Booting from USB device is currently not supported"));
3677
3678 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
3679
3680 HRESULT rc = i_checkStateDependency(MutableStateDep);
3681 if (FAILED(rc)) return rc;
3682
3683 i_setModified(IsModified_MachineData);
3684 mHWData.backup();
3685 mHWData->mBootOrder[aPosition - 1] = aDevice;
3686
3687 return S_OK;
3688}
3689
3690HRESULT Machine::getBootOrder(ULONG aPosition, DeviceType_T *aDevice)
3691{
3692 if (aPosition < 1 || aPosition > SchemaDefs::MaxBootPosition)
3693 return setError(E_INVALIDARG,
3694 tr("Invalid boot position: %lu (must be in range [1, %lu])"),
3695 aPosition, SchemaDefs::MaxBootPosition);
3696
3697 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
3698
3699 *aDevice = mHWData->mBootOrder[aPosition - 1];
3700
3701 return S_OK;
3702}
3703
3704HRESULT Machine::attachDevice(const com::Utf8Str &aName,
3705 LONG aControllerPort,
3706 LONG aDevice,
3707 DeviceType_T aType,
3708 const ComPtr<IMedium> &aMedium)
3709{
3710 IMedium *aM = aMedium;
3711 LogFlowThisFunc(("aControllerName=\"%s\" aControllerPort=%d aDevice=%d aType=%d aMedium=%p\n",
3712 aName.c_str(), aControllerPort, aDevice, aType, aM));
3713
3714 // request the host lock first, since might be calling Host methods for getting host drives;
3715 // next, protect the media tree all the while we're in here, as well as our member variables
3716 AutoMultiWriteLock2 alock(mParent->i_host(), this COMMA_LOCKVAL_SRC_POS);
3717 AutoWriteLock treeLock(&mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
3718
3719 HRESULT rc = i_checkStateDependency(MutableOrRunningStateDep);
3720 if (FAILED(rc)) return rc;
3721
3722 /// @todo NEWMEDIA implicit machine registration
3723 if (!mData->mRegistered)
3724 return setError(VBOX_E_INVALID_OBJECT_STATE,
3725 tr("Cannot attach storage devices to an unregistered machine"));
3726
3727 AssertReturn(mData->mMachineState != MachineState_Saved, E_FAIL);
3728
3729 /* Check for an existing controller. */
3730 ComObjPtr<StorageController> ctl;
3731 rc = i_getStorageControllerByName(aName, ctl, true /* aSetError */);
3732 if (FAILED(rc)) return rc;
3733
3734 StorageControllerType_T ctrlType;
3735 rc = ctl->COMGETTER(ControllerType)(&ctrlType);
3736 if (FAILED(rc))
3737 return setError(E_FAIL,
3738 tr("Could not get type of controller '%s'"),
3739 aName.c_str());
3740
3741 bool fSilent = false;
3742 Utf8Str strReconfig;
3743
3744 /* Check whether the flag to allow silent storage attachment reconfiguration is set. */
3745 strReconfig = i_getExtraData(Utf8Str("VBoxInternal2/SilentReconfigureWhilePaused"));
3746 if ( mData->mMachineState == MachineState_Paused
3747 && strReconfig == "1")
3748 fSilent = true;
3749
3750 /* Check that the controller can do hotplugging if we detach the device while the VM is running. */
3751 bool fHotplug = false;
3752 if (!fSilent && Global::IsOnlineOrTransient(mData->mMachineState))
3753 fHotplug = true;
3754
3755 if (fHotplug && !i_isControllerHotplugCapable(ctrlType))
3756 return setError(VBOX_E_INVALID_VM_STATE,
3757 tr("Controller '%s' does not support hotplugging"),
3758 aName.c_str());
3759
3760 // check that the port and device are not out of range
3761 rc = ctl->i_checkPortAndDeviceValid(aControllerPort, aDevice);
3762 if (FAILED(rc)) return rc;
3763
3764 /* check if the device slot is already busy */
3765 MediumAttachment *pAttachTemp;
3766 if ((pAttachTemp = i_findAttachment(mMediaData->mAttachments,
3767 Bstr(aName).raw(),
3768 aControllerPort,
3769 aDevice)))
3770 {
3771 Medium *pMedium = pAttachTemp->i_getMedium();
3772 if (pMedium)
3773 {
3774 AutoReadLock mediumLock(pMedium COMMA_LOCKVAL_SRC_POS);
3775 return setError(VBOX_E_OBJECT_IN_USE,
3776 tr("Medium '%s' is already attached to port %d, device %d of controller '%s' of this virtual machine"),
3777 pMedium->i_getLocationFull().c_str(),
3778 aControllerPort,
3779 aDevice,
3780 aName.c_str());
3781 }
3782 else
3783 return setError(VBOX_E_OBJECT_IN_USE,
3784 tr("Device is already attached to port %d, device %d of controller '%s' of this virtual machine"),
3785 aControllerPort, aDevice, aName.c_str());
3786 }
3787
3788 ComObjPtr<Medium> medium = static_cast<Medium*>(aM);
3789 if (aMedium && medium.isNull())
3790 return setError(E_INVALIDARG, "The given medium pointer is invalid");
3791
3792 AutoCaller mediumCaller(medium);
3793 if (FAILED(mediumCaller.rc())) return mediumCaller.rc();
3794
3795 AutoWriteLock mediumLock(medium COMMA_LOCKVAL_SRC_POS);
3796
3797 if ( (pAttachTemp = i_findAttachment(mMediaData->mAttachments, medium))
3798 && !medium.isNull()
3799 )
3800 return setError(VBOX_E_OBJECT_IN_USE,
3801 tr("Medium '%s' is already attached to this virtual machine"),
3802 medium->i_getLocationFull().c_str());
3803
3804 if (!medium.isNull())
3805 {
3806 MediumType_T mtype = medium->i_getType();
3807 // MediumType_Readonly is also new, but only applies to DVDs and floppies.
3808 // For DVDs it's not written to the config file, so needs no global config
3809 // version bump. For floppies it's a new attribute "type", which is ignored
3810 // by older VirtualBox version, so needs no global config version bump either.
3811 // For hard disks this type is not accepted.
3812 if (mtype == MediumType_MultiAttach)
3813 {
3814 // This type is new with VirtualBox 4.0 and therefore requires settings
3815 // version 1.11 in the settings backend. Unfortunately it is not enough to do
3816 // the usual routine in MachineConfigFile::bumpSettingsVersionIfNeeded() for
3817 // two reasons: The medium type is a property of the media registry tree, which
3818 // can reside in the global config file (for pre-4.0 media); we would therefore
3819 // possibly need to bump the global config version. We don't want to do that though
3820 // because that might make downgrading to pre-4.0 impossible.
3821 // As a result, we can only use these two new types if the medium is NOT in the
3822 // global registry:
3823 const Guid &uuidGlobalRegistry = mParent->i_getGlobalRegistryId();
3824 if ( medium->i_isInRegistry(uuidGlobalRegistry)
3825 || !mData->pMachineConfigFile->canHaveOwnMediaRegistry()
3826 )
3827 return setError(VBOX_E_INVALID_OBJECT_STATE,
3828 tr("Cannot attach medium '%s': the media type 'MultiAttach' can only be attached "
3829 "to machines that were created with VirtualBox 4.0 or later"),
3830 medium->i_getLocationFull().c_str());
3831 }
3832 }
3833
3834 bool fIndirect = false;
3835 if (!medium.isNull())
3836 fIndirect = medium->i_isReadOnly();
3837 bool associate = true;
3838
3839 do
3840 {
3841 if ( aType == DeviceType_HardDisk
3842 && mMediaData.isBackedUp())
3843 {
3844 const MediaData::AttachmentList &oldAtts = mMediaData.backedUpData()->mAttachments;
3845
3846 /* check if the medium was attached to the VM before we started
3847 * changing attachments in which case the attachment just needs to
3848 * be restored */
3849 if ((pAttachTemp = i_findAttachment(oldAtts, medium)))
3850 {
3851 AssertReturn(!fIndirect, E_FAIL);
3852
3853 /* see if it's the same bus/channel/device */
3854 if (pAttachTemp->i_matches(Bstr(aName).raw(), aControllerPort, aDevice))
3855 {
3856 /* the simplest case: restore the whole attachment
3857 * and return, nothing else to do */
3858 mMediaData->mAttachments.push_back(pAttachTemp);
3859
3860 /* Reattach the medium to the VM. */
3861 if (fHotplug || fSilent)
3862 {
3863 mediumLock.release();
3864 treeLock.release();
3865 alock.release();
3866
3867 MediumLockList *pMediumLockList(new MediumLockList());
3868
3869 rc = medium->i_createMediumLockList(true /* fFailIfInaccessible */,
3870 true /* fMediumLockWrite */,
3871 false /* fMediumLockWriteAll */,
3872 NULL,
3873 *pMediumLockList);
3874 alock.acquire();
3875 if (FAILED(rc))
3876 delete pMediumLockList;
3877 else
3878 {
3879 mData->mSession.mLockedMedia.Unlock();
3880 alock.release();
3881 rc = mData->mSession.mLockedMedia.Insert(pAttachTemp, pMediumLockList);
3882 mData->mSession.mLockedMedia.Lock();
3883 alock.acquire();
3884 }
3885 alock.release();
3886
3887 if (SUCCEEDED(rc))
3888 {
3889 rc = i_onStorageDeviceChange(pAttachTemp, FALSE /* aRemove */, fSilent);
3890 /* Remove lock list in case of error. */
3891 if (FAILED(rc))
3892 {
3893 mData->mSession.mLockedMedia.Unlock();
3894 mData->mSession.mLockedMedia.Remove(pAttachTemp);
3895 mData->mSession.mLockedMedia.Lock();
3896 }
3897 }
3898 }
3899
3900 return S_OK;
3901 }
3902
3903 /* bus/channel/device differ; we need a new attachment object,
3904 * but don't try to associate it again */
3905 associate = false;
3906 break;
3907 }
3908 }
3909
3910 /* go further only if the attachment is to be indirect */
3911 if (!fIndirect)
3912 break;
3913
3914 /* perform the so called smart attachment logic for indirect
3915 * attachments. Note that smart attachment is only applicable to base
3916 * hard disks. */
3917
3918 if (medium->i_getParent().isNull())
3919 {
3920 /* first, investigate the backup copy of the current hard disk
3921 * attachments to make it possible to re-attach existing diffs to
3922 * another device slot w/o losing their contents */
3923 if (mMediaData.isBackedUp())
3924 {
3925 const MediaData::AttachmentList &oldAtts = mMediaData.backedUpData()->mAttachments;
3926
3927 MediaData::AttachmentList::const_iterator foundIt = oldAtts.end();
3928 uint32_t foundLevel = 0;
3929
3930 for (MediaData::AttachmentList::const_iterator it = oldAtts.begin(); it != oldAtts.end(); ++it)
3931 {
3932 uint32_t level = 0;
3933 MediumAttachment *pAttach = *it;
3934 ComObjPtr<Medium> pMedium = pAttach->i_getMedium();
3935 Assert(!pMedium.isNull() || pAttach->i_getType() != DeviceType_HardDisk);
3936 if (pMedium.isNull())
3937 continue;
3938
3939 if (pMedium->i_getBase(&level) == medium)
3940 {
3941 /* skip the hard disk if its currently attached (we
3942 * cannot attach the same hard disk twice) */
3943 if (i_findAttachment(mMediaData->mAttachments,
3944 pMedium))
3945 continue;
3946
3947 /* matched device, channel and bus (i.e. attached to the
3948 * same place) will win and immediately stop the search;
3949 * otherwise the attachment that has the youngest
3950 * descendant of medium will be used
3951 */
3952 if (pAttach->i_matches(Bstr(aName).raw(), aControllerPort, aDevice))
3953 {
3954 /* the simplest case: restore the whole attachment
3955 * and return, nothing else to do */
3956 mMediaData->mAttachments.push_back(*it);
3957
3958 /* Reattach the medium to the VM. */
3959 if (fHotplug || fSilent)
3960 {
3961 mediumLock.release();
3962 treeLock.release();
3963 alock.release();
3964
3965 MediumLockList *pMediumLockList(new MediumLockList());
3966
3967 rc = medium->i_createMediumLockList(true /* fFailIfInaccessible */,
3968 true /* fMediumLockWrite */,
3969 false /* fMediumLockWriteAll */,
3970 NULL,
3971 *pMediumLockList);
3972 alock.acquire();
3973 if (FAILED(rc))
3974 delete pMediumLockList;
3975 else
3976 {
3977 mData->mSession.mLockedMedia.Unlock();
3978 alock.release();
3979 rc = mData->mSession.mLockedMedia.Insert(pAttachTemp, pMediumLockList);
3980 mData->mSession.mLockedMedia.Lock();
3981 alock.acquire();
3982 }
3983 alock.release();
3984
3985 if (SUCCEEDED(rc))
3986 {
3987 rc = i_onStorageDeviceChange(pAttachTemp, FALSE /* aRemove */, fSilent);
3988 /* Remove lock list in case of error. */
3989 if (FAILED(rc))
3990 {
3991 mData->mSession.mLockedMedia.Unlock();
3992 mData->mSession.mLockedMedia.Remove(pAttachTemp);
3993 mData->mSession.mLockedMedia.Lock();
3994 }
3995 }
3996 }
3997
3998 return S_OK;
3999 }
4000 else if ( foundIt == oldAtts.end()
4001 || level > foundLevel /* prefer younger */
4002 )
4003 {
4004 foundIt = it;
4005 foundLevel = level;
4006 }
4007 }
4008 }
4009
4010 if (foundIt != oldAtts.end())
4011 {
4012 /* use the previously attached hard disk */
4013 medium = (*foundIt)->i_getMedium();
4014 mediumCaller.attach(medium);
4015 if (FAILED(mediumCaller.rc())) return mediumCaller.rc();
4016 mediumLock.attach(medium);
4017 /* not implicit, doesn't require association with this VM */
4018 fIndirect = false;
4019 associate = false;
4020 /* go right to the MediumAttachment creation */
4021 break;
4022 }
4023 }
4024
4025 /* must give up the medium lock and medium tree lock as below we
4026 * go over snapshots, which needs a lock with higher lock order. */
4027 mediumLock.release();
4028 treeLock.release();
4029
4030 /* then, search through snapshots for the best diff in the given
4031 * hard disk's chain to base the new diff on */
4032
4033 ComObjPtr<Medium> base;
4034 ComObjPtr<Snapshot> snap = mData->mCurrentSnapshot;
4035 while (snap)
4036 {
4037 AutoReadLock snapLock(snap COMMA_LOCKVAL_SRC_POS);
4038
4039 const MediaData::AttachmentList &snapAtts = snap->i_getSnapshotMachine()->mMediaData->mAttachments;
4040
4041 MediumAttachment *pAttachFound = NULL;
4042 uint32_t foundLevel = 0;
4043
4044 for (MediaData::AttachmentList::const_iterator it = snapAtts.begin(); it != snapAtts.end(); ++it)
4045 {
4046 MediumAttachment *pAttach = *it;
4047 ComObjPtr<Medium> pMedium = pAttach->i_getMedium();
4048 Assert(!pMedium.isNull() || pAttach->i_getType() != DeviceType_HardDisk);
4049 if (pMedium.isNull())
4050 continue;
4051
4052 uint32_t level = 0;
4053 if (pMedium->i_getBase(&level) == medium)
4054 {
4055 /* matched device, channel and bus (i.e. attached to the
4056 * same place) will win and immediately stop the search;
4057 * otherwise the attachment that has the youngest
4058 * descendant of medium will be used
4059 */
4060 if ( pAttach->i_getDevice() == aDevice
4061 && pAttach->i_getPort() == aControllerPort
4062 && pAttach->i_getControllerName() == aName
4063 )
4064 {
4065 pAttachFound = pAttach;
4066 break;
4067 }
4068 else if ( !pAttachFound
4069 || level > foundLevel /* prefer younger */
4070 )
4071 {
4072 pAttachFound = pAttach;
4073 foundLevel = level;
4074 }
4075 }
4076 }
4077
4078 if (pAttachFound)
4079 {
4080 base = pAttachFound->i_getMedium();
4081 break;
4082 }
4083
4084 snap = snap->i_getParent();
4085 }
4086
4087 /* re-lock medium tree and the medium, as we need it below */
4088 treeLock.acquire();
4089 mediumLock.acquire();
4090
4091 /* found a suitable diff, use it as a base */
4092 if (!base.isNull())
4093 {
4094 medium = base;
4095 mediumCaller.attach(medium);
4096 if (FAILED(mediumCaller.rc())) return mediumCaller.rc();
4097 mediumLock.attach(medium);
4098 }
4099 }
4100
4101 Utf8Str strFullSnapshotFolder;
4102 i_calculateFullPath(mUserData->s.strSnapshotFolder, strFullSnapshotFolder);
4103
4104 ComObjPtr<Medium> diff;
4105 diff.createObject();
4106 // store this diff in the same registry as the parent
4107 Guid uuidRegistryParent;
4108 if (!medium->i_getFirstRegistryMachineId(uuidRegistryParent))
4109 {
4110 // parent image has no registry: this can happen if we're attaching a new immutable
4111 // image that has not yet been attached (medium then points to the base and we're
4112 // creating the diff image for the immutable, and the parent is not yet registered);
4113 // put the parent in the machine registry then
4114 mediumLock.release();
4115 treeLock.release();
4116 alock.release();
4117 i_addMediumToRegistry(medium);
4118 alock.acquire();
4119 treeLock.acquire();
4120 mediumLock.acquire();
4121 medium->i_getFirstRegistryMachineId(uuidRegistryParent);
4122 }
4123 rc = diff->init(mParent,
4124 medium->i_getPreferredDiffFormat(),
4125 strFullSnapshotFolder.append(RTPATH_SLASH_STR),
4126 uuidRegistryParent,
4127 DeviceType_HardDisk);
4128 if (FAILED(rc)) return rc;
4129
4130 /* Apply the normal locking logic to the entire chain. */
4131 MediumLockList *pMediumLockList(new MediumLockList());
4132 mediumLock.release();
4133 treeLock.release();
4134 rc = diff->i_createMediumLockList(true /* fFailIfInaccessible */,
4135 true /* fMediumLockWrite */,
4136 false /* fMediumLockWriteAll */,
4137 medium,
4138 *pMediumLockList);
4139 treeLock.acquire();
4140 mediumLock.acquire();
4141 if (SUCCEEDED(rc))
4142 {
4143 mediumLock.release();
4144 treeLock.release();
4145 rc = pMediumLockList->Lock();
4146 treeLock.acquire();
4147 mediumLock.acquire();
4148 if (FAILED(rc))
4149 setError(rc,
4150 tr("Could not lock medium when creating diff '%s'"),
4151 diff->i_getLocationFull().c_str());
4152 else
4153 {
4154 /* will release the lock before the potentially lengthy
4155 * operation, so protect with the special state */
4156 MachineState_T oldState = mData->mMachineState;
4157 i_setMachineState(MachineState_SettingUp);
4158
4159 mediumLock.release();
4160 treeLock.release();
4161 alock.release();
4162
4163 rc = medium->i_createDiffStorage(diff,
4164 MediumVariant_Standard,
4165 pMediumLockList,
4166 NULL /* aProgress */,
4167 true /* aWait */);
4168
4169 alock.acquire();
4170 treeLock.acquire();
4171 mediumLock.acquire();
4172
4173 i_setMachineState(oldState);
4174 }
4175 }
4176
4177 /* Unlock the media and free the associated memory. */
4178 delete pMediumLockList;
4179
4180 if (FAILED(rc)) return rc;
4181
4182 /* use the created diff for the actual attachment */
4183 medium = diff;
4184 mediumCaller.attach(medium);
4185 if (FAILED(mediumCaller.rc())) return mediumCaller.rc();
4186 mediumLock.attach(medium);
4187 }
4188 while (0);
4189
4190 ComObjPtr<MediumAttachment> attachment;
4191 attachment.createObject();
4192 rc = attachment->init(this,
4193 medium,
4194 aName,
4195 aControllerPort,
4196 aDevice,
4197 aType,
4198 fIndirect,
4199 false /* fPassthrough */,
4200 false /* fTempEject */,
4201 false /* fNonRotational */,
4202 false /* fDiscard */,
4203 fHotplug /* fHotPluggable */,
4204 Utf8Str::Empty);
4205 if (FAILED(rc)) return rc;
4206
4207 if (associate && !medium.isNull())
4208 {
4209 // as the last step, associate the medium to the VM
4210 rc = medium->i_addBackReference(mData->mUuid);
4211 // here we can fail because of Deleting, or being in process of creating a Diff
4212 if (FAILED(rc)) return rc;
4213
4214 mediumLock.release();
4215 treeLock.release();
4216 alock.release();
4217 i_addMediumToRegistry(medium);
4218 alock.acquire();
4219 treeLock.acquire();
4220 mediumLock.acquire();
4221 }
4222
4223 /* success: finally remember the attachment */
4224 i_setModified(IsModified_Storage);
4225 mMediaData.backup();
4226 mMediaData->mAttachments.push_back(attachment);
4227
4228 mediumLock.release();
4229 treeLock.release();
4230 alock.release();
4231
4232 if (fHotplug || fSilent)
4233 {
4234 if (!medium.isNull())
4235 {
4236 MediumLockList *pMediumLockList(new MediumLockList());
4237
4238 rc = medium->i_createMediumLockList(true /* fFailIfInaccessible */,
4239 true /* fMediumLockWrite */,
4240 false /* fMediumLockWriteAll */,
4241 NULL,
4242 *pMediumLockList);
4243 alock.acquire();
4244 if (FAILED(rc))
4245 delete pMediumLockList;
4246 else
4247 {
4248 mData->mSession.mLockedMedia.Unlock();
4249 alock.release();
4250 rc = mData->mSession.mLockedMedia.Insert(attachment, pMediumLockList);
4251 mData->mSession.mLockedMedia.Lock();
4252 alock.acquire();
4253 }
4254 alock.release();
4255 }
4256
4257 if (SUCCEEDED(rc))
4258 {
4259 rc = i_onStorageDeviceChange(attachment, FALSE /* aRemove */, fSilent);
4260 /* Remove lock list in case of error. */
4261 if (FAILED(rc))
4262 {
4263 mData->mSession.mLockedMedia.Unlock();
4264 mData->mSession.mLockedMedia.Remove(attachment);
4265 mData->mSession.mLockedMedia.Lock();
4266 }
4267 }
4268 }
4269
4270 /* Save modified registries, but skip this machine as it's the caller's
4271 * job to save its settings like all other settings changes. */
4272 mParent->i_unmarkRegistryModified(i_getId());
4273 mParent->i_saveModifiedRegistries();
4274
4275 return rc;
4276}
4277
4278HRESULT Machine::detachDevice(const com::Utf8Str &aName, LONG aControllerPort,
4279 LONG aDevice)
4280{
4281 LogFlowThisFunc(("aControllerName=\"%s\" aControllerPort=%d aDevice=%d\n",
4282 aName.c_str(), aControllerPort, aDevice));
4283
4284 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4285
4286 HRESULT rc = i_checkStateDependency(MutableOrRunningStateDep);
4287 if (FAILED(rc)) return rc;
4288
4289 AssertReturn(mData->mMachineState != MachineState_Saved, E_FAIL);
4290
4291 /* Check for an existing controller. */
4292 ComObjPtr<StorageController> ctl;
4293 rc = i_getStorageControllerByName(aName, ctl, true /* aSetError */);
4294 if (FAILED(rc)) return rc;
4295
4296 StorageControllerType_T ctrlType;
4297 rc = ctl->COMGETTER(ControllerType)(&ctrlType);
4298 if (FAILED(rc))
4299 return setError(E_FAIL,
4300 tr("Could not get type of controller '%s'"),
4301 aName.c_str());
4302
4303 bool fSilent = false;
4304 Utf8Str strReconfig;
4305
4306 /* Check whether the flag to allow silent storage attachment reconfiguration is set. */
4307 strReconfig = i_getExtraData(Utf8Str("VBoxInternal2/SilentReconfigureWhilePaused"));
4308 if ( mData->mMachineState == MachineState_Paused
4309 && strReconfig == "1")
4310 fSilent = true;
4311
4312 /* Check that the controller can do hotplugging if we detach the device while the VM is running. */
4313 bool fHotplug = false;
4314 if (!fSilent && Global::IsOnlineOrTransient(mData->mMachineState))
4315 fHotplug = true;
4316
4317 if (fHotplug && !i_isControllerHotplugCapable(ctrlType))
4318 return setError(VBOX_E_INVALID_VM_STATE,
4319 tr("Controller '%s' does not support hotplugging"),
4320 aName.c_str());
4321
4322 MediumAttachment *pAttach = i_findAttachment(mMediaData->mAttachments,
4323 Bstr(aName).raw(),
4324 aControllerPort,
4325 aDevice);
4326 if (!pAttach)
4327 return setError(VBOX_E_OBJECT_NOT_FOUND,
4328 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4329 aDevice, aControllerPort, aName.c_str());
4330
4331 if (fHotplug && !pAttach->i_getHotPluggable())
4332 return setError(VBOX_E_NOT_SUPPORTED,
4333 tr("The device slot %d on port %d of controller '%s' does not support hotplugging"),
4334 aDevice, aControllerPort, aName.c_str());
4335
4336 /*
4337 * The VM has to detach the device before we delete any implicit diffs.
4338 * If this fails we can roll back without loosing data.
4339 */
4340 if (fHotplug || fSilent)
4341 {
4342 alock.release();
4343 rc = i_onStorageDeviceChange(pAttach, TRUE /* aRemove */, fSilent);
4344 alock.acquire();
4345 }
4346 if (FAILED(rc)) return rc;
4347
4348 /* If we are here everything went well and we can delete the implicit now. */
4349 rc = i_detachDevice(pAttach, alock, NULL /* pSnapshot */);
4350
4351 alock.release();
4352
4353 /* Save modified registries, but skip this machine as it's the caller's
4354 * job to save its settings like all other settings changes. */
4355 mParent->i_unmarkRegistryModified(i_getId());
4356 mParent->i_saveModifiedRegistries();
4357
4358 return rc;
4359}
4360
4361HRESULT Machine::passthroughDevice(const com::Utf8Str &aName, LONG aControllerPort,
4362 LONG aDevice, BOOL aPassthrough)
4363{
4364 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d aPassthrough=%d\n",
4365 aName.c_str(), aControllerPort, aDevice, aPassthrough));
4366
4367 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4368
4369 HRESULT rc = i_checkStateDependency(MutableStateDep);
4370 if (FAILED(rc)) return rc;
4371
4372 AssertReturn(mData->mMachineState != MachineState_Saved, E_FAIL);
4373
4374 if (Global::IsOnlineOrTransient(mData->mMachineState))
4375 return setError(VBOX_E_INVALID_VM_STATE,
4376 tr("Invalid machine state: %s"),
4377 Global::stringifyMachineState(mData->mMachineState));
4378
4379 MediumAttachment *pAttach = i_findAttachment(mMediaData->mAttachments,
4380 Bstr(aName).raw(),
4381 aControllerPort,
4382 aDevice);
4383 if (!pAttach)
4384 return setError(VBOX_E_OBJECT_NOT_FOUND,
4385 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4386 aDevice, aControllerPort, aName.c_str());
4387
4388
4389 i_setModified(IsModified_Storage);
4390 mMediaData.backup();
4391
4392 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4393
4394 if (pAttach->i_getType() != DeviceType_DVD)
4395 return setError(E_INVALIDARG,
4396 tr("Setting passthrough rejected as the device attached to device slot %d on port %d of controller '%s' is not a DVD"),
4397 aDevice, aControllerPort, aName.c_str());
4398 pAttach->i_updatePassthrough(!!aPassthrough);
4399
4400 return S_OK;
4401}
4402
4403HRESULT Machine::temporaryEjectDevice(const com::Utf8Str &aName, LONG aControllerPort,
4404 LONG aDevice, BOOL aTemporaryEject)
4405{
4406
4407 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d aTemporaryEject=%d\n",
4408 aName.c_str(), aControllerPort, aDevice, aTemporaryEject));
4409
4410 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4411
4412 HRESULT rc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
4413 if (FAILED(rc)) return rc;
4414
4415 MediumAttachment *pAttach = i_findAttachment(mMediaData->mAttachments,
4416 Bstr(aName).raw(),
4417 aControllerPort,
4418 aDevice);
4419 if (!pAttach)
4420 return setError(VBOX_E_OBJECT_NOT_FOUND,
4421 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4422 aDevice, aControllerPort, aName.c_str());
4423
4424
4425 i_setModified(IsModified_Storage);
4426 mMediaData.backup();
4427
4428 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4429
4430 if (pAttach->i_getType() != DeviceType_DVD)
4431 return setError(E_INVALIDARG,
4432 tr("Setting temporary eject flag rejected as the device attached to device slot %d on port %d of controller '%s' is not a DVD"),
4433 aDevice, aControllerPort, aName.c_str());
4434 pAttach->i_updateTempEject(!!aTemporaryEject);
4435
4436 return S_OK;
4437}
4438
4439HRESULT Machine::nonRotationalDevice(const com::Utf8Str &aName, LONG aControllerPort,
4440 LONG aDevice, BOOL aNonRotational)
4441{
4442
4443 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d aNonRotational=%d\n",
4444 aName.c_str(), aControllerPort, aDevice, aNonRotational));
4445
4446 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4447
4448 HRESULT rc = i_checkStateDependency(MutableStateDep);
4449 if (FAILED(rc)) return rc;
4450
4451 AssertReturn(mData->mMachineState != MachineState_Saved, E_FAIL);
4452
4453 if (Global::IsOnlineOrTransient(mData->mMachineState))
4454 return setError(VBOX_E_INVALID_VM_STATE,
4455 tr("Invalid machine state: %s"),
4456 Global::stringifyMachineState(mData->mMachineState));
4457
4458 MediumAttachment *pAttach = i_findAttachment(mMediaData->mAttachments,
4459 Bstr(aName).raw(),
4460 aControllerPort,
4461 aDevice);
4462 if (!pAttach)
4463 return setError(VBOX_E_OBJECT_NOT_FOUND,
4464 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4465 aDevice, aControllerPort, aName.c_str());
4466
4467
4468 i_setModified(IsModified_Storage);
4469 mMediaData.backup();
4470
4471 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4472
4473 if (pAttach->i_getType() != DeviceType_HardDisk)
4474 return setError(E_INVALIDARG,
4475 tr("Setting the non-rotational medium flag rejected as the device attached to device slot %d on port %d of controller '%s' is not a hard disk"),
4476 aDevice, aControllerPort, aName.c_str());
4477 pAttach->i_updateNonRotational(!!aNonRotational);
4478
4479 return S_OK;
4480}
4481
4482HRESULT Machine::setAutoDiscardForDevice(const com::Utf8Str &aName, LONG aControllerPort,
4483 LONG aDevice, BOOL aDiscard)
4484{
4485
4486 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d aDiscard=%d\n",
4487 aName.c_str(), aControllerPort, aDevice, aDiscard));
4488
4489 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4490
4491 HRESULT rc = i_checkStateDependency(MutableStateDep);
4492 if (FAILED(rc)) return rc;
4493
4494 AssertReturn(mData->mMachineState != MachineState_Saved, E_FAIL);
4495
4496 if (Global::IsOnlineOrTransient(mData->mMachineState))
4497 return setError(VBOX_E_INVALID_VM_STATE,
4498 tr("Invalid machine state: %s"),
4499 Global::stringifyMachineState(mData->mMachineState));
4500
4501 MediumAttachment *pAttach = i_findAttachment(mMediaData->mAttachments,
4502 Bstr(aName).raw(),
4503 aControllerPort,
4504 aDevice);
4505 if (!pAttach)
4506 return setError(VBOX_E_OBJECT_NOT_FOUND,
4507 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4508 aDevice, aControllerPort, aName.c_str());
4509
4510
4511 i_setModified(IsModified_Storage);
4512 mMediaData.backup();
4513
4514 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4515
4516 if (pAttach->i_getType() != DeviceType_HardDisk)
4517 return setError(E_INVALIDARG,
4518 tr("Setting the discard medium flag rejected as the device attached to device slot %d on port %d of controller '%s' is not a hard disk"),
4519 aDevice, aControllerPort, aName.c_str());
4520 pAttach->i_updateDiscard(!!aDiscard);
4521
4522 return S_OK;
4523}
4524
4525HRESULT Machine::setHotPluggableForDevice(const com::Utf8Str &aName, LONG aControllerPort,
4526 LONG aDevice, BOOL aHotPluggable)
4527{
4528 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d aHotPluggable=%d\n",
4529 aName.c_str(), aControllerPort, aDevice, aHotPluggable));
4530
4531 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4532
4533 HRESULT rc = i_checkStateDependency(MutableStateDep);
4534 if (FAILED(rc)) return rc;
4535
4536 AssertReturn(mData->mMachineState != MachineState_Saved, E_FAIL);
4537
4538 if (Global::IsOnlineOrTransient(mData->mMachineState))
4539 return setError(VBOX_E_INVALID_VM_STATE,
4540 tr("Invalid machine state: %s"),
4541 Global::stringifyMachineState(mData->mMachineState));
4542
4543 MediumAttachment *pAttach = i_findAttachment(mMediaData->mAttachments,
4544 Bstr(aName).raw(),
4545 aControllerPort,
4546 aDevice);
4547 if (!pAttach)
4548 return setError(VBOX_E_OBJECT_NOT_FOUND,
4549 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4550 aDevice, aControllerPort, aName.c_str());
4551
4552 /* Check for an existing controller. */
4553 ComObjPtr<StorageController> ctl;
4554 rc = i_getStorageControllerByName(aName, ctl, true /* aSetError */);
4555 if (FAILED(rc)) return rc;
4556
4557 StorageControllerType_T ctrlType;
4558 rc = ctl->COMGETTER(ControllerType)(&ctrlType);
4559 if (FAILED(rc))
4560 return setError(E_FAIL,
4561 tr("Could not get type of controller '%s'"),
4562 aName.c_str());
4563
4564 if (!i_isControllerHotplugCapable(ctrlType))
4565 return setError(VBOX_E_NOT_SUPPORTED,
4566 tr("Controller '%s' does not support changing the hot-pluggable device flag"),
4567 aName.c_str());
4568
4569 i_setModified(IsModified_Storage);
4570 mMediaData.backup();
4571
4572 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4573
4574 if (pAttach->i_getType() == DeviceType_Floppy)
4575 return setError(E_INVALIDARG,
4576 tr("Setting the hot-pluggable device flag rejected as the device attached to device slot %d on port %d of controller '%s' is a floppy drive"),
4577 aDevice, aControllerPort, aName.c_str());
4578 pAttach->i_updateHotPluggable(!!aHotPluggable);
4579
4580 return S_OK;
4581}
4582
4583HRESULT Machine::setNoBandwidthGroupForDevice(const com::Utf8Str &aName, LONG aControllerPort,
4584 LONG aDevice)
4585{
4586 int rc = S_OK;
4587 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d\n",
4588 aName.c_str(), aControllerPort, aDevice));
4589
4590 rc = setBandwidthGroupForDevice(aName, aControllerPort, aDevice, NULL);
4591
4592 return rc;
4593}
4594
4595HRESULT Machine::setBandwidthGroupForDevice(const com::Utf8Str &aName, LONG aControllerPort,
4596 LONG aDevice, const ComPtr<IBandwidthGroup> &aBandwidthGroup)
4597{
4598 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d\n",
4599 aName.c_str(), aControllerPort, aDevice));
4600
4601 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4602
4603 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
4604 if (FAILED(rc)) return rc;
4605
4606 if (Global::IsOnlineOrTransient(mData->mMachineState))
4607 return setError(VBOX_E_INVALID_VM_STATE,
4608 tr("Invalid machine state: %s"),
4609 Global::stringifyMachineState(mData->mMachineState));
4610
4611 MediumAttachment *pAttach = i_findAttachment(mMediaData->mAttachments,
4612 Bstr(aName).raw(),
4613 aControllerPort,
4614 aDevice);
4615 if (!pAttach)
4616 return setError(VBOX_E_OBJECT_NOT_FOUND,
4617 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4618 aDevice, aControllerPort, aName.c_str());
4619
4620
4621 i_setModified(IsModified_Storage);
4622 mMediaData.backup();
4623
4624 IBandwidthGroup *iB = aBandwidthGroup;
4625 ComObjPtr<BandwidthGroup> group = static_cast<BandwidthGroup*>(iB);
4626 if (aBandwidthGroup && group.isNull())
4627 return setError(E_INVALIDARG, "The given bandwidth group pointer is invalid");
4628
4629 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4630
4631 const Utf8Str strBandwidthGroupOld = pAttach->i_getBandwidthGroup();
4632 if (strBandwidthGroupOld.isNotEmpty())
4633 {
4634 /* Get the bandwidth group object and release it - this must not fail. */
4635 ComObjPtr<BandwidthGroup> pBandwidthGroupOld;
4636 rc = i_getBandwidthGroup(strBandwidthGroupOld, pBandwidthGroupOld, false);
4637 Assert(SUCCEEDED(rc));
4638
4639 pBandwidthGroupOld->i_release();
4640 pAttach->i_updateBandwidthGroup(Utf8Str::Empty);
4641 }
4642
4643 if (!group.isNull())
4644 {
4645 group->i_reference();
4646 pAttach->i_updateBandwidthGroup(group->i_getName());
4647 }
4648
4649 return S_OK;
4650}
4651
4652HRESULT Machine::attachDeviceWithoutMedium(const com::Utf8Str &aName,
4653 LONG aControllerPort,
4654 LONG aDevice,
4655 DeviceType_T aType)
4656{
4657 HRESULT rc = S_OK;
4658
4659 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d aType=%d\n",
4660 aName.c_str(), aControllerPort, aDevice, aType));
4661
4662 rc = AttachDevice(Bstr(aName).raw(), aControllerPort, aDevice, aType, NULL);
4663
4664 return rc;
4665}
4666
4667
4668HRESULT Machine::unmountMedium(const com::Utf8Str &aName,
4669 LONG aControllerPort,
4670 LONG aDevice,
4671 BOOL aForce)
4672{
4673 int rc = S_OK;
4674 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d",
4675 aName.c_str(), aControllerPort, aForce));
4676
4677 rc = mountMedium(aName, aControllerPort, aDevice, NULL, aForce);
4678
4679 return rc;
4680}
4681
4682HRESULT Machine::mountMedium(const com::Utf8Str &aName,
4683 LONG aControllerPort,
4684 LONG aDevice,
4685 const ComPtr<IMedium> &aMedium,
4686 BOOL aForce)
4687{
4688 int rc = S_OK;
4689 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d aForce=%d\n",
4690 aName.c_str(), aControllerPort, aDevice, aForce));
4691
4692 // request the host lock first, since might be calling Host methods for getting host drives;
4693 // next, protect the media tree all the while we're in here, as well as our member variables
4694 AutoMultiWriteLock3 multiLock(mParent->i_host()->lockHandle(),
4695 this->lockHandle(),
4696 &mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
4697
4698 ComObjPtr<MediumAttachment> pAttach = i_findAttachment(mMediaData->mAttachments,
4699 Bstr(aName).raw(),
4700 aControllerPort,
4701 aDevice);
4702 if (pAttach.isNull())
4703 return setError(VBOX_E_OBJECT_NOT_FOUND,
4704 tr("No drive attached to device slot %d on port %d of controller '%s'"),
4705 aDevice, aControllerPort, aName.c_str());
4706
4707 /* Remember previously mounted medium. The medium before taking the
4708 * backup is not necessarily the same thing. */
4709 ComObjPtr<Medium> oldmedium;
4710 oldmedium = pAttach->i_getMedium();
4711
4712 IMedium *iM = aMedium;
4713 ComObjPtr<Medium> pMedium = static_cast<Medium*>(iM);
4714 if (aMedium && pMedium.isNull())
4715 return setError(E_INVALIDARG, "The given medium pointer is invalid");
4716
4717 AutoCaller mediumCaller(pMedium);
4718 if (FAILED(mediumCaller.rc())) return mediumCaller.rc();
4719
4720 AutoWriteLock mediumLock(pMedium COMMA_LOCKVAL_SRC_POS);
4721 if (pMedium)
4722 {
4723 DeviceType_T mediumType = pAttach->i_getType();
4724 switch (mediumType)
4725 {
4726 case DeviceType_DVD:
4727 case DeviceType_Floppy:
4728 break;
4729
4730 default:
4731 return setError(VBOX_E_INVALID_OBJECT_STATE,
4732 tr("The device at port %d, device %d of controller '%s' of this virtual machine is not removeable"),
4733 aControllerPort,
4734 aDevice,
4735 aName.c_str());
4736 }
4737 }
4738
4739 i_setModified(IsModified_Storage);
4740 mMediaData.backup();
4741
4742 {
4743 // The backup operation makes the pAttach reference point to the
4744 // old settings. Re-get the correct reference.
4745 pAttach = i_findAttachment(mMediaData->mAttachments,
4746 Bstr(aName).raw(),
4747 aControllerPort,
4748 aDevice);
4749 if (!oldmedium.isNull())
4750 oldmedium->i_removeBackReference(mData->mUuid);
4751 if (!pMedium.isNull())
4752 {
4753 pMedium->i_addBackReference(mData->mUuid);
4754
4755 mediumLock.release();
4756 multiLock.release();
4757 i_addMediumToRegistry(pMedium);
4758 multiLock.acquire();
4759 mediumLock.acquire();
4760 }
4761
4762 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4763 pAttach->i_updateMedium(pMedium);
4764 }
4765
4766 i_setModified(IsModified_Storage);
4767
4768 mediumLock.release();
4769 multiLock.release();
4770 rc = i_onMediumChange(pAttach, aForce);
4771 multiLock.acquire();
4772 mediumLock.acquire();
4773
4774 /* On error roll back this change only. */
4775 if (FAILED(rc))
4776 {
4777 if (!pMedium.isNull())
4778 pMedium->i_removeBackReference(mData->mUuid);
4779 pAttach = i_findAttachment(mMediaData->mAttachments,
4780 Bstr(aName).raw(),
4781 aControllerPort,
4782 aDevice);
4783 /* If the attachment is gone in the meantime, bail out. */
4784 if (pAttach.isNull())
4785 return rc;
4786 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
4787 if (!oldmedium.isNull())
4788 oldmedium->i_addBackReference(mData->mUuid);
4789 pAttach->i_updateMedium(oldmedium);
4790 }
4791
4792 mediumLock.release();
4793 multiLock.release();
4794
4795 /* Save modified registries, but skip this machine as it's the caller's
4796 * job to save its settings like all other settings changes. */
4797 mParent->i_unmarkRegistryModified(i_getId());
4798 mParent->i_saveModifiedRegistries();
4799
4800 return rc;
4801}
4802HRESULT Machine::getMedium(const com::Utf8Str &aName,
4803 LONG aControllerPort,
4804 LONG aDevice,
4805 ComPtr<IMedium> &aMedium)
4806{
4807 LogFlowThisFunc(("aName=\"%s\" aControllerPort=%d aDevice=%d\n",
4808 aName.c_str(), aControllerPort, aDevice));
4809
4810 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4811
4812 aMedium = NULL;
4813
4814 ComObjPtr<MediumAttachment> pAttach = i_findAttachment(mMediaData->mAttachments,
4815 Bstr(aName).raw(),
4816 aControllerPort,
4817 aDevice);
4818 if (pAttach.isNull())
4819 return setError(VBOX_E_OBJECT_NOT_FOUND,
4820 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
4821 aDevice, aControllerPort, aName.c_str());
4822
4823 aMedium = pAttach->i_getMedium();
4824
4825 return S_OK;
4826}
4827
4828HRESULT Machine::getSerialPort(ULONG aSlot, ComPtr<ISerialPort> &aPort)
4829{
4830
4831 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4832
4833 mSerialPorts[aSlot].queryInterfaceTo(aPort.asOutParam());
4834
4835 return S_OK;
4836}
4837
4838HRESULT Machine::getParallelPort(ULONG aSlot, ComPtr<IParallelPort> &aPort)
4839{
4840 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4841
4842 mParallelPorts[aSlot].queryInterfaceTo(aPort.asOutParam());
4843
4844 return S_OK;
4845}
4846
4847HRESULT Machine::getNetworkAdapter(ULONG aSlot, ComPtr<INetworkAdapter> &aAdapter)
4848{
4849 /* Do not assert if slot is out of range, just return the advertised
4850 status. testdriver/vbox.py triggers this in logVmInfo. */
4851 if (aSlot >= mNetworkAdapters.size())
4852 return setError(E_INVALIDARG,
4853 tr("No network adapter in slot %RU32 (total %RU32 adapters)"),
4854 aSlot, mNetworkAdapters.size());
4855
4856 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4857
4858 mNetworkAdapters[aSlot].queryInterfaceTo(aAdapter.asOutParam());
4859
4860 return S_OK;
4861}
4862
4863HRESULT Machine::getExtraDataKeys(std::vector<com::Utf8Str> &aKeys)
4864{
4865 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4866
4867 aKeys.resize(mData->pMachineConfigFile->mapExtraDataItems.size());
4868 size_t i = 0;
4869 for (settings::StringsMap::const_iterator it = mData->pMachineConfigFile->mapExtraDataItems.begin();
4870 it != mData->pMachineConfigFile->mapExtraDataItems.end();
4871 ++it, ++i)
4872 aKeys[i] = it->first;
4873
4874 return S_OK;
4875}
4876
4877 /**
4878 * @note Locks this object for reading.
4879 */
4880HRESULT Machine::getExtraData(const com::Utf8Str &aKey,
4881 com::Utf8Str &aValue)
4882{
4883 /* start with nothing found */
4884 aValue = "";
4885
4886 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
4887
4888 settings::StringsMap::const_iterator it = mData->pMachineConfigFile->mapExtraDataItems.find(aKey);
4889 if (it != mData->pMachineConfigFile->mapExtraDataItems.end())
4890 // found:
4891 aValue = it->second; // source is a Utf8Str
4892
4893 /* return the result to caller (may be empty) */
4894 return S_OK;
4895}
4896
4897 /**
4898 * @note Locks mParent for writing + this object for writing.
4899 */
4900HRESULT Machine::setExtraData(const com::Utf8Str &aKey, const com::Utf8Str &aValue)
4901{
4902 Utf8Str strOldValue; // empty
4903
4904 // locking note: we only hold the read lock briefly to look up the old value,
4905 // then release it and call the onExtraCanChange callbacks. There is a small
4906 // chance of a race insofar as the callback might be called twice if two callers
4907 // change the same key at the same time, but that's a much better solution
4908 // than the deadlock we had here before. The actual changing of the extradata
4909 // is then performed under the write lock and race-free.
4910
4911 // look up the old value first; if nothing has changed then we need not do anything
4912 {
4913 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS); // hold read lock only while looking up
4914
4915 // For snapshots don't even think about allowing changes, extradata
4916 // is global for a machine, so there is nothing snapshot specific.
4917 if (i_isSnapshotMachine())
4918 return setError(VBOX_E_INVALID_VM_STATE,
4919 tr("Cannot set extradata for a snapshot"));
4920
4921 // check if the right IMachine instance is used
4922 if (mData->mRegistered && !i_isSessionMachine())
4923 return setError(VBOX_E_INVALID_VM_STATE,
4924 tr("Cannot set extradata for an immutable machine"));
4925
4926 settings::StringsMap::const_iterator it = mData->pMachineConfigFile->mapExtraDataItems.find(aKey);
4927 if (it != mData->pMachineConfigFile->mapExtraDataItems.end())
4928 strOldValue = it->second;
4929 }
4930
4931 bool fChanged;
4932 if ((fChanged = (strOldValue != aValue)))
4933 {
4934 // ask for permission from all listeners outside the locks;
4935 // i_onExtraDataCanChange() only briefly requests the VirtualBox
4936 // lock to copy the list of callbacks to invoke
4937 Bstr error;
4938 Bstr bstrValue(aValue);
4939
4940 if (!mParent->i_onExtraDataCanChange(mData->mUuid, Bstr(aKey).raw(), bstrValue.raw(), error))
4941 {
4942 const char *sep = error.isEmpty() ? "" : ": ";
4943 CBSTR err = error.raw();
4944 Log1WarningFunc(("Someone vetoed! Change refused%s%ls\n", sep, err));
4945 return setError(E_ACCESSDENIED,
4946 tr("Could not set extra data because someone refused the requested change of '%s' to '%s'%s%ls"),
4947 aKey.c_str(),
4948 aValue.c_str(),
4949 sep,
4950 err);
4951 }
4952
4953 // data is changing and change not vetoed: then write it out under the lock
4954 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
4955
4956 if (aValue.isEmpty())
4957 mData->pMachineConfigFile->mapExtraDataItems.erase(aKey);
4958 else
4959 mData->pMachineConfigFile->mapExtraDataItems[aKey] = aValue;
4960 // creates a new key if needed
4961
4962 bool fNeedsGlobalSaveSettings = false;
4963 // This saving of settings is tricky: there is no "old state" for the
4964 // extradata items at all (unlike all other settings), so the old/new
4965 // settings comparison would give a wrong result!
4966 i_saveSettings(&fNeedsGlobalSaveSettings, SaveS_Force);
4967
4968 if (fNeedsGlobalSaveSettings)
4969 {
4970 // save the global settings; for that we should hold only the VirtualBox lock
4971 alock.release();
4972 AutoWriteLock vboxlock(mParent COMMA_LOCKVAL_SRC_POS);
4973 mParent->i_saveSettings();
4974 }
4975 }
4976
4977 // fire notification outside the lock
4978 if (fChanged)
4979 mParent->i_onExtraDataChange(mData->mUuid, Bstr(aKey).raw(), Bstr(aValue).raw());
4980
4981 return S_OK;
4982}
4983
4984HRESULT Machine::setSettingsFilePath(const com::Utf8Str &aSettingsFilePath, ComPtr<IProgress> &aProgress)
4985{
4986 aProgress = NULL;
4987 NOREF(aSettingsFilePath);
4988 ReturnComNotImplemented();
4989}
4990
4991HRESULT Machine::saveSettings()
4992{
4993 AutoWriteLock mlock(this COMMA_LOCKVAL_SRC_POS);
4994
4995 HRESULT rc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
4996 if (FAILED(rc)) return rc;
4997
4998 /* the settings file path may never be null */
4999 ComAssertRet(!mData->m_strConfigFileFull.isEmpty(), E_FAIL);
5000
5001 /* save all VM data excluding snapshots */
5002 bool fNeedsGlobalSaveSettings = false;
5003 rc = i_saveSettings(&fNeedsGlobalSaveSettings);
5004 mlock.release();
5005
5006 if (SUCCEEDED(rc) && fNeedsGlobalSaveSettings)
5007 {
5008 // save the global settings; for that we should hold only the VirtualBox lock
5009 AutoWriteLock vlock(mParent COMMA_LOCKVAL_SRC_POS);
5010 rc = mParent->i_saveSettings();
5011 }
5012
5013 return rc;
5014}
5015
5016
5017HRESULT Machine::discardSettings()
5018{
5019 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5020
5021 HRESULT rc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
5022 if (FAILED(rc)) return rc;
5023
5024 /*
5025 * during this rollback, the session will be notified if data has
5026 * been actually changed
5027 */
5028 i_rollback(true /* aNotify */);
5029
5030 return S_OK;
5031}
5032
5033/** @note Locks objects! */
5034HRESULT Machine::unregister(AutoCaller &autoCaller,
5035 CleanupMode_T aCleanupMode,
5036 std::vector<ComPtr<IMedium> > &aMedia)
5037{
5038 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5039
5040 Guid id(i_getId());
5041
5042 if (mData->mSession.mState != SessionState_Unlocked)
5043 return setError(VBOX_E_INVALID_OBJECT_STATE,
5044 tr("Cannot unregister the machine '%s' while it is locked"),
5045 mUserData->s.strName.c_str());
5046
5047 // wait for state dependents to drop to zero
5048 i_ensureNoStateDependencies();
5049
5050 if (!mData->mAccessible)
5051 {
5052 // inaccessible maschines can only be unregistered; uninitialize ourselves
5053 // here because currently there may be no unregistered that are inaccessible
5054 // (this state combination is not supported). Note releasing the caller and
5055 // leaving the lock before calling uninit()
5056 alock.release();
5057 autoCaller.release();
5058
5059 uninit();
5060
5061 mParent->i_unregisterMachine(this, id);
5062 // calls VirtualBox::i_saveSettings()
5063
5064 return S_OK;
5065 }
5066
5067 HRESULT rc = S_OK;
5068
5069 /// @todo r=klaus this is stupid... why is the saved state always deleted?
5070 // discard saved state
5071 if (mData->mMachineState == MachineState_Saved)
5072 {
5073 // add the saved state file to the list of files the caller should delete
5074 Assert(!mSSData->strStateFilePath.isEmpty());
5075 mData->llFilesToDelete.push_back(mSSData->strStateFilePath);
5076
5077 mSSData->strStateFilePath.setNull();
5078
5079 // unconditionally set the machine state to powered off, we now
5080 // know no session has locked the machine
5081 mData->mMachineState = MachineState_PoweredOff;
5082 }
5083
5084 size_t cSnapshots = 0;
5085 if (mData->mFirstSnapshot)
5086 cSnapshots = mData->mFirstSnapshot->i_getAllChildrenCount() + 1;
5087 if (cSnapshots && aCleanupMode == CleanupMode_UnregisterOnly)
5088 // fail now before we start detaching media
5089 return setError(VBOX_E_INVALID_OBJECT_STATE,
5090 tr("Cannot unregister the machine '%s' because it has %d snapshots"),
5091 mUserData->s.strName.c_str(), cSnapshots);
5092
5093 // This list collects the medium objects from all medium attachments
5094 // which we will detach from the machine and its snapshots, in a specific
5095 // order which allows for closing all media without getting "media in use"
5096 // errors, simply by going through the list from the front to the back:
5097 // 1) first media from machine attachments (these have the "leaf" attachments with snapshots
5098 // and must be closed before the parent media from the snapshots, or closing the parents
5099 // will fail because they still have children);
5100 // 2) media from the youngest snapshots followed by those from the parent snapshots until
5101 // the root ("first") snapshot of the machine.
5102 MediaList llMedia;
5103
5104 if ( !mMediaData.isNull() // can be NULL if machine is inaccessible
5105 && mMediaData->mAttachments.size()
5106 )
5107 {
5108 // we have media attachments: detach them all and add the Medium objects to our list
5109 if (aCleanupMode != CleanupMode_UnregisterOnly)
5110 i_detachAllMedia(alock, NULL /* pSnapshot */, aCleanupMode, llMedia);
5111 else
5112 return setError(VBOX_E_INVALID_OBJECT_STATE,
5113 tr("Cannot unregister the machine '%s' because it has %d media attachments"),
5114 mUserData->s.strName.c_str(), mMediaData->mAttachments.size());
5115 }
5116
5117 if (cSnapshots)
5118 {
5119 // add the media from the medium attachments of the snapshots to llMedia
5120 // as well, after the "main" machine media; Snapshot::uninitRecursively()
5121 // calls Machine::detachAllMedia() for the snapshot machine, recursing
5122 // into the children first
5123
5124 // Snapshot::beginDeletingSnapshot() asserts if the machine state is not this
5125 MachineState_T oldState = mData->mMachineState;
5126 mData->mMachineState = MachineState_DeletingSnapshot;
5127
5128 // make a copy of the first snapshot so the refcount does not drop to 0
5129 // in beginDeletingSnapshot, which sets pFirstSnapshot to 0 (that hangs
5130 // because of the AutoCaller voodoo)
5131 ComObjPtr<Snapshot> pFirstSnapshot = mData->mFirstSnapshot;
5132
5133 // GO!
5134 pFirstSnapshot->i_uninitRecursively(alock, aCleanupMode, llMedia, mData->llFilesToDelete);
5135
5136 mData->mMachineState = oldState;
5137 }
5138
5139 if (FAILED(rc))
5140 {
5141 i_rollbackMedia();
5142 return rc;
5143 }
5144
5145 // commit all the media changes made above
5146 i_commitMedia();
5147
5148 mData->mRegistered = false;
5149
5150 // machine lock no longer needed
5151 alock.release();
5152
5153 // return media to caller
5154 size_t i = 0;
5155 aMedia.resize(llMedia.size());
5156 for (MediaList::iterator it = llMedia.begin(); it != llMedia.end(); ++it, ++i)
5157 (*it).queryInterfaceTo(aMedia[i].asOutParam());
5158
5159 mParent->i_unregisterMachine(this, id);
5160 // calls VirtualBox::i_saveSettings() and VirtualBox::saveModifiedRegistries()
5161
5162 return S_OK;
5163}
5164
5165/**
5166 * Task record for deleting a machine config.
5167 */
5168struct Machine::DeleteConfigTask
5169 : public Machine::Task
5170{
5171 DeleteConfigTask(Machine *m,
5172 Progress *p,
5173 const Utf8Str &t,
5174 const RTCList<ComPtr<IMedium> > &llMediums,
5175 const StringsList &llFilesToDelete)
5176 : Task(m, p, t),
5177 m_llMediums(llMediums),
5178 m_llFilesToDelete(llFilesToDelete)
5179 {}
5180
5181 void handler()
5182 {
5183 m_pMachine->i_deleteConfigHandler(*this);
5184 }
5185
5186 RTCList<ComPtr<IMedium> > m_llMediums;
5187 StringsList m_llFilesToDelete;
5188};
5189
5190/**
5191 * Task thread implementation for SessionMachine::DeleteConfig(), called from
5192 * SessionMachine::taskHandler().
5193 *
5194 * @note Locks this object for writing.
5195 *
5196 * @param task
5197 * @return
5198 */
5199void Machine::i_deleteConfigHandler(DeleteConfigTask &task)
5200{
5201 LogFlowThisFuncEnter();
5202
5203 AutoCaller autoCaller(this);
5204 LogFlowThisFunc(("state=%d\n", getObjectState().getState()));
5205 if (FAILED(autoCaller.rc()))
5206 {
5207 /* we might have been uninitialized because the session was accidentally
5208 * closed by the client, so don't assert */
5209 HRESULT rc = setError(E_FAIL,
5210 tr("The session has been accidentally closed"));
5211 task.m_pProgress->i_notifyComplete(rc);
5212 LogFlowThisFuncLeave();
5213 return;
5214 }
5215
5216 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5217
5218 HRESULT rc = S_OK;
5219
5220 try
5221 {
5222 ULONG uLogHistoryCount = 3;
5223 ComPtr<ISystemProperties> systemProperties;
5224 rc = mParent->COMGETTER(SystemProperties)(systemProperties.asOutParam());
5225 if (FAILED(rc)) throw rc;
5226
5227 if (!systemProperties.isNull())
5228 {
5229 rc = systemProperties->COMGETTER(LogHistoryCount)(&uLogHistoryCount);
5230 if (FAILED(rc)) throw rc;
5231 }
5232
5233 MachineState_T oldState = mData->mMachineState;
5234 i_setMachineState(MachineState_SettingUp);
5235 alock.release();
5236 for (size_t i = 0; i < task.m_llMediums.size(); ++i)
5237 {
5238 ComObjPtr<Medium> pMedium = (Medium*)(IMedium*)(task.m_llMediums.at(i));
5239 {
5240 AutoCaller mac(pMedium);
5241 if (FAILED(mac.rc())) throw mac.rc();
5242 Utf8Str strLocation = pMedium->i_getLocationFull();
5243 rc = task.m_pProgress->SetNextOperation(BstrFmt(tr("Deleting '%s'"), strLocation.c_str()).raw(), 1);
5244 if (FAILED(rc)) throw rc;
5245 LogFunc(("Deleting file %s\n", strLocation.c_str()));
5246 }
5247 if (pMedium->i_isMediumFormatFile())
5248 {
5249 ComPtr<IProgress> pProgress2;
5250 rc = pMedium->DeleteStorage(pProgress2.asOutParam());
5251 if (FAILED(rc)) throw rc;
5252 rc = task.m_pProgress->WaitForAsyncProgressCompletion(pProgress2);
5253 if (FAILED(rc)) throw rc;
5254 /* Check the result of the asynchronous process. */
5255 LONG iRc;
5256 rc = pProgress2->COMGETTER(ResultCode)(&iRc);
5257 if (FAILED(rc)) throw rc;
5258 /* If the thread of the progress object has an error, then
5259 * retrieve the error info from there, or it'll be lost. */
5260 if (FAILED(iRc))
5261 throw setError(ProgressErrorInfo(pProgress2));
5262 }
5263
5264 /* Close the medium, deliberately without checking the return
5265 * code, and without leaving any trace in the error info, as
5266 * a failure here is a very minor issue, which shouldn't happen
5267 * as above we even managed to delete the medium. */
5268 {
5269 ErrorInfoKeeper eik;
5270 pMedium->Close();
5271 }
5272 }
5273 i_setMachineState(oldState);
5274 alock.acquire();
5275
5276 // delete the files pushed on the task list by Machine::Delete()
5277 // (this includes saved states of the machine and snapshots and
5278 // medium storage files from the IMedium list passed in, and the
5279 // machine XML file)
5280 StringsList::const_iterator it = task.m_llFilesToDelete.begin();
5281 while (it != task.m_llFilesToDelete.end())
5282 {
5283 const Utf8Str &strFile = *it;
5284 LogFunc(("Deleting file %s\n", strFile.c_str()));
5285 int vrc = RTFileDelete(strFile.c_str());
5286 if (RT_FAILURE(vrc))
5287 throw setError(VBOX_E_IPRT_ERROR,
5288 tr("Could not delete file '%s' (%Rrc)"), strFile.c_str(), vrc);
5289
5290 ++it;
5291 if (it == task.m_llFilesToDelete.end())
5292 {
5293 rc = task.m_pProgress->SetNextOperation(Bstr(tr("Cleaning up machine directory")).raw(), 1);
5294 if (FAILED(rc)) throw rc;
5295 break;
5296 }
5297
5298 rc = task.m_pProgress->SetNextOperation(BstrFmt(tr("Deleting '%s'"), it->c_str()).raw(), 1);
5299 if (FAILED(rc)) throw rc;
5300 }
5301
5302 /* delete the settings only when the file actually exists */
5303 if (mData->pMachineConfigFile->fileExists())
5304 {
5305 /* Delete any backup or uncommitted XML files. Ignore failures.
5306 See the fSafe parameter of xml::XmlFileWriter::write for details. */
5307 /** @todo Find a way to avoid referring directly to iprt/xml.h here. */
5308 Utf8Str otherXml = Utf8StrFmt("%s%s", mData->m_strConfigFileFull.c_str(), xml::XmlFileWriter::s_pszTmpSuff);
5309 RTFileDelete(otherXml.c_str());
5310 otherXml = Utf8StrFmt("%s%s", mData->m_strConfigFileFull.c_str(), xml::XmlFileWriter::s_pszPrevSuff);
5311 RTFileDelete(otherXml.c_str());
5312
5313 /* delete the Logs folder, nothing important should be left
5314 * there (we don't check for errors because the user might have
5315 * some private files there that we don't want to delete) */
5316 Utf8Str logFolder;
5317 getLogFolder(logFolder);
5318 Assert(logFolder.length());
5319 if (RTDirExists(logFolder.c_str()))
5320 {
5321 /* Delete all VBox.log[.N] files from the Logs folder
5322 * (this must be in sync with the rotation logic in
5323 * Console::powerUpThread()). Also, delete the VBox.png[.N]
5324 * files that may have been created by the GUI. */
5325 Utf8Str log = Utf8StrFmt("%s%cVBox.log",
5326 logFolder.c_str(), RTPATH_DELIMITER);
5327 RTFileDelete(log.c_str());
5328 log = Utf8StrFmt("%s%cVBox.png",
5329 logFolder.c_str(), RTPATH_DELIMITER);
5330 RTFileDelete(log.c_str());
5331 for (int i = uLogHistoryCount; i > 0; i--)
5332 {
5333 log = Utf8StrFmt("%s%cVBox.log.%d",
5334 logFolder.c_str(), RTPATH_DELIMITER, i);
5335 RTFileDelete(log.c_str());
5336 log = Utf8StrFmt("%s%cVBox.png.%d",
5337 logFolder.c_str(), RTPATH_DELIMITER, i);
5338 RTFileDelete(log.c_str());
5339 }
5340#if defined(RT_OS_WINDOWS)
5341 log = Utf8StrFmt("%s%cVBoxStartup.log",
5342 logFolder.c_str(), RTPATH_DELIMITER);
5343 RTFileDelete(log.c_str());
5344#endif
5345
5346 RTDirRemove(logFolder.c_str());
5347 }
5348
5349 /* delete the Snapshots folder, nothing important should be left
5350 * there (we don't check for errors because the user might have
5351 * some private files there that we don't want to delete) */
5352 Utf8Str strFullSnapshotFolder;
5353 i_calculateFullPath(mUserData->s.strSnapshotFolder, strFullSnapshotFolder);
5354 Assert(!strFullSnapshotFolder.isEmpty());
5355 if (RTDirExists(strFullSnapshotFolder.c_str()))
5356 RTDirRemove(strFullSnapshotFolder.c_str());
5357
5358 // delete the directory that contains the settings file, but only
5359 // if it matches the VM name
5360 Utf8Str settingsDir;
5361 if (i_isInOwnDir(&settingsDir))
5362 RTDirRemove(settingsDir.c_str());
5363 }
5364
5365 alock.release();
5366
5367 mParent->i_saveModifiedRegistries();
5368 }
5369 catch (HRESULT aRC) { rc = aRC; }
5370
5371 task.m_pProgress->i_notifyComplete(rc);
5372
5373 LogFlowThisFuncLeave();
5374}
5375
5376HRESULT Machine::deleteConfig(const std::vector<ComPtr<IMedium> > &aMedia, ComPtr<IProgress> &aProgress)
5377{
5378 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5379
5380 HRESULT rc = i_checkStateDependency(MutableStateDep);
5381 if (FAILED(rc)) return rc;
5382
5383 if (mData->mRegistered)
5384 return setError(VBOX_E_INVALID_VM_STATE,
5385 tr("Cannot delete settings of a registered machine"));
5386
5387 // collect files to delete
5388 StringsList llFilesToDelete(mData->llFilesToDelete); // saved states pushed here by Unregister()
5389 if (mData->pMachineConfigFile->fileExists())
5390 llFilesToDelete.push_back(mData->m_strConfigFileFull);
5391
5392 RTCList<ComPtr<IMedium> > llMediums;
5393 for (size_t i = 0; i < aMedia.size(); ++i)
5394 {
5395 IMedium *pIMedium(aMedia[i]);
5396 ComObjPtr<Medium> pMedium = static_cast<Medium*>(pIMedium);
5397 if (pMedium.isNull())
5398 return setError(E_INVALIDARG, "The given medium pointer with index %d is invalid", i);
5399 SafeArray<BSTR> ids;
5400 rc = pMedium->COMGETTER(MachineIds)(ComSafeArrayAsOutParam(ids));
5401 if (FAILED(rc)) return rc;
5402 /* At this point the medium should not have any back references
5403 * anymore. If it has it is attached to another VM and *must* not
5404 * deleted. */
5405 if (ids.size() < 1)
5406 llMediums.append(pMedium);
5407 }
5408
5409 ComObjPtr<Progress> pProgress;
5410 pProgress.createObject();
5411 rc = pProgress->init(i_getVirtualBox(),
5412 static_cast<IMachine*>(this) /* aInitiator */,
5413 Bstr(tr("Deleting files")).raw(),
5414 true /* fCancellable */,
5415 (ULONG)(llFilesToDelete.size() + llMediums.size() + 1), // cOperations
5416 BstrFmt(tr("Deleting '%s'"), llFilesToDelete.front().c_str()).raw());
5417 if (FAILED(rc))
5418 return rc;
5419
5420 /* create and start the task on a separate thread (note that it will not
5421 * start working until we release alock) */
5422 DeleteConfigTask *pTask = new DeleteConfigTask(this, pProgress, "DeleteVM", llMediums, llFilesToDelete);
5423 rc = pTask->createThread();
5424 if (FAILED(rc))
5425 return rc;
5426
5427 pProgress.queryInterfaceTo(aProgress.asOutParam());
5428
5429 LogFlowFuncLeave();
5430
5431 return S_OK;
5432}
5433
5434HRESULT Machine::findSnapshot(const com::Utf8Str &aNameOrId, ComPtr<ISnapshot> &aSnapshot)
5435{
5436 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5437
5438 ComObjPtr<Snapshot> pSnapshot;
5439 HRESULT rc;
5440
5441 if (aNameOrId.isEmpty())
5442 // null case (caller wants root snapshot): i_findSnapshotById() handles this
5443 rc = i_findSnapshotById(Guid(), pSnapshot, true /* aSetError */);
5444 else
5445 {
5446 Guid uuid(aNameOrId);
5447 if (uuid.isValid())
5448 rc = i_findSnapshotById(uuid, pSnapshot, true /* aSetError */);
5449 else
5450 rc = i_findSnapshotByName(aNameOrId, pSnapshot, true /* aSetError */);
5451 }
5452 pSnapshot.queryInterfaceTo(aSnapshot.asOutParam());
5453
5454 return rc;
5455}
5456
5457HRESULT Machine::createSharedFolder(const com::Utf8Str &aName, const com::Utf8Str &aHostPath, BOOL aWritable, BOOL aAutomount)
5458{
5459 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5460
5461 HRESULT rc = i_checkStateDependency(MutableOrRunningStateDep);
5462 if (FAILED(rc)) return rc;
5463
5464 ComObjPtr<SharedFolder> sharedFolder;
5465 rc = i_findSharedFolder(aName, sharedFolder, false /* aSetError */);
5466 if (SUCCEEDED(rc))
5467 return setError(VBOX_E_OBJECT_IN_USE,
5468 tr("Shared folder named '%s' already exists"),
5469 aName.c_str());
5470
5471 sharedFolder.createObject();
5472 rc = sharedFolder->init(i_getMachine(),
5473 aName,
5474 aHostPath,
5475 !!aWritable,
5476 !!aAutomount,
5477 true /* fFailOnError */);
5478 if (FAILED(rc)) return rc;
5479
5480 i_setModified(IsModified_SharedFolders);
5481 mHWData.backup();
5482 mHWData->mSharedFolders.push_back(sharedFolder);
5483
5484 /* inform the direct session if any */
5485 alock.release();
5486 i_onSharedFolderChange();
5487
5488 return S_OK;
5489}
5490
5491HRESULT Machine::removeSharedFolder(const com::Utf8Str &aName)
5492{
5493 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5494
5495 HRESULT rc = i_checkStateDependency(MutableOrRunningStateDep);
5496 if (FAILED(rc)) return rc;
5497
5498 ComObjPtr<SharedFolder> sharedFolder;
5499 rc = i_findSharedFolder(aName, sharedFolder, true /* aSetError */);
5500 if (FAILED(rc)) return rc;
5501
5502 i_setModified(IsModified_SharedFolders);
5503 mHWData.backup();
5504 mHWData->mSharedFolders.remove(sharedFolder);
5505
5506 /* inform the direct session if any */
5507 alock.release();
5508 i_onSharedFolderChange();
5509
5510 return S_OK;
5511}
5512
5513HRESULT Machine::canShowConsoleWindow(BOOL *aCanShow)
5514{
5515 /* start with No */
5516 *aCanShow = FALSE;
5517
5518 ComPtr<IInternalSessionControl> directControl;
5519 {
5520 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5521
5522 if (mData->mSession.mState != SessionState_Locked)
5523 return setError(VBOX_E_INVALID_VM_STATE,
5524 tr("Machine is not locked for session (session state: %s)"),
5525 Global::stringifySessionState(mData->mSession.mState));
5526
5527 if (mData->mSession.mLockType == LockType_VM)
5528 directControl = mData->mSession.mDirectControl;
5529 }
5530
5531 /* ignore calls made after #OnSessionEnd() is called */
5532 if (!directControl)
5533 return S_OK;
5534
5535 LONG64 dummy;
5536 return directControl->OnShowWindow(TRUE /* aCheck */, aCanShow, &dummy);
5537}
5538
5539HRESULT Machine::showConsoleWindow(LONG64 *aWinId)
5540{
5541 ComPtr<IInternalSessionControl> directControl;
5542 {
5543 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5544
5545 if (mData->mSession.mState != SessionState_Locked)
5546 return setError(E_FAIL,
5547 tr("Machine is not locked for session (session state: %s)"),
5548 Global::stringifySessionState(mData->mSession.mState));
5549
5550 if (mData->mSession.mLockType == LockType_VM)
5551 directControl = mData->mSession.mDirectControl;
5552 }
5553
5554 /* ignore calls made after #OnSessionEnd() is called */
5555 if (!directControl)
5556 return S_OK;
5557
5558 BOOL dummy;
5559 return directControl->OnShowWindow(FALSE /* aCheck */, &dummy, aWinId);
5560}
5561
5562#ifdef VBOX_WITH_GUEST_PROPS
5563/**
5564 * Look up a guest property in VBoxSVC's internal structures.
5565 */
5566HRESULT Machine::i_getGuestPropertyFromService(const com::Utf8Str &aName,
5567 com::Utf8Str &aValue,
5568 LONG64 *aTimestamp,
5569 com::Utf8Str &aFlags) const
5570{
5571 using namespace guestProp;
5572
5573 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5574 HWData::GuestPropertyMap::const_iterator it = mHWData->mGuestProperties.find(aName);
5575
5576 if (it != mHWData->mGuestProperties.end())
5577 {
5578 char szFlags[MAX_FLAGS_LEN + 1];
5579 aValue = it->second.strValue;
5580 *aTimestamp = it->second.mTimestamp;
5581 writeFlags(it->second.mFlags, szFlags);
5582 aFlags = Utf8Str(szFlags);
5583 }
5584
5585 return S_OK;
5586}
5587
5588/**
5589 * Query the VM that a guest property belongs to for the property.
5590 * @returns E_ACCESSDENIED if the VM process is not available or not
5591 * currently handling queries and the lookup should then be done in
5592 * VBoxSVC.
5593 */
5594HRESULT Machine::i_getGuestPropertyFromVM(const com::Utf8Str &aName,
5595 com::Utf8Str &aValue,
5596 LONG64 *aTimestamp,
5597 com::Utf8Str &aFlags) const
5598{
5599 HRESULT rc = S_OK;
5600 BSTR bValue = NULL;
5601 BSTR bFlags = NULL;
5602
5603 ComPtr<IInternalSessionControl> directControl;
5604 {
5605 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5606 if (mData->mSession.mLockType == LockType_VM)
5607 directControl = mData->mSession.mDirectControl;
5608 }
5609
5610 /* ignore calls made after #OnSessionEnd() is called */
5611 if (!directControl)
5612 rc = E_ACCESSDENIED;
5613 else
5614 rc = directControl->AccessGuestProperty(Bstr(aName).raw(), Bstr("").raw(), Bstr("").raw(),
5615 0 /* accessMode */,
5616 &bValue, aTimestamp, &bFlags);
5617
5618 aValue = bValue;
5619 aFlags = bFlags;
5620
5621 return rc;
5622}
5623#endif // VBOX_WITH_GUEST_PROPS
5624
5625HRESULT Machine::getGuestProperty(const com::Utf8Str &aName,
5626 com::Utf8Str &aValue,
5627 LONG64 *aTimestamp,
5628 com::Utf8Str &aFlags)
5629{
5630#ifndef VBOX_WITH_GUEST_PROPS
5631 ReturnComNotImplemented();
5632#else // VBOX_WITH_GUEST_PROPS
5633
5634 HRESULT rc = i_getGuestPropertyFromVM(aName, aValue, aTimestamp, aFlags);
5635
5636 if (rc == E_ACCESSDENIED)
5637 /* The VM is not running or the service is not (yet) accessible */
5638 rc = i_getGuestPropertyFromService(aName, aValue, aTimestamp, aFlags);
5639 return rc;
5640#endif // VBOX_WITH_GUEST_PROPS
5641}
5642
5643HRESULT Machine::getGuestPropertyValue(const com::Utf8Str &aProperty, com::Utf8Str &aValue)
5644{
5645 LONG64 dummyTimestamp;
5646 com::Utf8Str dummyFlags;
5647 HRESULT rc = getGuestProperty(aProperty, aValue, &dummyTimestamp, dummyFlags);
5648 return rc;
5649
5650}
5651HRESULT Machine::getGuestPropertyTimestamp(const com::Utf8Str &aProperty, LONG64 *aValue)
5652{
5653 com::Utf8Str dummyFlags;
5654 com::Utf8Str dummyValue;
5655 HRESULT rc = getGuestProperty(aProperty, dummyValue, aValue, dummyFlags);
5656 return rc;
5657}
5658
5659#ifdef VBOX_WITH_GUEST_PROPS
5660/**
5661 * Set a guest property in VBoxSVC's internal structures.
5662 */
5663HRESULT Machine::i_setGuestPropertyToService(const com::Utf8Str &aName, const com::Utf8Str &aValue,
5664 const com::Utf8Str &aFlags, bool fDelete)
5665{
5666 using namespace guestProp;
5667
5668 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5669 HRESULT rc = S_OK;
5670
5671 rc = i_checkStateDependency(MutableOrSavedStateDep);
5672 if (FAILED(rc)) return rc;
5673
5674 try
5675 {
5676 uint32_t fFlags = NILFLAG;
5677 if (aFlags.length() && RT_FAILURE(validateFlags(aFlags.c_str(), &fFlags)))
5678 return setError(E_INVALIDARG, tr("Invalid guest property flag values: '%s'"), aFlags.c_str());
5679
5680 HWData::GuestPropertyMap::iterator it = mHWData->mGuestProperties.find(aName);
5681 if (it == mHWData->mGuestProperties.end())
5682 {
5683 if (!fDelete)
5684 {
5685 i_setModified(IsModified_MachineData);
5686 mHWData.backupEx();
5687
5688 RTTIMESPEC time;
5689 HWData::GuestProperty prop;
5690 prop.strValue = Bstr(aValue).raw();
5691 prop.mTimestamp = RTTimeSpecGetNano(RTTimeNow(&time));
5692 prop.mFlags = fFlags;
5693 mHWData->mGuestProperties[aName] = prop;
5694 }
5695 }
5696 else
5697 {
5698 if (it->second.mFlags & (RDONLYHOST))
5699 {
5700 rc = setError(E_ACCESSDENIED, tr("The property '%s' cannot be changed by the host"), aName.c_str());
5701 }
5702 else
5703 {
5704 i_setModified(IsModified_MachineData);
5705 mHWData.backupEx();
5706
5707 /* The backupEx() operation invalidates our iterator,
5708 * so get a new one. */
5709 it = mHWData->mGuestProperties.find(aName);
5710 Assert(it != mHWData->mGuestProperties.end());
5711
5712 if (!fDelete)
5713 {
5714 RTTIMESPEC time;
5715 it->second.strValue = aValue;
5716 it->second.mTimestamp = RTTimeSpecGetNano(RTTimeNow(&time));
5717 it->second.mFlags = fFlags;
5718 }
5719 else
5720 mHWData->mGuestProperties.erase(it);
5721 }
5722 }
5723
5724 if (SUCCEEDED(rc))
5725 {
5726 alock.release();
5727
5728 mParent->i_onGuestPropertyChange(mData->mUuid,
5729 Bstr(aName).raw(),
5730 Bstr(aValue).raw(),
5731 Bstr(aFlags).raw());
5732 }
5733 }
5734 catch (std::bad_alloc &)
5735 {
5736 rc = E_OUTOFMEMORY;
5737 }
5738
5739 return rc;
5740}
5741
5742/**
5743 * Set a property on the VM that that property belongs to.
5744 * @returns E_ACCESSDENIED if the VM process is not available or not
5745 * currently handling queries and the setting should then be done in
5746 * VBoxSVC.
5747 */
5748HRESULT Machine::i_setGuestPropertyToVM(const com::Utf8Str &aName, const com::Utf8Str &aValue,
5749 const com::Utf8Str &aFlags, bool fDelete)
5750{
5751 HRESULT rc;
5752
5753 try
5754 {
5755 ComPtr<IInternalSessionControl> directControl;
5756 {
5757 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5758 if (mData->mSession.mLockType == LockType_VM)
5759 directControl = mData->mSession.mDirectControl;
5760 }
5761
5762 BSTR dummy = NULL; /* will not be changed (setter) */
5763 LONG64 dummy64;
5764 if (!directControl)
5765 rc = E_ACCESSDENIED;
5766 else
5767 /** @todo Fix when adding DeleteGuestProperty(), see defect. */
5768 rc = directControl->AccessGuestProperty(Bstr(aName).raw(), Bstr(aValue).raw(), Bstr(aFlags).raw(),
5769 fDelete? 2: 1 /* accessMode */,
5770 &dummy, &dummy64, &dummy);
5771 }
5772 catch (std::bad_alloc &)
5773 {
5774 rc = E_OUTOFMEMORY;
5775 }
5776
5777 return rc;
5778}
5779#endif // VBOX_WITH_GUEST_PROPS
5780
5781HRESULT Machine::setGuestProperty(const com::Utf8Str &aProperty, const com::Utf8Str &aValue,
5782 const com::Utf8Str &aFlags)
5783{
5784#ifndef VBOX_WITH_GUEST_PROPS
5785 ReturnComNotImplemented();
5786#else // VBOX_WITH_GUEST_PROPS
5787 HRESULT rc = i_setGuestPropertyToVM(aProperty, aValue, aFlags, /* fDelete = */ false);
5788 if (rc == E_ACCESSDENIED)
5789 /* The VM is not running or the service is not (yet) accessible */
5790 rc = i_setGuestPropertyToService(aProperty, aValue, aFlags, /* fDelete = */ false);
5791 return rc;
5792#endif // VBOX_WITH_GUEST_PROPS
5793}
5794
5795HRESULT Machine::setGuestPropertyValue(const com::Utf8Str &aProperty, const com::Utf8Str &aValue)
5796{
5797 return setGuestProperty(aProperty, aValue, "");
5798}
5799
5800HRESULT Machine::deleteGuestProperty(const com::Utf8Str &aName)
5801{
5802#ifndef VBOX_WITH_GUEST_PROPS
5803 ReturnComNotImplemented();
5804#else // VBOX_WITH_GUEST_PROPS
5805 HRESULT rc = i_setGuestPropertyToVM(aName, "", "", /* fDelete = */ true);
5806 if (rc == E_ACCESSDENIED)
5807 /* The VM is not running or the service is not (yet) accessible */
5808 rc = i_setGuestPropertyToService(aName, "", "", /* fDelete = */ true);
5809 return rc;
5810#endif // VBOX_WITH_GUEST_PROPS
5811}
5812
5813#ifdef VBOX_WITH_GUEST_PROPS
5814/**
5815 * Enumerate the guest properties in VBoxSVC's internal structures.
5816 */
5817HRESULT Machine::i_enumerateGuestPropertiesInService(const com::Utf8Str &aPatterns,
5818 std::vector<com::Utf8Str> &aNames,
5819 std::vector<com::Utf8Str> &aValues,
5820 std::vector<LONG64> &aTimestamps,
5821 std::vector<com::Utf8Str> &aFlags)
5822{
5823 using namespace guestProp;
5824
5825 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5826 Utf8Str strPatterns(aPatterns);
5827
5828 HWData::GuestPropertyMap propMap;
5829
5830 /*
5831 * Look for matching patterns and build up a list.
5832 */
5833 HWData::GuestPropertyMap::const_iterator it = mHWData->mGuestProperties.begin();
5834 while (it != mHWData->mGuestProperties.end())
5835 {
5836 if ( strPatterns.isEmpty()
5837 || RTStrSimplePatternMultiMatch(strPatterns.c_str(),
5838 RTSTR_MAX,
5839 it->first.c_str(),
5840 RTSTR_MAX,
5841 NULL)
5842 )
5843 propMap.insert(*it);
5844 ++it;
5845 }
5846
5847 alock.release();
5848
5849 /*
5850 * And build up the arrays for returning the property information.
5851 */
5852 size_t cEntries = propMap.size();
5853
5854 aNames.resize(cEntries);
5855 aValues.resize(cEntries);
5856 aTimestamps.resize(cEntries);
5857 aFlags.resize(cEntries);
5858
5859 char szFlags[MAX_FLAGS_LEN + 1];
5860 size_t i= 0;
5861 for (it = propMap.begin(); it != propMap.end(); ++i, ++it)
5862 {
5863 aNames[i] = it->first;
5864 aValues[i] = it->second.strValue;
5865 aTimestamps[i] = it->second.mTimestamp;
5866 writeFlags(it->second.mFlags, szFlags);
5867 aFlags[i] = Utf8Str(szFlags);
5868 }
5869
5870 return S_OK;
5871}
5872
5873/**
5874 * Enumerate the properties managed by a VM.
5875 * @returns E_ACCESSDENIED if the VM process is not available or not
5876 * currently handling queries and the setting should then be done in
5877 * VBoxSVC.
5878 */
5879HRESULT Machine::i_enumerateGuestPropertiesOnVM(const com::Utf8Str &aPatterns,
5880 std::vector<com::Utf8Str> &aNames,
5881 std::vector<com::Utf8Str> &aValues,
5882 std::vector<LONG64> &aTimestamps,
5883 std::vector<com::Utf8Str> &aFlags)
5884{
5885 HRESULT rc;
5886 ComPtr<IInternalSessionControl> directControl;
5887 {
5888 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5889 if (mData->mSession.mLockType == LockType_VM)
5890 directControl = mData->mSession.mDirectControl;
5891 }
5892
5893 com::SafeArray<BSTR> bNames;
5894 com::SafeArray<BSTR> bValues;
5895 com::SafeArray<LONG64> bTimestamps;
5896 com::SafeArray<BSTR> bFlags;
5897
5898 if (!directControl)
5899 rc = E_ACCESSDENIED;
5900 else
5901 rc = directControl->EnumerateGuestProperties(Bstr(aPatterns).raw(),
5902 ComSafeArrayAsOutParam(bNames),
5903 ComSafeArrayAsOutParam(bValues),
5904 ComSafeArrayAsOutParam(bTimestamps),
5905 ComSafeArrayAsOutParam(bFlags));
5906 size_t i;
5907 aNames.resize(bNames.size());
5908 for (i = 0; i < bNames.size(); ++i)
5909 aNames[i] = Utf8Str(bNames[i]);
5910 aValues.resize(bValues.size());
5911 for (i = 0; i < bValues.size(); ++i)
5912 aValues[i] = Utf8Str(bValues[i]);
5913 aTimestamps.resize(bTimestamps.size());
5914 for (i = 0; i < bTimestamps.size(); ++i)
5915 aTimestamps[i] = bTimestamps[i];
5916 aFlags.resize(bFlags.size());
5917 for (i = 0; i < bFlags.size(); ++i)
5918 aFlags[i] = Utf8Str(bFlags[i]);
5919
5920 return rc;
5921}
5922#endif // VBOX_WITH_GUEST_PROPS
5923HRESULT Machine::enumerateGuestProperties(const com::Utf8Str &aPatterns,
5924 std::vector<com::Utf8Str> &aNames,
5925 std::vector<com::Utf8Str> &aValues,
5926 std::vector<LONG64> &aTimestamps,
5927 std::vector<com::Utf8Str> &aFlags)
5928{
5929#ifndef VBOX_WITH_GUEST_PROPS
5930 ReturnComNotImplemented();
5931#else // VBOX_WITH_GUEST_PROPS
5932
5933 HRESULT rc = i_enumerateGuestPropertiesOnVM(aPatterns, aNames, aValues, aTimestamps, aFlags);
5934
5935 if (rc == E_ACCESSDENIED)
5936 /* The VM is not running or the service is not (yet) accessible */
5937 rc = i_enumerateGuestPropertiesInService(aPatterns, aNames, aValues, aTimestamps, aFlags);
5938 return rc;
5939#endif // VBOX_WITH_GUEST_PROPS
5940}
5941
5942HRESULT Machine::getMediumAttachmentsOfController(const com::Utf8Str &aName,
5943 std::vector<ComPtr<IMediumAttachment> > &aMediumAttachments)
5944{
5945 MediaData::AttachmentList atts;
5946
5947 HRESULT rc = i_getMediumAttachmentsOfController(aName, atts);
5948 if (FAILED(rc)) return rc;
5949
5950 size_t i = 0;
5951 aMediumAttachments.resize(atts.size());
5952 for (MediaData::AttachmentList::iterator it = atts.begin(); it != atts.end(); ++it, ++i)
5953 (*it).queryInterfaceTo(aMediumAttachments[i].asOutParam());
5954
5955 return S_OK;
5956}
5957
5958HRESULT Machine::getMediumAttachment(const com::Utf8Str &aName,
5959 LONG aControllerPort,
5960 LONG aDevice,
5961 ComPtr<IMediumAttachment> &aAttachment)
5962{
5963 LogFlowThisFunc(("aControllerName=\"%s\" aControllerPort=%d aDevice=%d\n",
5964 aName.c_str(), aControllerPort, aDevice));
5965
5966 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
5967
5968 aAttachment = NULL;
5969
5970 ComObjPtr<MediumAttachment> pAttach = i_findAttachment(mMediaData->mAttachments,
5971 Bstr(aName).raw(),
5972 aControllerPort,
5973 aDevice);
5974 if (pAttach.isNull())
5975 return setError(VBOX_E_OBJECT_NOT_FOUND,
5976 tr("No storage device attached to device slot %d on port %d of controller '%s'"),
5977 aDevice, aControllerPort, aName.c_str());
5978
5979 pAttach.queryInterfaceTo(aAttachment.asOutParam());
5980
5981 return S_OK;
5982}
5983
5984
5985HRESULT Machine::addStorageController(const com::Utf8Str &aName,
5986 StorageBus_T aConnectionType,
5987 ComPtr<IStorageController> &aController)
5988{
5989 if ( (aConnectionType <= StorageBus_Null)
5990 || (aConnectionType > StorageBus_USB))
5991 return setError(E_INVALIDARG,
5992 tr("Invalid connection type: %d"),
5993 aConnectionType);
5994
5995 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
5996
5997 HRESULT rc = i_checkStateDependency(MutableStateDep);
5998 if (FAILED(rc)) return rc;
5999
6000 /* try to find one with the name first. */
6001 ComObjPtr<StorageController> ctrl;
6002
6003 rc = i_getStorageControllerByName(aName, ctrl, false /* aSetError */);
6004 if (SUCCEEDED(rc))
6005 return setError(VBOX_E_OBJECT_IN_USE,
6006 tr("Storage controller named '%s' already exists"),
6007 aName.c_str());
6008
6009 ctrl.createObject();
6010
6011 /* get a new instance number for the storage controller */
6012 ULONG ulInstance = 0;
6013 bool fBootable = true;
6014 for (StorageControllerList::const_iterator it = mStorageControllers->begin();
6015 it != mStorageControllers->end();
6016 ++it)
6017 {
6018 if ((*it)->i_getStorageBus() == aConnectionType)
6019 {
6020 ULONG ulCurInst = (*it)->i_getInstance();
6021
6022 if (ulCurInst >= ulInstance)
6023 ulInstance = ulCurInst + 1;
6024
6025 /* Only one controller of each type can be marked as bootable. */
6026 if ((*it)->i_getBootable())
6027 fBootable = false;
6028 }
6029 }
6030
6031 rc = ctrl->init(this, aName, aConnectionType, ulInstance, fBootable);
6032 if (FAILED(rc)) return rc;
6033
6034 i_setModified(IsModified_Storage);
6035 mStorageControllers.backup();
6036 mStorageControllers->push_back(ctrl);
6037
6038 ctrl.queryInterfaceTo(aController.asOutParam());
6039
6040 /* inform the direct session if any */
6041 alock.release();
6042 i_onStorageControllerChange();
6043
6044 return S_OK;
6045}
6046
6047HRESULT Machine::getStorageControllerByName(const com::Utf8Str &aName,
6048 ComPtr<IStorageController> &aStorageController)
6049{
6050 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6051
6052 ComObjPtr<StorageController> ctrl;
6053
6054 HRESULT rc = i_getStorageControllerByName(aName, ctrl, true /* aSetError */);
6055 if (SUCCEEDED(rc))
6056 ctrl.queryInterfaceTo(aStorageController.asOutParam());
6057
6058 return rc;
6059}
6060
6061HRESULT Machine::getStorageControllerByInstance(StorageBus_T aConnectionType,
6062 ULONG aInstance,
6063 ComPtr<IStorageController> &aStorageController)
6064{
6065 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6066
6067 for (StorageControllerList::const_iterator it = mStorageControllers->begin();
6068 it != mStorageControllers->end();
6069 ++it)
6070 {
6071 if ( (*it)->i_getStorageBus() == aConnectionType
6072 && (*it)->i_getInstance() == aInstance)
6073 {
6074 (*it).queryInterfaceTo(aStorageController.asOutParam());
6075 return S_OK;
6076 }
6077 }
6078
6079 return setError(VBOX_E_OBJECT_NOT_FOUND,
6080 tr("Could not find a storage controller with instance number '%lu'"),
6081 aInstance);
6082}
6083
6084HRESULT Machine::setStorageControllerBootable(const com::Utf8Str &aName, BOOL aBootable)
6085{
6086 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6087
6088 HRESULT rc = i_checkStateDependency(MutableStateDep);
6089 if (FAILED(rc)) return rc;
6090
6091 ComObjPtr<StorageController> ctrl;
6092
6093 rc = i_getStorageControllerByName(aName, ctrl, true /* aSetError */);
6094 if (SUCCEEDED(rc))
6095 {
6096 /* Ensure that only one controller of each type is marked as bootable. */
6097 if (aBootable == TRUE)
6098 {
6099 for (StorageControllerList::const_iterator it = mStorageControllers->begin();
6100 it != mStorageControllers->end();
6101 ++it)
6102 {
6103 ComObjPtr<StorageController> aCtrl = (*it);
6104
6105 if ( (aCtrl->i_getName() != aName)
6106 && aCtrl->i_getBootable() == TRUE
6107 && aCtrl->i_getStorageBus() == ctrl->i_getStorageBus()
6108 && aCtrl->i_getControllerType() == ctrl->i_getControllerType())
6109 {
6110 aCtrl->i_setBootable(FALSE);
6111 break;
6112 }
6113 }
6114 }
6115
6116 if (SUCCEEDED(rc))
6117 {
6118 ctrl->i_setBootable(aBootable);
6119 i_setModified(IsModified_Storage);
6120 }
6121 }
6122
6123 if (SUCCEEDED(rc))
6124 {
6125 /* inform the direct session if any */
6126 alock.release();
6127 i_onStorageControllerChange();
6128 }
6129
6130 return rc;
6131}
6132
6133HRESULT Machine::removeStorageController(const com::Utf8Str &aName)
6134{
6135 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6136
6137 HRESULT rc = i_checkStateDependency(MutableStateDep);
6138 if (FAILED(rc)) return rc;
6139
6140 ComObjPtr<StorageController> ctrl;
6141 rc = i_getStorageControllerByName(aName, ctrl, true /* aSetError */);
6142 if (FAILED(rc)) return rc;
6143
6144 {
6145 /* find all attached devices to the appropriate storage controller and detach them all */
6146 // make a temporary list because detachDevice invalidates iterators into
6147 // mMediaData->mAttachments
6148 MediaData::AttachmentList llAttachments2 = mMediaData->mAttachments;
6149
6150 for (MediaData::AttachmentList::iterator it = llAttachments2.begin();
6151 it != llAttachments2.end();
6152 ++it)
6153 {
6154 MediumAttachment *pAttachTemp = *it;
6155
6156 AutoCaller localAutoCaller(pAttachTemp);
6157 if (FAILED(localAutoCaller.rc())) return localAutoCaller.rc();
6158
6159 AutoReadLock local_alock(pAttachTemp COMMA_LOCKVAL_SRC_POS);
6160
6161 if (pAttachTemp->i_getControllerName() == aName)
6162 {
6163 rc = i_detachDevice(pAttachTemp, alock, NULL);
6164 if (FAILED(rc)) return rc;
6165 }
6166 }
6167 }
6168
6169 /* We can remove it now. */
6170 i_setModified(IsModified_Storage);
6171 mStorageControllers.backup();
6172
6173 ctrl->i_unshare();
6174
6175 mStorageControllers->remove(ctrl);
6176
6177 /* inform the direct session if any */
6178 alock.release();
6179 i_onStorageControllerChange();
6180
6181 return S_OK;
6182}
6183
6184HRESULT Machine::addUSBController(const com::Utf8Str &aName, USBControllerType_T aType,
6185 ComPtr<IUSBController> &aController)
6186{
6187 if ( (aType <= USBControllerType_Null)
6188 || (aType >= USBControllerType_Last))
6189 return setError(E_INVALIDARG,
6190 tr("Invalid USB controller type: %d"),
6191 aType);
6192
6193 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6194
6195 HRESULT rc = i_checkStateDependency(MutableStateDep);
6196 if (FAILED(rc)) return rc;
6197
6198 /* try to find one with the same type first. */
6199 ComObjPtr<USBController> ctrl;
6200
6201 rc = i_getUSBControllerByName(aName, ctrl, false /* aSetError */);
6202 if (SUCCEEDED(rc))
6203 return setError(VBOX_E_OBJECT_IN_USE,
6204 tr("USB controller named '%s' already exists"),
6205 aName.c_str());
6206
6207 /* Check that we don't exceed the maximum number of USB controllers for the given type. */
6208 ULONG maxInstances;
6209 rc = mParent->i_getSystemProperties()->GetMaxInstancesOfUSBControllerType(mHWData->mChipsetType, aType, &maxInstances);
6210 if (FAILED(rc))
6211 return rc;
6212
6213 ULONG cInstances = i_getUSBControllerCountByType(aType);
6214 if (cInstances >= maxInstances)
6215 return setError(E_INVALIDARG,
6216 tr("Too many USB controllers of this type"));
6217
6218 ctrl.createObject();
6219
6220 rc = ctrl->init(this, aName, aType);
6221 if (FAILED(rc)) return rc;
6222
6223 i_setModified(IsModified_USB);
6224 mUSBControllers.backup();
6225 mUSBControllers->push_back(ctrl);
6226
6227 ctrl.queryInterfaceTo(aController.asOutParam());
6228
6229 /* inform the direct session if any */
6230 alock.release();
6231 i_onUSBControllerChange();
6232
6233 return S_OK;
6234}
6235
6236HRESULT Machine::getUSBControllerByName(const com::Utf8Str &aName, ComPtr<IUSBController> &aController)
6237{
6238 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6239
6240 ComObjPtr<USBController> ctrl;
6241
6242 HRESULT rc = i_getUSBControllerByName(aName, ctrl, true /* aSetError */);
6243 if (SUCCEEDED(rc))
6244 ctrl.queryInterfaceTo(aController.asOutParam());
6245
6246 return rc;
6247}
6248
6249HRESULT Machine::getUSBControllerCountByType(USBControllerType_T aType,
6250 ULONG *aControllers)
6251{
6252 if ( (aType <= USBControllerType_Null)
6253 || (aType >= USBControllerType_Last))
6254 return setError(E_INVALIDARG,
6255 tr("Invalid USB controller type: %d"),
6256 aType);
6257
6258 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6259
6260 ComObjPtr<USBController> ctrl;
6261
6262 *aControllers = i_getUSBControllerCountByType(aType);
6263
6264 return S_OK;
6265}
6266
6267HRESULT Machine::removeUSBController(const com::Utf8Str &aName)
6268{
6269
6270 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6271
6272 HRESULT rc = i_checkStateDependency(MutableStateDep);
6273 if (FAILED(rc)) return rc;
6274
6275 ComObjPtr<USBController> ctrl;
6276 rc = i_getUSBControllerByName(aName, ctrl, true /* aSetError */);
6277 if (FAILED(rc)) return rc;
6278
6279 i_setModified(IsModified_USB);
6280 mUSBControllers.backup();
6281
6282 ctrl->i_unshare();
6283
6284 mUSBControllers->remove(ctrl);
6285
6286 /* inform the direct session if any */
6287 alock.release();
6288 i_onUSBControllerChange();
6289
6290 return S_OK;
6291}
6292
6293HRESULT Machine::querySavedGuestScreenInfo(ULONG aScreenId,
6294 ULONG *aOriginX,
6295 ULONG *aOriginY,
6296 ULONG *aWidth,
6297 ULONG *aHeight,
6298 BOOL *aEnabled)
6299{
6300 uint32_t u32OriginX= 0;
6301 uint32_t u32OriginY= 0;
6302 uint32_t u32Width = 0;
6303 uint32_t u32Height = 0;
6304 uint16_t u16Flags = 0;
6305
6306 int vrc = readSavedGuestScreenInfo(mSSData->strStateFilePath, aScreenId,
6307 &u32OriginX, &u32OriginY, &u32Width, &u32Height, &u16Flags);
6308 if (RT_FAILURE(vrc))
6309 {
6310#ifdef RT_OS_WINDOWS
6311 /* HACK: GUI sets *pfEnabled to 'true' and expects it to stay so if the API fails.
6312 * This works with XPCOM. But Windows COM sets all output parameters to zero.
6313 * So just assign fEnable to TRUE again.
6314 * The right fix would be to change GUI API wrappers to make sure that parameters
6315 * are changed only if API succeeds.
6316 */
6317 *aEnabled = TRUE;
6318#endif
6319 return setError(VBOX_E_IPRT_ERROR,
6320 tr("Saved guest size is not available (%Rrc)"),
6321 vrc);
6322 }
6323
6324 *aOriginX = u32OriginX;
6325 *aOriginY = u32OriginY;
6326 *aWidth = u32Width;
6327 *aHeight = u32Height;
6328 *aEnabled = (u16Flags & VBVA_SCREEN_F_DISABLED) == 0;
6329
6330 return S_OK;
6331}
6332
6333HRESULT Machine::readSavedThumbnailToArray(ULONG aScreenId, BitmapFormat_T aBitmapFormat,
6334 ULONG *aWidth, ULONG *aHeight, std::vector<BYTE> &aData)
6335{
6336 if (aScreenId != 0)
6337 return E_NOTIMPL;
6338
6339 if ( aBitmapFormat != BitmapFormat_BGR0
6340 && aBitmapFormat != BitmapFormat_BGRA
6341 && aBitmapFormat != BitmapFormat_RGBA
6342 && aBitmapFormat != BitmapFormat_PNG)
6343 return setError(E_NOTIMPL,
6344 tr("Unsupported saved thumbnail format 0x%08X"), aBitmapFormat);
6345
6346 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6347
6348 uint8_t *pu8Data = NULL;
6349 uint32_t cbData = 0;
6350 uint32_t u32Width = 0;
6351 uint32_t u32Height = 0;
6352
6353 int vrc = readSavedDisplayScreenshot(mSSData->strStateFilePath, 0 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
6354
6355 if (RT_FAILURE(vrc))
6356 return setError(VBOX_E_IPRT_ERROR,
6357 tr("Saved thumbnail data is not available (%Rrc)"),
6358 vrc);
6359
6360 HRESULT hr = S_OK;
6361
6362 *aWidth = u32Width;
6363 *aHeight = u32Height;
6364
6365 if (cbData > 0)
6366 {
6367 /* Convert pixels to the format expected by the API caller. */
6368 if (aBitmapFormat == BitmapFormat_BGR0)
6369 {
6370 /* [0] B, [1] G, [2] R, [3] 0. */
6371 aData.resize(cbData);
6372 memcpy(&aData.front(), pu8Data, cbData);
6373 }
6374 else if (aBitmapFormat == BitmapFormat_BGRA)
6375 {
6376 /* [0] B, [1] G, [2] R, [3] A. */
6377 aData.resize(cbData);
6378 for (uint32_t i = 0; i < cbData; i += 4)
6379 {
6380 aData[i] = pu8Data[i];
6381 aData[i + 1] = pu8Data[i + 1];
6382 aData[i + 2] = pu8Data[i + 2];
6383 aData[i + 3] = 0xff;
6384 }
6385 }
6386 else if (aBitmapFormat == BitmapFormat_RGBA)
6387 {
6388 /* [0] R, [1] G, [2] B, [3] A. */
6389 aData.resize(cbData);
6390 for (uint32_t i = 0; i < cbData; i += 4)
6391 {
6392 aData[i] = pu8Data[i + 2];
6393 aData[i + 1] = pu8Data[i + 1];
6394 aData[i + 2] = pu8Data[i];
6395 aData[i + 3] = 0xff;
6396 }
6397 }
6398 else if (aBitmapFormat == BitmapFormat_PNG)
6399 {
6400 uint8_t *pu8PNG = NULL;
6401 uint32_t cbPNG = 0;
6402 uint32_t cxPNG = 0;
6403 uint32_t cyPNG = 0;
6404
6405 vrc = DisplayMakePNG(pu8Data, u32Width, u32Height, &pu8PNG, &cbPNG, &cxPNG, &cyPNG, 0);
6406
6407 if (RT_SUCCESS(vrc))
6408 {
6409 aData.resize(cbPNG);
6410 if (cbPNG)
6411 memcpy(&aData.front(), pu8PNG, cbPNG);
6412 }
6413 else
6414 hr = setError(VBOX_E_IPRT_ERROR,
6415 tr("Could not convert saved thumbnail to PNG (%Rrc)"),
6416 vrc);
6417
6418 RTMemFree(pu8PNG);
6419 }
6420 }
6421
6422 freeSavedDisplayScreenshot(pu8Data);
6423
6424 return hr;
6425}
6426
6427HRESULT Machine::querySavedScreenshotInfo(ULONG aScreenId,
6428 ULONG *aWidth,
6429 ULONG *aHeight,
6430 std::vector<BitmapFormat_T> &aBitmapFormats)
6431{
6432 if (aScreenId != 0)
6433 return E_NOTIMPL;
6434
6435 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6436
6437 uint8_t *pu8Data = NULL;
6438 uint32_t cbData = 0;
6439 uint32_t u32Width = 0;
6440 uint32_t u32Height = 0;
6441
6442 int vrc = readSavedDisplayScreenshot(mSSData->strStateFilePath, 1 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
6443
6444 if (RT_FAILURE(vrc))
6445 return setError(VBOX_E_IPRT_ERROR,
6446 tr("Saved screenshot data is not available (%Rrc)"),
6447 vrc);
6448
6449 *aWidth = u32Width;
6450 *aHeight = u32Height;
6451 aBitmapFormats.resize(1);
6452 aBitmapFormats[0] = BitmapFormat_PNG;
6453
6454 freeSavedDisplayScreenshot(pu8Data);
6455
6456 return S_OK;
6457}
6458
6459HRESULT Machine::readSavedScreenshotToArray(ULONG aScreenId,
6460 BitmapFormat_T aBitmapFormat,
6461 ULONG *aWidth,
6462 ULONG *aHeight,
6463 std::vector<BYTE> &aData)
6464{
6465 if (aScreenId != 0)
6466 return E_NOTIMPL;
6467
6468 if (aBitmapFormat != BitmapFormat_PNG)
6469 return E_NOTIMPL;
6470
6471 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6472
6473 uint8_t *pu8Data = NULL;
6474 uint32_t cbData = 0;
6475 uint32_t u32Width = 0;
6476 uint32_t u32Height = 0;
6477
6478 int vrc = readSavedDisplayScreenshot(mSSData->strStateFilePath, 1 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
6479
6480 if (RT_FAILURE(vrc))
6481 return setError(VBOX_E_IPRT_ERROR,
6482 tr("Saved screenshot thumbnail data is not available (%Rrc)"),
6483 vrc);
6484
6485 *aWidth = u32Width;
6486 *aHeight = u32Height;
6487
6488 aData.resize(cbData);
6489 if (cbData)
6490 memcpy(&aData.front(), pu8Data, cbData);
6491
6492 freeSavedDisplayScreenshot(pu8Data);
6493
6494 return S_OK;
6495}
6496
6497HRESULT Machine::hotPlugCPU(ULONG aCpu)
6498{
6499 HRESULT rc = S_OK;
6500 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6501
6502 if (!mHWData->mCPUHotPlugEnabled)
6503 return setError(E_INVALIDARG, tr("CPU hotplug is not enabled"));
6504
6505 if (aCpu >= mHWData->mCPUCount)
6506 return setError(E_INVALIDARG, tr("CPU id exceeds number of possible CPUs [0:%lu]"), mHWData->mCPUCount-1);
6507
6508 if (mHWData->mCPUAttached[aCpu])
6509 return setError(VBOX_E_OBJECT_IN_USE, tr("CPU %lu is already attached"), aCpu);
6510
6511 alock.release();
6512 rc = i_onCPUChange(aCpu, false);
6513 alock.acquire();
6514 if (FAILED(rc)) return rc;
6515
6516 i_setModified(IsModified_MachineData);
6517 mHWData.backup();
6518 mHWData->mCPUAttached[aCpu] = true;
6519
6520 /** Save settings if online - @todo why is this required? -- @bugref{6818} */
6521 if (Global::IsOnline(mData->mMachineState))
6522 i_saveSettings(NULL);
6523
6524 return S_OK;
6525}
6526
6527HRESULT Machine::hotUnplugCPU(ULONG aCpu)
6528{
6529 HRESULT rc = S_OK;
6530
6531 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6532
6533 if (!mHWData->mCPUHotPlugEnabled)
6534 return setError(E_INVALIDARG, tr("CPU hotplug is not enabled"));
6535
6536 if (aCpu >= SchemaDefs::MaxCPUCount)
6537 return setError(E_INVALIDARG,
6538 tr("CPU index exceeds maximum CPU count (must be in range [0:%lu])"),
6539 SchemaDefs::MaxCPUCount);
6540
6541 if (!mHWData->mCPUAttached[aCpu])
6542 return setError(VBOX_E_OBJECT_NOT_FOUND, tr("CPU %lu is not attached"), aCpu);
6543
6544 /* CPU 0 can't be detached */
6545 if (aCpu == 0)
6546 return setError(E_INVALIDARG, tr("It is not possible to detach CPU 0"));
6547
6548 alock.release();
6549 rc = i_onCPUChange(aCpu, true);
6550 alock.acquire();
6551 if (FAILED(rc)) return rc;
6552
6553 i_setModified(IsModified_MachineData);
6554 mHWData.backup();
6555 mHWData->mCPUAttached[aCpu] = false;
6556
6557 /** Save settings if online - @todo why is this required? -- @bugref{6818} */
6558 if (Global::IsOnline(mData->mMachineState))
6559 i_saveSettings(NULL);
6560
6561 return S_OK;
6562}
6563
6564HRESULT Machine::getCPUStatus(ULONG aCpu, BOOL *aAttached)
6565{
6566 *aAttached = false;
6567
6568 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6569
6570 /* If hotplug is enabled the CPU is always enabled. */
6571 if (!mHWData->mCPUHotPlugEnabled)
6572 {
6573 if (aCpu < mHWData->mCPUCount)
6574 *aAttached = true;
6575 }
6576 else
6577 {
6578 if (aCpu < SchemaDefs::MaxCPUCount)
6579 *aAttached = mHWData->mCPUAttached[aCpu];
6580 }
6581
6582 return S_OK;
6583}
6584
6585HRESULT Machine::queryLogFilename(ULONG aIdx, com::Utf8Str &aFilename)
6586{
6587 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6588
6589 Utf8Str log = i_queryLogFilename(aIdx);
6590 if (!RTFileExists(log.c_str()))
6591 log.setNull();
6592 aFilename = log;
6593
6594 return S_OK;
6595}
6596
6597HRESULT Machine::readLog(ULONG aIdx, LONG64 aOffset, LONG64 aSize, std::vector<BYTE> &aData)
6598{
6599 if (aSize < 0)
6600 return setError(E_INVALIDARG, tr("The size argument (%lld) is negative"), aSize);
6601
6602 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6603
6604 HRESULT rc = S_OK;
6605 Utf8Str log = i_queryLogFilename(aIdx);
6606
6607 /* do not unnecessarily hold the lock while doing something which does
6608 * not need the lock and potentially takes a long time. */
6609 alock.release();
6610
6611 /* Limit the chunk size to 32K for now, as that gives better performance
6612 * over (XP)COM, and keeps the SOAP reply size under 1M for the webservice.
6613 * One byte expands to approx. 25 bytes of breathtaking XML. */
6614 size_t cbData = (size_t)RT_MIN(aSize, 32768);
6615 aData.resize(cbData);
6616
6617 RTFILE LogFile;
6618 int vrc = RTFileOpen(&LogFile, log.c_str(),
6619 RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE);
6620 if (RT_SUCCESS(vrc))
6621 {
6622 vrc = RTFileReadAt(LogFile, aOffset, cbData? &aData.front(): NULL, cbData, &cbData);
6623 if (RT_SUCCESS(vrc))
6624 aData.resize(cbData);
6625 else
6626 rc = setError(VBOX_E_IPRT_ERROR,
6627 tr("Could not read log file '%s' (%Rrc)"),
6628 log.c_str(), vrc);
6629 RTFileClose(LogFile);
6630 }
6631 else
6632 rc = setError(VBOX_E_IPRT_ERROR,
6633 tr("Could not open log file '%s' (%Rrc)"),
6634 log.c_str(), vrc);
6635
6636 if (FAILED(rc))
6637 aData.resize(0);
6638
6639 return rc;
6640}
6641
6642
6643/**
6644 * Currently this method doesn't attach device to the running VM,
6645 * just makes sure it's plugged on next VM start.
6646 */
6647HRESULT Machine::attachHostPCIDevice(LONG aHostAddress, LONG aDesiredGuestAddress, BOOL /* aTryToUnbind */)
6648{
6649 // lock scope
6650 {
6651 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6652
6653 HRESULT rc = i_checkStateDependency(MutableStateDep);
6654 if (FAILED(rc)) return rc;
6655
6656 ChipsetType_T aChipset = ChipsetType_PIIX3;
6657 COMGETTER(ChipsetType)(&aChipset);
6658
6659 if (aChipset != ChipsetType_ICH9)
6660 {
6661 return setError(E_INVALIDARG,
6662 tr("Host PCI attachment only supported with ICH9 chipset"));
6663 }
6664
6665 // check if device with this host PCI address already attached
6666 for (HWData::PCIDeviceAssignmentList::iterator it = mHWData->mPCIDeviceAssignments.begin();
6667 it != mHWData->mPCIDeviceAssignments.end();
6668 ++it)
6669 {
6670 LONG iHostAddress = -1;
6671 ComPtr<PCIDeviceAttachment> pAttach;
6672 pAttach = *it;
6673 pAttach->COMGETTER(HostAddress)(&iHostAddress);
6674 if (iHostAddress == aHostAddress)
6675 return setError(E_INVALIDARG,
6676 tr("Device with host PCI address already attached to this VM"));
6677 }
6678
6679 ComObjPtr<PCIDeviceAttachment> pda;
6680 char name[32];
6681
6682 RTStrPrintf(name, sizeof(name), "host%02x:%02x.%x", (aHostAddress>>8) & 0xff,
6683 (aHostAddress & 0xf8) >> 3, aHostAddress & 7);
6684 Bstr bname(name);
6685 pda.createObject();
6686 pda->init(this, bname, aHostAddress, aDesiredGuestAddress, TRUE);
6687 i_setModified(IsModified_MachineData);
6688 mHWData.backup();
6689 mHWData->mPCIDeviceAssignments.push_back(pda);
6690 }
6691
6692 return S_OK;
6693}
6694
6695/**
6696 * Currently this method doesn't detach device from the running VM,
6697 * just makes sure it's not plugged on next VM start.
6698 */
6699HRESULT Machine::detachHostPCIDevice(LONG aHostAddress)
6700{
6701 ComObjPtr<PCIDeviceAttachment> pAttach;
6702 bool fRemoved = false;
6703 HRESULT rc;
6704
6705 // lock scope
6706 {
6707 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6708
6709 rc = i_checkStateDependency(MutableStateDep);
6710 if (FAILED(rc)) return rc;
6711
6712 for (HWData::PCIDeviceAssignmentList::iterator it = mHWData->mPCIDeviceAssignments.begin();
6713 it != mHWData->mPCIDeviceAssignments.end();
6714 ++it)
6715 {
6716 LONG iHostAddress = -1;
6717 pAttach = *it;
6718 pAttach->COMGETTER(HostAddress)(&iHostAddress);
6719 if (iHostAddress != -1 && iHostAddress == aHostAddress)
6720 {
6721 i_setModified(IsModified_MachineData);
6722 mHWData.backup();
6723 mHWData->mPCIDeviceAssignments.remove(pAttach);
6724 fRemoved = true;
6725 break;
6726 }
6727 }
6728 }
6729
6730
6731 /* Fire event outside of the lock */
6732 if (fRemoved)
6733 {
6734 Assert(!pAttach.isNull());
6735 ComPtr<IEventSource> es;
6736 rc = mParent->COMGETTER(EventSource)(es.asOutParam());
6737 Assert(SUCCEEDED(rc));
6738 Bstr mid;
6739 rc = this->COMGETTER(Id)(mid.asOutParam());
6740 Assert(SUCCEEDED(rc));
6741 fireHostPCIDevicePlugEvent(es, mid.raw(), false /* unplugged */, true /* success */, pAttach, NULL);
6742 }
6743
6744 return fRemoved ? S_OK : setError(VBOX_E_OBJECT_NOT_FOUND,
6745 tr("No host PCI device %08x attached"),
6746 aHostAddress
6747 );
6748}
6749
6750HRESULT Machine::getPCIDeviceAssignments(std::vector<ComPtr<IPCIDeviceAttachment> > &aPCIDeviceAssignments)
6751{
6752 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6753
6754 aPCIDeviceAssignments.resize(mHWData->mPCIDeviceAssignments.size());
6755
6756 size_t i = 0;
6757 for (std::list<ComObjPtr<PCIDeviceAttachment> >::const_iterator it = mHWData->mPCIDeviceAssignments.begin();
6758 it != mHWData->mPCIDeviceAssignments.end();
6759 ++i, ++it)
6760 (*it).queryInterfaceTo(aPCIDeviceAssignments[i].asOutParam());
6761
6762 return S_OK;
6763}
6764
6765HRESULT Machine::getBandwidthControl(ComPtr<IBandwidthControl> &aBandwidthControl)
6766{
6767 mBandwidthControl.queryInterfaceTo(aBandwidthControl.asOutParam());
6768
6769 return S_OK;
6770}
6771
6772HRESULT Machine::getTracingEnabled(BOOL *aTracingEnabled)
6773{
6774 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6775
6776 *aTracingEnabled = mHWData->mDebugging.fTracingEnabled;
6777
6778 return S_OK;
6779}
6780
6781HRESULT Machine::setTracingEnabled(BOOL aTracingEnabled)
6782{
6783 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6784 HRESULT hrc = i_checkStateDependency(MutableStateDep);
6785 if (SUCCEEDED(hrc))
6786 {
6787 hrc = mHWData.backupEx();
6788 if (SUCCEEDED(hrc))
6789 {
6790 i_setModified(IsModified_MachineData);
6791 mHWData->mDebugging.fTracingEnabled = aTracingEnabled != FALSE;
6792 }
6793 }
6794 return hrc;
6795}
6796
6797HRESULT Machine::getTracingConfig(com::Utf8Str &aTracingConfig)
6798{
6799 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6800 aTracingConfig = mHWData->mDebugging.strTracingConfig;
6801 return S_OK;
6802}
6803
6804HRESULT Machine::setTracingConfig(const com::Utf8Str &aTracingConfig)
6805{
6806 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6807 HRESULT hrc = i_checkStateDependency(MutableStateDep);
6808 if (SUCCEEDED(hrc))
6809 {
6810 hrc = mHWData.backupEx();
6811 if (SUCCEEDED(hrc))
6812 {
6813 mHWData->mDebugging.strTracingConfig = aTracingConfig;
6814 if (SUCCEEDED(hrc))
6815 i_setModified(IsModified_MachineData);
6816 }
6817 }
6818 return hrc;
6819}
6820
6821HRESULT Machine::getAllowTracingToAccessVM(BOOL *aAllowTracingToAccessVM)
6822{
6823 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6824
6825 *aAllowTracingToAccessVM = mHWData->mDebugging.fAllowTracingToAccessVM;
6826
6827 return S_OK;
6828}
6829
6830HRESULT Machine::setAllowTracingToAccessVM(BOOL aAllowTracingToAccessVM)
6831{
6832 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6833 HRESULT hrc = i_checkStateDependency(MutableStateDep);
6834 if (SUCCEEDED(hrc))
6835 {
6836 hrc = mHWData.backupEx();
6837 if (SUCCEEDED(hrc))
6838 {
6839 i_setModified(IsModified_MachineData);
6840 mHWData->mDebugging.fAllowTracingToAccessVM = aAllowTracingToAccessVM != FALSE;
6841 }
6842 }
6843 return hrc;
6844}
6845
6846HRESULT Machine::getAutostartEnabled(BOOL *aAutostartEnabled)
6847{
6848 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6849
6850 *aAutostartEnabled = mHWData->mAutostart.fAutostartEnabled;
6851
6852 return S_OK;
6853}
6854
6855HRESULT Machine::setAutostartEnabled(BOOL aAutostartEnabled)
6856{
6857 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6858
6859 HRESULT hrc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
6860 if ( SUCCEEDED(hrc)
6861 && mHWData->mAutostart.fAutostartEnabled != !!aAutostartEnabled)
6862 {
6863 AutostartDb *autostartDb = mParent->i_getAutostartDb();
6864 int vrc;
6865
6866 if (aAutostartEnabled)
6867 vrc = autostartDb->addAutostartVM(mUserData->s.strName.c_str());
6868 else
6869 vrc = autostartDb->removeAutostartVM(mUserData->s.strName.c_str());
6870
6871 if (RT_SUCCESS(vrc))
6872 {
6873 hrc = mHWData.backupEx();
6874 if (SUCCEEDED(hrc))
6875 {
6876 i_setModified(IsModified_MachineData);
6877 mHWData->mAutostart.fAutostartEnabled = aAutostartEnabled != FALSE;
6878 }
6879 }
6880 else if (vrc == VERR_NOT_SUPPORTED)
6881 hrc = setError(VBOX_E_NOT_SUPPORTED,
6882 tr("The VM autostart feature is not supported on this platform"));
6883 else if (vrc == VERR_PATH_NOT_FOUND)
6884 hrc = setError(E_FAIL,
6885 tr("The path to the autostart database is not set"));
6886 else
6887 hrc = setError(E_UNEXPECTED,
6888 tr("%s machine '%s' to the autostart database failed with %Rrc"),
6889 aAutostartEnabled ? "Adding" : "Removing",
6890 mUserData->s.strName.c_str(), vrc);
6891 }
6892 return hrc;
6893}
6894
6895HRESULT Machine::getAutostartDelay(ULONG *aAutostartDelay)
6896{
6897 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6898
6899 *aAutostartDelay = mHWData->mAutostart.uAutostartDelay;
6900
6901 return S_OK;
6902}
6903
6904HRESULT Machine::setAutostartDelay(ULONG aAutostartDelay)
6905{
6906 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6907 HRESULT hrc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
6908 if (SUCCEEDED(hrc))
6909 {
6910 hrc = mHWData.backupEx();
6911 if (SUCCEEDED(hrc))
6912 {
6913 i_setModified(IsModified_MachineData);
6914 mHWData->mAutostart.uAutostartDelay = aAutostartDelay;
6915 }
6916 }
6917 return hrc;
6918}
6919
6920HRESULT Machine::getAutostopType(AutostopType_T *aAutostopType)
6921{
6922 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6923
6924 *aAutostopType = mHWData->mAutostart.enmAutostopType;
6925
6926 return S_OK;
6927}
6928
6929HRESULT Machine::setAutostopType(AutostopType_T aAutostopType)
6930{
6931 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6932 HRESULT hrc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
6933 if ( SUCCEEDED(hrc)
6934 && mHWData->mAutostart.enmAutostopType != aAutostopType)
6935 {
6936 AutostartDb *autostartDb = mParent->i_getAutostartDb();
6937 int vrc;
6938
6939 if (aAutostopType != AutostopType_Disabled)
6940 vrc = autostartDb->addAutostopVM(mUserData->s.strName.c_str());
6941 else
6942 vrc = autostartDb->removeAutostopVM(mUserData->s.strName.c_str());
6943
6944 if (RT_SUCCESS(vrc))
6945 {
6946 hrc = mHWData.backupEx();
6947 if (SUCCEEDED(hrc))
6948 {
6949 i_setModified(IsModified_MachineData);
6950 mHWData->mAutostart.enmAutostopType = aAutostopType;
6951 }
6952 }
6953 else if (vrc == VERR_NOT_SUPPORTED)
6954 hrc = setError(VBOX_E_NOT_SUPPORTED,
6955 tr("The VM autostop feature is not supported on this platform"));
6956 else if (vrc == VERR_PATH_NOT_FOUND)
6957 hrc = setError(E_FAIL,
6958 tr("The path to the autostart database is not set"));
6959 else
6960 hrc = setError(E_UNEXPECTED,
6961 tr("%s machine '%s' to the autostop database failed with %Rrc"),
6962 aAutostopType != AutostopType_Disabled ? "Adding" : "Removing",
6963 mUserData->s.strName.c_str(), vrc);
6964 }
6965 return hrc;
6966}
6967
6968HRESULT Machine::getDefaultFrontend(com::Utf8Str &aDefaultFrontend)
6969{
6970 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6971
6972 aDefaultFrontend = mHWData->mDefaultFrontend;
6973
6974 return S_OK;
6975}
6976
6977HRESULT Machine::setDefaultFrontend(const com::Utf8Str &aDefaultFrontend)
6978{
6979 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
6980 HRESULT hrc = i_checkStateDependency(MutableOrSavedStateDep);
6981 if (SUCCEEDED(hrc))
6982 {
6983 hrc = mHWData.backupEx();
6984 if (SUCCEEDED(hrc))
6985 {
6986 i_setModified(IsModified_MachineData);
6987 mHWData->mDefaultFrontend = aDefaultFrontend;
6988 }
6989 }
6990 return hrc;
6991}
6992
6993HRESULT Machine::getIcon(std::vector<BYTE> &aIcon)
6994{
6995 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
6996 size_t cbIcon = mUserData->mIcon.size();
6997 aIcon.resize(cbIcon);
6998 if (cbIcon)
6999 memcpy(&aIcon.front(), &mUserData->mIcon[0], cbIcon);
7000 return S_OK;
7001}
7002
7003HRESULT Machine::setIcon(const std::vector<BYTE> &aIcon)
7004{
7005 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7006 HRESULT hrc = i_checkStateDependency(MutableOrSavedStateDep);
7007 if (SUCCEEDED(hrc))
7008 {
7009 i_setModified(IsModified_MachineData);
7010 mUserData.backup();
7011 size_t cbIcon = aIcon.size();
7012 mUserData->mIcon.resize(cbIcon);
7013 if (cbIcon)
7014 memcpy(&mUserData->mIcon[0], &aIcon.front(), cbIcon);
7015 }
7016 return hrc;
7017}
7018
7019HRESULT Machine::getUSBProxyAvailable(BOOL *aUSBProxyAvailable)
7020{
7021#ifdef VBOX_WITH_USB
7022 *aUSBProxyAvailable = true;
7023#else
7024 *aUSBProxyAvailable = false;
7025#endif
7026 return S_OK;
7027}
7028
7029HRESULT Machine::getVMProcessPriority(com::Utf8Str &aVMProcessPriority)
7030{
7031 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7032
7033 aVMProcessPriority = mUserData->s.strVMPriority;
7034
7035 return S_OK;
7036}
7037
7038HRESULT Machine::setVMProcessPriority(const com::Utf8Str &aVMProcessPriority)
7039{
7040 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7041 HRESULT hrc = i_checkStateDependency(MutableOrSavedOrRunningStateDep);
7042 if (SUCCEEDED(hrc))
7043 {
7044 /** @todo r=klaus: currently this is marked as not implemented, as
7045 * the code for setting the priority of the process is not there
7046 * (neither when starting the VM nor at runtime). */
7047 ReturnComNotImplemented();
7048 hrc = mUserData.backupEx();
7049 if (SUCCEEDED(hrc))
7050 {
7051 i_setModified(IsModified_MachineData);
7052 mUserData->s.strVMPriority = aVMProcessPriority;
7053 }
7054 }
7055 return hrc;
7056}
7057
7058HRESULT Machine::cloneTo(const ComPtr<IMachine> &aTarget, CloneMode_T aMode, const std::vector<CloneOptions_T> &aOptions,
7059 ComPtr<IProgress> &aProgress)
7060{
7061 ComObjPtr<Progress> pP;
7062 Progress *ppP = pP;
7063 IProgress *iP = static_cast<IProgress *>(ppP);
7064 IProgress **pProgress = &iP;
7065
7066 IMachine *pTarget = aTarget;
7067
7068 /* Convert the options. */
7069 RTCList<CloneOptions_T> optList;
7070 if (aOptions.size())
7071 for (size_t i = 0; i < aOptions.size(); ++i)
7072 optList.append(aOptions[i]);
7073
7074 if (optList.contains(CloneOptions_Link))
7075 {
7076 if (!i_isSnapshotMachine())
7077 return setError(E_INVALIDARG,
7078 tr("Linked clone can only be created from a snapshot"));
7079 if (aMode != CloneMode_MachineState)
7080 return setError(E_INVALIDARG,
7081 tr("Linked clone can only be created for a single machine state"));
7082 }
7083 AssertReturn(!(optList.contains(CloneOptions_KeepAllMACs) && optList.contains(CloneOptions_KeepNATMACs)), E_INVALIDARG);
7084
7085 MachineCloneVM *pWorker = new MachineCloneVM(this, static_cast<Machine*>(pTarget), aMode, optList);
7086
7087 HRESULT rc = pWorker->start(pProgress);
7088
7089 pP = static_cast<Progress *>(*pProgress);
7090 pP.queryInterfaceTo(aProgress.asOutParam());
7091
7092 return rc;
7093
7094}
7095
7096HRESULT Machine::saveState(ComPtr<IProgress> &aProgress)
7097{
7098 NOREF(aProgress);
7099 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7100
7101 // This check should always fail.
7102 HRESULT rc = i_checkStateDependency(MutableStateDep);
7103 if (FAILED(rc)) return rc;
7104
7105 AssertFailedReturn(E_NOTIMPL);
7106}
7107
7108HRESULT Machine::adoptSavedState(const com::Utf8Str &aSavedStateFile)
7109{
7110 NOREF(aSavedStateFile);
7111 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7112
7113 // This check should always fail.
7114 HRESULT rc = i_checkStateDependency(MutableStateDep);
7115 if (FAILED(rc)) return rc;
7116
7117 AssertFailedReturn(E_NOTIMPL);
7118}
7119
7120HRESULT Machine::discardSavedState(BOOL aFRemoveFile)
7121{
7122 NOREF(aFRemoveFile);
7123 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7124
7125 // This check should always fail.
7126 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
7127 if (FAILED(rc)) return rc;
7128
7129 AssertFailedReturn(E_NOTIMPL);
7130}
7131
7132// public methods for internal purposes
7133/////////////////////////////////////////////////////////////////////////////
7134
7135/**
7136 * Adds the given IsModified_* flag to the dirty flags of the machine.
7137 * This must be called either during i_loadSettings or under the machine write lock.
7138 * @param fl
7139 */
7140void Machine::i_setModified(uint32_t fl, bool fAllowStateModification /* = true */)
7141{
7142 mData->flModifications |= fl;
7143 if (fAllowStateModification && i_isStateModificationAllowed())
7144 mData->mCurrentStateModified = true;
7145}
7146
7147/**
7148 * Adds the given IsModified_* flag to the dirty flags of the machine, taking
7149 * care of the write locking.
7150 *
7151 * @param fModifications The flag to add.
7152 */
7153void Machine::i_setModifiedLock(uint32_t fModification, bool fAllowStateModification /* = true */)
7154{
7155 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7156 i_setModified(fModification, fAllowStateModification);
7157}
7158
7159/**
7160 * Saves the registry entry of this machine to the given configuration node.
7161 *
7162 * @param aEntryNode Node to save the registry entry to.
7163 *
7164 * @note locks this object for reading.
7165 */
7166HRESULT Machine::i_saveRegistryEntry(settings::MachineRegistryEntry &data)
7167{
7168 AutoLimitedCaller autoCaller(this);
7169 AssertComRCReturnRC(autoCaller.rc());
7170
7171 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7172
7173 data.uuid = mData->mUuid;
7174 data.strSettingsFile = mData->m_strConfigFile;
7175
7176 return S_OK;
7177}
7178
7179/**
7180 * Calculates the absolute path of the given path taking the directory of the
7181 * machine settings file as the current directory.
7182 *
7183 * @param aPath Path to calculate the absolute path for.
7184 * @param aResult Where to put the result (used only on success, can be the
7185 * same Utf8Str instance as passed in @a aPath).
7186 * @return IPRT result.
7187 *
7188 * @note Locks this object for reading.
7189 */
7190int Machine::i_calculateFullPath(const Utf8Str &strPath, Utf8Str &aResult)
7191{
7192 AutoCaller autoCaller(this);
7193 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
7194
7195 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7196
7197 AssertReturn(!mData->m_strConfigFileFull.isEmpty(), VERR_GENERAL_FAILURE);
7198
7199 Utf8Str strSettingsDir = mData->m_strConfigFileFull;
7200
7201 strSettingsDir.stripFilename();
7202 char folder[RTPATH_MAX];
7203 int vrc = RTPathAbsEx(strSettingsDir.c_str(), strPath.c_str(), folder, sizeof(folder));
7204 if (RT_SUCCESS(vrc))
7205 aResult = folder;
7206
7207 return vrc;
7208}
7209
7210/**
7211 * Copies strSource to strTarget, making it relative to the machine folder
7212 * if it is a subdirectory thereof, or simply copying it otherwise.
7213 *
7214 * @param strSource Path to evaluate and copy.
7215 * @param strTarget Buffer to receive target path.
7216 *
7217 * @note Locks this object for reading.
7218 */
7219void Machine::i_copyPathRelativeToMachine(const Utf8Str &strSource,
7220 Utf8Str &strTarget)
7221{
7222 AutoCaller autoCaller(this);
7223 AssertComRCReturn(autoCaller.rc(), (void)0);
7224
7225 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7226
7227 AssertReturnVoid(!mData->m_strConfigFileFull.isEmpty());
7228 // use strTarget as a temporary buffer to hold the machine settings dir
7229 strTarget = mData->m_strConfigFileFull;
7230 strTarget.stripFilename();
7231 if (RTPathStartsWith(strSource.c_str(), strTarget.c_str()))
7232 {
7233 // is relative: then append what's left
7234 strTarget = strSource.substr(strTarget.length() + 1); // skip '/'
7235 // for empty paths (only possible for subdirs) use "." to avoid
7236 // triggering default settings for not present config attributes.
7237 if (strTarget.isEmpty())
7238 strTarget = ".";
7239 }
7240 else
7241 // is not relative: then overwrite
7242 strTarget = strSource;
7243}
7244
7245/**
7246 * Returns the full path to the machine's log folder in the
7247 * \a aLogFolder argument.
7248 */
7249void Machine::i_getLogFolder(Utf8Str &aLogFolder)
7250{
7251 AutoCaller autoCaller(this);
7252 AssertComRCReturnVoid(autoCaller.rc());
7253
7254 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7255
7256 char szTmp[RTPATH_MAX];
7257 int vrc = RTEnvGetEx(RTENV_DEFAULT, "VBOX_USER_VMLOGDIR", szTmp, sizeof(szTmp), NULL);
7258 if (RT_SUCCESS(vrc))
7259 {
7260 if (szTmp[0] && !mUserData.isNull())
7261 {
7262 char szTmp2[RTPATH_MAX];
7263 vrc = RTPathAbs(szTmp, szTmp2, sizeof(szTmp2));
7264 if (RT_SUCCESS(vrc))
7265 aLogFolder = BstrFmt("%s%c%s",
7266 szTmp2,
7267 RTPATH_DELIMITER,
7268 mUserData->s.strName.c_str()); // path/to/logfolder/vmname
7269 }
7270 else
7271 vrc = VERR_PATH_IS_RELATIVE;
7272 }
7273
7274 if (RT_FAILURE(vrc))
7275 {
7276 // fallback if VBOX_USER_LOGHOME is not set or invalid
7277 aLogFolder = mData->m_strConfigFileFull; // path/to/machinesfolder/vmname/vmname.vbox
7278 aLogFolder.stripFilename(); // path/to/machinesfolder/vmname
7279 aLogFolder.append(RTPATH_DELIMITER);
7280 aLogFolder.append("Logs"); // path/to/machinesfolder/vmname/Logs
7281 }
7282}
7283
7284/**
7285 * Returns the full path to the machine's log file for an given index.
7286 */
7287Utf8Str Machine::i_queryLogFilename(ULONG idx) /** @todo r=bird: Misnamed. Should be i_getLogFilename as it cannot fail.
7288 See VBox-CodingGuidelines.cpp, Compulsory seciont, line 79. */
7289{
7290 Utf8Str logFolder;
7291 getLogFolder(logFolder);
7292 Assert(logFolder.length());
7293 Utf8Str log;
7294 if (idx == 0)
7295 log = Utf8StrFmt("%s%cVBox.log",
7296 logFolder.c_str(), RTPATH_DELIMITER);
7297 else
7298 log = Utf8StrFmt("%s%cVBox.log.%d",
7299 logFolder.c_str(), RTPATH_DELIMITER, idx);
7300 return log;
7301}
7302
7303/**
7304 * Returns the full path to the machine's (hardened) startup log file.
7305 */
7306Utf8Str Machine::i_getStartupLogFilename(void)
7307{
7308 Utf8Str strFilename;
7309 getLogFolder(strFilename);
7310 Assert(strFilename.length());
7311 strFilename.append(RTPATH_SLASH_STR "VBoxStartup.log");
7312 return strFilename;
7313}
7314
7315
7316/**
7317 * Composes a unique saved state filename based on the current system time. The filename is
7318 * granular to the second so this will work so long as no more than one snapshot is taken on
7319 * a machine per second.
7320 *
7321 * Before version 4.1, we used this formula for saved state files:
7322 * Utf8StrFmt("%s%c{%RTuuid}.sav", strFullSnapshotFolder.c_str(), RTPATH_DELIMITER, mData->mUuid.raw())
7323 * which no longer works because saved state files can now be shared between the saved state of the
7324 * "saved" machine and an online snapshot, and the following would cause problems:
7325 * 1) save machine
7326 * 2) create online snapshot from that machine state --> reusing saved state file
7327 * 3) save machine again --> filename would be reused, breaking the online snapshot
7328 *
7329 * So instead we now use a timestamp.
7330 *
7331 * @param str
7332 */
7333
7334void Machine::i_composeSavedStateFilename(Utf8Str &strStateFilePath)
7335{
7336 AutoCaller autoCaller(this);
7337 AssertComRCReturnVoid(autoCaller.rc());
7338
7339 {
7340 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7341 i_calculateFullPath(mUserData->s.strSnapshotFolder, strStateFilePath);
7342 }
7343
7344 RTTIMESPEC ts;
7345 RTTimeNow(&ts);
7346 RTTIME time;
7347 RTTimeExplode(&time, &ts);
7348
7349 strStateFilePath += RTPATH_DELIMITER;
7350 strStateFilePath += Utf8StrFmt("%04d-%02u-%02uT%02u-%02u-%02u-%09uZ.sav",
7351 time.i32Year, time.u8Month, time.u8MonthDay,
7352 time.u8Hour, time.u8Minute, time.u8Second, time.u32Nanosecond);
7353}
7354
7355/**
7356 * Returns the full path to the default video capture file.
7357 */
7358void Machine::i_getDefaultVideoCaptureFile(Utf8Str &strFile)
7359{
7360 AutoCaller autoCaller(this);
7361 AssertComRCReturnVoid(autoCaller.rc());
7362
7363 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7364
7365 strFile = mData->m_strConfigFileFull; // path/to/machinesfolder/vmname/vmname.vbox
7366 strFile.stripSuffix(); // path/to/machinesfolder/vmname/vmname
7367 strFile.append(".webm"); // path/to/machinesfolder/vmname/vmname.webm
7368}
7369
7370/**
7371 * Returns whether at least one USB controller is present for the VM.
7372 */
7373bool Machine::i_isUSBControllerPresent()
7374{
7375 AutoCaller autoCaller(this);
7376 AssertComRCReturn(autoCaller.rc(), false);
7377
7378 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7379
7380 return (mUSBControllers->size() > 0);
7381}
7382
7383/**
7384 * @note Locks this object for writing, calls the client process
7385 * (inside the lock).
7386 */
7387HRESULT Machine::i_launchVMProcess(IInternalSessionControl *aControl,
7388 const Utf8Str &strFrontend,
7389 const Utf8Str &strEnvironment,
7390 ProgressProxy *aProgress)
7391{
7392 LogFlowThisFuncEnter();
7393
7394 AssertReturn(aControl, E_FAIL);
7395 AssertReturn(aProgress, E_FAIL);
7396 AssertReturn(!strFrontend.isEmpty(), E_FAIL);
7397
7398 AutoCaller autoCaller(this);
7399 if (FAILED(autoCaller.rc())) return autoCaller.rc();
7400
7401 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7402
7403 if (!mData->mRegistered)
7404 return setError(E_UNEXPECTED,
7405 tr("The machine '%s' is not registered"),
7406 mUserData->s.strName.c_str());
7407
7408 LogFlowThisFunc(("mSession.mState=%s\n", Global::stringifySessionState(mData->mSession.mState)));
7409
7410 /* The process started when launching a VM with separate UI/VM processes is always
7411 * the UI process, i.e. needs special handling as it won't claim the session. */
7412 bool fSeparate = strFrontend.endsWith("separate", Utf8Str::CaseInsensitive);
7413
7414 if (fSeparate)
7415 {
7416 if (mData->mSession.mState != SessionState_Unlocked && mData->mSession.mName != "headless")
7417 return setError(VBOX_E_INVALID_OBJECT_STATE,
7418 tr("The machine '%s' is in a state which is incompatible with launching a separate UI process"),
7419 mUserData->s.strName.c_str());
7420 }
7421 else
7422 {
7423 if ( mData->mSession.mState == SessionState_Locked
7424 || mData->mSession.mState == SessionState_Spawning
7425 || mData->mSession.mState == SessionState_Unlocking)
7426 return setError(VBOX_E_INVALID_OBJECT_STATE,
7427 tr("The machine '%s' is already locked by a session (or being locked or unlocked)"),
7428 mUserData->s.strName.c_str());
7429
7430 /* may not be busy */
7431 AssertReturn(!Global::IsOnlineOrTransient(mData->mMachineState), E_FAIL);
7432 }
7433
7434 /* get the path to the executable */
7435 char szPath[RTPATH_MAX];
7436 RTPathAppPrivateArch(szPath, sizeof(szPath) - 1);
7437 size_t cchBufLeft = strlen(szPath);
7438 szPath[cchBufLeft++] = RTPATH_DELIMITER;
7439 szPath[cchBufLeft] = 0;
7440 char *pszNamePart = szPath + cchBufLeft;
7441 cchBufLeft = sizeof(szPath) - cchBufLeft;
7442
7443 int vrc = VINF_SUCCESS;
7444 RTPROCESS pid = NIL_RTPROCESS;
7445
7446 RTENV env = RTENV_DEFAULT;
7447
7448 if (!strEnvironment.isEmpty())
7449 {
7450 char *newEnvStr = NULL;
7451
7452 do
7453 {
7454 /* clone the current environment */
7455 int vrc2 = RTEnvClone(&env, RTENV_DEFAULT);
7456 AssertRCBreakStmt(vrc2, vrc = vrc2);
7457
7458 newEnvStr = RTStrDup(strEnvironment.c_str());
7459 AssertPtrBreakStmt(newEnvStr, vrc = vrc2);
7460
7461 /* put new variables to the environment
7462 * (ignore empty variable names here since RTEnv API
7463 * intentionally doesn't do that) */
7464 char *var = newEnvStr;
7465 for (char *p = newEnvStr; *p; ++p)
7466 {
7467 if (*p == '\n' && (p == newEnvStr || *(p - 1) != '\\'))
7468 {
7469 *p = '\0';
7470 if (*var)
7471 {
7472 char *val = strchr(var, '=');
7473 if (val)
7474 {
7475 *val++ = '\0';
7476 vrc2 = RTEnvSetEx(env, var, val);
7477 }
7478 else
7479 vrc2 = RTEnvUnsetEx(env, var);
7480 if (RT_FAILURE(vrc2))
7481 break;
7482 }
7483 var = p + 1;
7484 }
7485 }
7486 if (RT_SUCCESS(vrc2) && *var)
7487 vrc2 = RTEnvPutEx(env, var);
7488
7489 AssertRCBreakStmt(vrc2, vrc = vrc2);
7490 }
7491 while (0);
7492
7493 if (newEnvStr != NULL)
7494 RTStrFree(newEnvStr);
7495 }
7496
7497 /* Hardened startup logging */
7498#if defined(RT_OS_WINDOWS) && defined(VBOX_WITH_HARDENING)
7499 Utf8Str strSupStartLogArg("--sup-startup-log=");
7500 {
7501 Utf8Str strStartupLogFile = i_getStartupLogFilename();
7502 int vrc2 = RTFileDelete(strStartupLogFile.c_str());
7503 if (vrc2 == VERR_PATH_NOT_FOUND || vrc2 == VERR_FILE_NOT_FOUND)
7504 {
7505 Utf8Str strStartupLogDir = strStartupLogFile;
7506 strStartupLogDir.stripFilename();
7507 RTDirCreateFullPath(strStartupLogDir.c_str(), 0755); /** @todo add a variant for creating the path to a
7508 file without stripping the file. */
7509 }
7510 strSupStartLogArg.append(strStartupLogFile);
7511 }
7512 const char *pszSupStartupLogArg = strSupStartLogArg.c_str();
7513#else
7514 const char *pszSupStartupLogArg = NULL;
7515#endif
7516
7517 Utf8Str strCanonicalName;
7518
7519#ifdef VBOX_WITH_QTGUI
7520 if ( !strFrontend.compare("gui", Utf8Str::CaseInsensitive)
7521 || !strFrontend.compare("GUI/Qt", Utf8Str::CaseInsensitive)
7522 || !strFrontend.compare("separate", Utf8Str::CaseInsensitive)
7523 || !strFrontend.compare("gui/separate", Utf8Str::CaseInsensitive)
7524 || !strFrontend.compare("GUI/Qt/separate", Utf8Str::CaseInsensitive))
7525 {
7526 strCanonicalName = "GUI/Qt";
7527# ifdef RT_OS_DARWIN /* Avoid Launch Services confusing this with the selector by using a helper app. */
7528 /* Modify the base path so that we don't need to use ".." below. */
7529 RTPathStripTrailingSlash(szPath);
7530 RTPathStripFilename(szPath);
7531 cchBufLeft = strlen(szPath);
7532 pszNamePart = szPath + cchBufLeft;
7533 cchBufLeft = sizeof(szPath) - cchBufLeft;
7534
7535# define OSX_APP_NAME "VirtualBoxVM"
7536# define OSX_APP_PATH_FMT "/Resources/%s.app/Contents/MacOS/VirtualBoxVM"
7537
7538 Utf8Str strAppOverride = i_getExtraData(Utf8Str("VBoxInternal2/VirtualBoxVMAppOverride"));
7539 if ( strAppOverride.contains(".")
7540 || strAppOverride.contains("/")
7541 || strAppOverride.contains("\\")
7542 || strAppOverride.contains(":"))
7543 strAppOverride.setNull();
7544 Utf8Str strAppPath;
7545 if (!strAppOverride.isEmpty())
7546 {
7547 strAppPath = Utf8StrFmt(OSX_APP_PATH_FMT, strAppOverride.c_str());
7548 Utf8Str strFullPath(szPath);
7549 strFullPath.append(strAppPath);
7550 /* there is a race, but people using this deserve the failure */
7551 if (!RTFileExists(strFullPath.c_str()))
7552 strAppOverride.setNull();
7553 }
7554 if (strAppOverride.isEmpty())
7555 strAppPath = Utf8StrFmt(OSX_APP_PATH_FMT, OSX_APP_NAME);
7556 AssertReturn(cchBufLeft > strAppPath.length(), E_UNEXPECTED);
7557 strcpy(pszNamePart, strAppPath.c_str());
7558# else
7559 static const char s_szVirtualBox_exe[] = "VirtualBox" HOSTSUFF_EXE;
7560 Assert(cchBufLeft >= sizeof(s_szVirtualBox_exe));
7561 strcpy(pszNamePart, s_szVirtualBox_exe);
7562# endif
7563
7564 Utf8Str idStr = mData->mUuid.toString();
7565 const char *apszArgs[] =
7566 {
7567 szPath,
7568 "--comment", mUserData->s.strName.c_str(),
7569 "--startvm", idStr.c_str(),
7570 "--no-startvm-errormsgbox",
7571 NULL, /* For "--separate". */
7572 NULL, /* For "--sup-startup-log". */
7573 NULL
7574 };
7575 unsigned iArg = 6;
7576 if (fSeparate)
7577 apszArgs[iArg++] = "--separate";
7578 apszArgs[iArg++] = pszSupStartupLogArg;
7579
7580 vrc = RTProcCreate(szPath, apszArgs, env, 0, &pid);
7581 }
7582#else /* !VBOX_WITH_QTGUI */
7583 if (0)
7584 ;
7585#endif /* VBOX_WITH_QTGUI */
7586
7587 else
7588
7589#ifdef VBOX_WITH_VBOXSDL
7590 if ( !strFrontend.compare("sdl", Utf8Str::CaseInsensitive)
7591 || !strFrontend.compare("GUI/SDL", Utf8Str::CaseInsensitive)
7592 || !strFrontend.compare("sdl/separate", Utf8Str::CaseInsensitive)
7593 || !strFrontend.compare("GUI/SDL/separate", Utf8Str::CaseInsensitive))
7594 {
7595 strCanonicalName = "GUI/SDL";
7596 static const char s_szVBoxSDL_exe[] = "VBoxSDL" HOSTSUFF_EXE;
7597 Assert(cchBufLeft >= sizeof(s_szVBoxSDL_exe));
7598 strcpy(pszNamePart, s_szVBoxSDL_exe);
7599
7600 Utf8Str idStr = mData->mUuid.toString();
7601 const char *apszArgs[] =
7602 {
7603 szPath,
7604 "--comment", mUserData->s.strName.c_str(),
7605 "--startvm", idStr.c_str(),
7606 NULL, /* For "--separate". */
7607 NULL, /* For "--sup-startup-log". */
7608 NULL
7609 };
7610 unsigned iArg = 5;
7611 if (fSeparate)
7612 apszArgs[iArg++] = "--separate";
7613 apszArgs[iArg++] = pszSupStartupLogArg;
7614
7615 vrc = RTProcCreate(szPath, apszArgs, env, 0, &pid);
7616 }
7617#else /* !VBOX_WITH_VBOXSDL */
7618 if (0)
7619 ;
7620#endif /* !VBOX_WITH_VBOXSDL */
7621
7622 else
7623
7624#ifdef VBOX_WITH_HEADLESS
7625 if ( !strFrontend.compare("headless", Utf8Str::CaseInsensitive)
7626 || !strFrontend.compare("capture", Utf8Str::CaseInsensitive)
7627 || !strFrontend.compare("vrdp", Utf8Str::CaseInsensitive) /* Deprecated. Same as headless. */
7628 )
7629 {
7630 strCanonicalName = "headless";
7631 /* On pre-4.0 the "headless" type was used for passing "--vrdp off" to VBoxHeadless to let it work in OSE,
7632 * which did not contain VRDP server. In VBox 4.0 the remote desktop server (VRDE) is optional,
7633 * and a VM works even if the server has not been installed.
7634 * So in 4.0 the "headless" behavior remains the same for default VBox installations.
7635 * Only if a VRDE has been installed and the VM enables it, the "headless" will work
7636 * differently in 4.0 and 3.x.
7637 */
7638 static const char s_szVBoxHeadless_exe[] = "VBoxHeadless" HOSTSUFF_EXE;
7639 Assert(cchBufLeft >= sizeof(s_szVBoxHeadless_exe));
7640 strcpy(pszNamePart, s_szVBoxHeadless_exe);
7641
7642 Utf8Str idStr = mData->mUuid.toString();
7643 const char *apszArgs[] =
7644 {
7645 szPath,
7646 "--comment", mUserData->s.strName.c_str(),
7647 "--startvm", idStr.c_str(),
7648 "--vrde", "config",
7649 NULL, /* For "--capture". */
7650 NULL, /* For "--sup-startup-log". */
7651 NULL
7652 };
7653 unsigned iArg = 7;
7654 if (!strFrontend.compare("capture", Utf8Str::CaseInsensitive))
7655 apszArgs[iArg++] = "--capture";
7656 apszArgs[iArg++] = pszSupStartupLogArg;
7657
7658# ifdef RT_OS_WINDOWS
7659 vrc = RTProcCreate(szPath, apszArgs, env, RTPROC_FLAGS_NO_WINDOW, &pid);
7660# else
7661 vrc = RTProcCreate(szPath, apszArgs, env, 0, &pid);
7662# endif
7663 }
7664#else /* !VBOX_WITH_HEADLESS */
7665 if (0)
7666 ;
7667#endif /* !VBOX_WITH_HEADLESS */
7668 else
7669 {
7670 RTEnvDestroy(env);
7671 return setError(E_INVALIDARG,
7672 tr("Invalid frontend name: '%s'"),
7673 strFrontend.c_str());
7674 }
7675
7676 RTEnvDestroy(env);
7677
7678 if (RT_FAILURE(vrc))
7679 return setError(VBOX_E_IPRT_ERROR,
7680 tr("Could not launch a process for the machine '%s' (%Rrc)"),
7681 mUserData->s.strName.c_str(), vrc);
7682
7683 LogFlowThisFunc(("launched.pid=%d(0x%x)\n", pid, pid));
7684
7685 if (!fSeparate)
7686 {
7687 /*
7688 * Note that we don't release the lock here before calling the client,
7689 * because it doesn't need to call us back if called with a NULL argument.
7690 * Releasing the lock here is dangerous because we didn't prepare the
7691 * launch data yet, but the client we've just started may happen to be
7692 * too fast and call LockMachine() that will fail (because of PID, etc.),
7693 * so that the Machine will never get out of the Spawning session state.
7694 */
7695
7696 /* inform the session that it will be a remote one */
7697 LogFlowThisFunc(("Calling AssignMachine (NULL)...\n"));
7698#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
7699 HRESULT rc = aControl->AssignMachine(NULL, LockType_Write, Bstr::Empty.raw());
7700#else /* VBOX_WITH_GENERIC_SESSION_WATCHER */
7701 HRESULT rc = aControl->AssignMachine(NULL, LockType_Write, NULL);
7702#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
7703 LogFlowThisFunc(("AssignMachine (NULL) returned %08X\n", rc));
7704
7705 if (FAILED(rc))
7706 {
7707 /* restore the session state */
7708 mData->mSession.mState = SessionState_Unlocked;
7709 alock.release();
7710 mParent->i_addProcessToReap(pid);
7711 /* The failure may occur w/o any error info (from RPC), so provide one */
7712 return setError(VBOX_E_VM_ERROR,
7713 tr("Failed to assign the machine to the session (%Rhrc)"), rc);
7714 }
7715
7716 /* attach launch data to the machine */
7717 Assert(mData->mSession.mPID == NIL_RTPROCESS);
7718 mData->mSession.mRemoteControls.push_back(aControl);
7719 mData->mSession.mProgress = aProgress;
7720 mData->mSession.mPID = pid;
7721 mData->mSession.mState = SessionState_Spawning;
7722 Assert(strCanonicalName.isNotEmpty());
7723 mData->mSession.mName = strCanonicalName;
7724 }
7725 else
7726 {
7727 /* For separate UI process we declare the launch as completed instantly, as the
7728 * actual headless VM start may or may not come. No point in remembering anything
7729 * yet, as what matters for us is when the headless VM gets started. */
7730 aProgress->i_notifyComplete(S_OK);
7731 }
7732
7733 alock.release();
7734 mParent->i_addProcessToReap(pid);
7735
7736 LogFlowThisFuncLeave();
7737 return S_OK;
7738}
7739
7740/**
7741 * Returns @c true if the given session machine instance has an open direct
7742 * session (and optionally also for direct sessions which are closing) and
7743 * returns the session control machine instance if so.
7744 *
7745 * Note that when the method returns @c false, the arguments remain unchanged.
7746 *
7747 * @param aMachine Session machine object.
7748 * @param aControl Direct session control object (optional).
7749 * @param aRequireVM If true then only allow VM sessions.
7750 * @param aAllowClosing If true then additionally a session which is currently
7751 * being closed will also be allowed.
7752 *
7753 * @note locks this object for reading.
7754 */
7755bool Machine::i_isSessionOpen(ComObjPtr<SessionMachine> &aMachine,
7756 ComPtr<IInternalSessionControl> *aControl /*= NULL*/,
7757 bool aRequireVM /*= false*/,
7758 bool aAllowClosing /*= false*/)
7759{
7760 AutoLimitedCaller autoCaller(this);
7761 AssertComRCReturn(autoCaller.rc(), false);
7762
7763 /* just return false for inaccessible machines */
7764 if (getObjectState().getState() != ObjectState::Ready)
7765 return false;
7766
7767 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7768
7769 if ( ( mData->mSession.mState == SessionState_Locked
7770 && (!aRequireVM || mData->mSession.mLockType == LockType_VM))
7771 || (aAllowClosing && mData->mSession.mState == SessionState_Unlocking)
7772 )
7773 {
7774 AssertReturn(!mData->mSession.mMachine.isNull(), false);
7775
7776 aMachine = mData->mSession.mMachine;
7777
7778 if (aControl != NULL)
7779 *aControl = mData->mSession.mDirectControl;
7780
7781 return true;
7782 }
7783
7784 return false;
7785}
7786
7787/**
7788 * Returns @c true if the given machine has an spawning direct session.
7789 *
7790 * @note locks this object for reading.
7791 */
7792bool Machine::i_isSessionSpawning()
7793{
7794 AutoLimitedCaller autoCaller(this);
7795 AssertComRCReturn(autoCaller.rc(), false);
7796
7797 /* just return false for inaccessible machines */
7798 if (getObjectState().getState() != ObjectState::Ready)
7799 return false;
7800
7801 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
7802
7803 if (mData->mSession.mState == SessionState_Spawning)
7804 return true;
7805
7806 return false;
7807}
7808
7809/**
7810 * Called from the client watcher thread to check for unexpected client process
7811 * death during Session_Spawning state (e.g. before it successfully opened a
7812 * direct session).
7813 *
7814 * On Win32 and on OS/2, this method is called only when we've got the
7815 * direct client's process termination notification, so it always returns @c
7816 * true.
7817 *
7818 * On other platforms, this method returns @c true if the client process is
7819 * terminated and @c false if it's still alive.
7820 *
7821 * @note Locks this object for writing.
7822 */
7823bool Machine::i_checkForSpawnFailure()
7824{
7825 AutoCaller autoCaller(this);
7826 if (!autoCaller.isOk())
7827 {
7828 /* nothing to do */
7829 LogFlowThisFunc(("Already uninitialized!\n"));
7830 return true;
7831 }
7832
7833 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7834
7835 if (mData->mSession.mState != SessionState_Spawning)
7836 {
7837 /* nothing to do */
7838 LogFlowThisFunc(("Not spawning any more!\n"));
7839 return true;
7840 }
7841
7842 HRESULT rc = S_OK;
7843
7844 /* PID not yet initialized, skip check. */
7845 if (mData->mSession.mPID == NIL_RTPROCESS)
7846 return false;
7847
7848 RTPROCSTATUS status;
7849 int vrc = RTProcWait(mData->mSession.mPID, RTPROCWAIT_FLAGS_NOBLOCK, &status);
7850
7851 if (vrc != VERR_PROCESS_RUNNING)
7852 {
7853 Utf8Str strExtraInfo;
7854
7855#if defined(RT_OS_WINDOWS) && defined(VBOX_WITH_HARDENING)
7856 /* If the startup logfile exists and is of non-zero length, tell the
7857 user to look there for more details to encourage them to attach it
7858 when reporting startup issues. */
7859 Utf8Str strStartupLogFile = i_getStartupLogFilename();
7860 uint64_t cbStartupLogFile = 0;
7861 int vrc2 = RTFileQuerySize(strStartupLogFile.c_str(), &cbStartupLogFile);
7862 if (RT_SUCCESS(vrc2) && cbStartupLogFile > 0)
7863 strExtraInfo.append(Utf8StrFmt(tr(". More details may be available in '%s'"), strStartupLogFile.c_str()));
7864#endif
7865
7866 if (RT_SUCCESS(vrc) && status.enmReason == RTPROCEXITREASON_NORMAL)
7867 rc = setError(E_FAIL,
7868 tr("The virtual machine '%s' has terminated unexpectedly during startup with exit code %d (%#x)%s"),
7869 i_getName().c_str(), status.iStatus, status.iStatus, strExtraInfo.c_str());
7870 else if (RT_SUCCESS(vrc) && status.enmReason == RTPROCEXITREASON_SIGNAL)
7871 rc = setError(E_FAIL,
7872 tr("The virtual machine '%s' has terminated unexpectedly during startup because of signal %d%s"),
7873 i_getName().c_str(), status.iStatus, strExtraInfo.c_str());
7874 else if (RT_SUCCESS(vrc) && status.enmReason == RTPROCEXITREASON_ABEND)
7875 rc = setError(E_FAIL,
7876 tr("The virtual machine '%s' has terminated abnormally (iStatus=%#x)%s"),
7877 i_getName().c_str(), status.iStatus, strExtraInfo.c_str());
7878 else
7879 rc = setError(E_FAIL,
7880 tr("The virtual machine '%s' has terminated unexpectedly during startup (%Rrc)%s"),
7881 i_getName().c_str(), vrc, strExtraInfo.c_str());
7882 }
7883
7884 if (FAILED(rc))
7885 {
7886 /* Close the remote session, remove the remote control from the list
7887 * and reset session state to Closed (@note keep the code in sync with
7888 * the relevant part in LockMachine()). */
7889
7890 Assert(mData->mSession.mRemoteControls.size() == 1);
7891 if (mData->mSession.mRemoteControls.size() == 1)
7892 {
7893 ErrorInfoKeeper eik;
7894 mData->mSession.mRemoteControls.front()->Uninitialize();
7895 }
7896
7897 mData->mSession.mRemoteControls.clear();
7898 mData->mSession.mState = SessionState_Unlocked;
7899
7900 /* finalize the progress after setting the state */
7901 if (!mData->mSession.mProgress.isNull())
7902 {
7903 mData->mSession.mProgress->notifyComplete(rc);
7904 mData->mSession.mProgress.setNull();
7905 }
7906
7907 mData->mSession.mPID = NIL_RTPROCESS;
7908
7909 mParent->i_onSessionStateChange(mData->mUuid, SessionState_Unlocked);
7910 return true;
7911 }
7912
7913 return false;
7914}
7915
7916/**
7917 * Checks whether the machine can be registered. If so, commits and saves
7918 * all settings.
7919 *
7920 * @note Must be called from mParent's write lock. Locks this object and
7921 * children for writing.
7922 */
7923HRESULT Machine::i_prepareRegister()
7924{
7925 AssertReturn(mParent->isWriteLockOnCurrentThread(), E_FAIL);
7926
7927 AutoLimitedCaller autoCaller(this);
7928 AssertComRCReturnRC(autoCaller.rc());
7929
7930 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
7931
7932 /* wait for state dependents to drop to zero */
7933 i_ensureNoStateDependencies();
7934
7935 if (!mData->mAccessible)
7936 return setError(VBOX_E_INVALID_OBJECT_STATE,
7937 tr("The machine '%s' with UUID {%s} is inaccessible and cannot be registered"),
7938 mUserData->s.strName.c_str(),
7939 mData->mUuid.toString().c_str());
7940
7941 AssertReturn(getObjectState().getState() == ObjectState::Ready, E_FAIL);
7942
7943 if (mData->mRegistered)
7944 return setError(VBOX_E_INVALID_OBJECT_STATE,
7945 tr("The machine '%s' with UUID {%s} is already registered"),
7946 mUserData->s.strName.c_str(),
7947 mData->mUuid.toString().c_str());
7948
7949 HRESULT rc = S_OK;
7950
7951 // Ensure the settings are saved. If we are going to be registered and
7952 // no config file exists yet, create it by calling i_saveSettings() too.
7953 if ( (mData->flModifications)
7954 || (!mData->pMachineConfigFile->fileExists())
7955 )
7956 {
7957 rc = i_saveSettings(NULL);
7958 // no need to check whether VirtualBox.xml needs saving too since
7959 // we can't have a machine XML file rename pending
7960 if (FAILED(rc)) return rc;
7961 }
7962
7963 /* more config checking goes here */
7964
7965 if (SUCCEEDED(rc))
7966 {
7967 /* we may have had implicit modifications we want to fix on success */
7968 i_commit();
7969
7970 mData->mRegistered = true;
7971 }
7972 else
7973 {
7974 /* we may have had implicit modifications we want to cancel on failure*/
7975 i_rollback(false /* aNotify */);
7976 }
7977
7978 return rc;
7979}
7980
7981/**
7982 * Increases the number of objects dependent on the machine state or on the
7983 * registered state. Guarantees that these two states will not change at least
7984 * until #releaseStateDependency() is called.
7985 *
7986 * Depending on the @a aDepType value, additional state checks may be made.
7987 * These checks will set extended error info on failure. See
7988 * #checkStateDependency() for more info.
7989 *
7990 * If this method returns a failure, the dependency is not added and the caller
7991 * is not allowed to rely on any particular machine state or registration state
7992 * value and may return the failed result code to the upper level.
7993 *
7994 * @param aDepType Dependency type to add.
7995 * @param aState Current machine state (NULL if not interested).
7996 * @param aRegistered Current registered state (NULL if not interested).
7997 *
7998 * @note Locks this object for writing.
7999 */
8000HRESULT Machine::i_addStateDependency(StateDependency aDepType /* = AnyStateDep */,
8001 MachineState_T *aState /* = NULL */,
8002 BOOL *aRegistered /* = NULL */)
8003{
8004 AutoCaller autoCaller(this);
8005 AssertComRCReturnRC(autoCaller.rc());
8006
8007 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8008
8009 HRESULT rc = i_checkStateDependency(aDepType);
8010 if (FAILED(rc)) return rc;
8011
8012 {
8013 if (mData->mMachineStateChangePending != 0)
8014 {
8015 /* i_ensureNoStateDependencies() is waiting for state dependencies to
8016 * drop to zero so don't add more. It may make sense to wait a bit
8017 * and retry before reporting an error (since the pending state
8018 * transition should be really quick) but let's just assert for
8019 * now to see if it ever happens on practice. */
8020
8021 AssertFailed();
8022
8023 return setError(E_ACCESSDENIED,
8024 tr("Machine state change is in progress. Please retry the operation later."));
8025 }
8026
8027 ++mData->mMachineStateDeps;
8028 Assert(mData->mMachineStateDeps != 0 /* overflow */);
8029 }
8030
8031 if (aState)
8032 *aState = mData->mMachineState;
8033 if (aRegistered)
8034 *aRegistered = mData->mRegistered;
8035
8036 return S_OK;
8037}
8038
8039/**
8040 * Decreases the number of objects dependent on the machine state.
8041 * Must always complete the #addStateDependency() call after the state
8042 * dependency is no more necessary.
8043 */
8044void Machine::i_releaseStateDependency()
8045{
8046 AutoCaller autoCaller(this);
8047 AssertComRCReturnVoid(autoCaller.rc());
8048
8049 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8050
8051 /* releaseStateDependency() w/o addStateDependency()? */
8052 AssertReturnVoid(mData->mMachineStateDeps != 0);
8053 -- mData->mMachineStateDeps;
8054
8055 if (mData->mMachineStateDeps == 0)
8056 {
8057 /* inform i_ensureNoStateDependencies() that there are no more deps */
8058 if (mData->mMachineStateChangePending != 0)
8059 {
8060 Assert(mData->mMachineStateDepsSem != NIL_RTSEMEVENTMULTI);
8061 RTSemEventMultiSignal (mData->mMachineStateDepsSem);
8062 }
8063 }
8064}
8065
8066Utf8Str Machine::i_getExtraData(const Utf8Str &strKey)
8067{
8068 /* start with nothing found */
8069 Utf8Str strResult("");
8070
8071 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
8072
8073 settings::StringsMap::const_iterator it = mData->pMachineConfigFile->mapExtraDataItems.find(strKey);
8074 if (it != mData->pMachineConfigFile->mapExtraDataItems.end())
8075 // found:
8076 strResult = it->second; // source is a Utf8Str
8077
8078 return strResult;
8079}
8080
8081// protected methods
8082/////////////////////////////////////////////////////////////////////////////
8083
8084/**
8085 * Performs machine state checks based on the @a aDepType value. If a check
8086 * fails, this method will set extended error info, otherwise it will return
8087 * S_OK. It is supposed, that on failure, the caller will immediately return
8088 * the return value of this method to the upper level.
8089 *
8090 * When @a aDepType is AnyStateDep, this method always returns S_OK.
8091 *
8092 * When @a aDepType is MutableStateDep, this method returns S_OK only if the
8093 * current state of this machine object allows to change settings of the
8094 * machine (i.e. the machine is not registered, or registered but not running
8095 * and not saved). It is useful to call this method from Machine setters
8096 * before performing any change.
8097 *
8098 * When @a aDepType is MutableOrSavedStateDep, this method behaves the same
8099 * as for MutableStateDep except that if the machine is saved, S_OK is also
8100 * returned. This is useful in setters which allow changing machine
8101 * properties when it is in the saved state.
8102 *
8103 * When @a aDepType is MutableOrRunningStateDep, this method returns S_OK only
8104 * if the current state of this machine object allows to change runtime
8105 * changeable settings of the machine (i.e. the machine is not registered, or
8106 * registered but either running or not running and not saved). It is useful
8107 * to call this method from Machine setters before performing any changes to
8108 * runtime changeable settings.
8109 *
8110 * When @a aDepType is MutableOrSavedOrRunningStateDep, this method behaves
8111 * the same as for MutableOrRunningStateDep except that if the machine is
8112 * saved, S_OK is also returned. This is useful in setters which allow
8113 * changing runtime and saved state changeable machine properties.
8114 *
8115 * @param aDepType Dependency type to check.
8116 *
8117 * @note Non Machine based classes should use #addStateDependency() and
8118 * #releaseStateDependency() methods or the smart AutoStateDependency
8119 * template.
8120 *
8121 * @note This method must be called from under this object's read or write
8122 * lock.
8123 */
8124HRESULT Machine::i_checkStateDependency(StateDependency aDepType)
8125{
8126 switch (aDepType)
8127 {
8128 case AnyStateDep:
8129 {
8130 break;
8131 }
8132 case MutableStateDep:
8133 {
8134 if ( mData->mRegistered
8135 && ( !i_isSessionMachine()
8136 || ( mData->mMachineState != MachineState_Aborted
8137 && mData->mMachineState != MachineState_Teleported
8138 && mData->mMachineState != MachineState_PoweredOff
8139 )
8140 )
8141 )
8142 return setError(VBOX_E_INVALID_VM_STATE,
8143 tr("The machine is not mutable (state is %s)"),
8144 Global::stringifyMachineState(mData->mMachineState));
8145 break;
8146 }
8147 case MutableOrSavedStateDep:
8148 {
8149 if ( mData->mRegistered
8150 && ( !i_isSessionMachine()
8151 || ( mData->mMachineState != MachineState_Aborted
8152 && mData->mMachineState != MachineState_Teleported
8153 && mData->mMachineState != MachineState_Saved
8154 && mData->mMachineState != MachineState_PoweredOff
8155 )
8156 )
8157 )
8158 return setError(VBOX_E_INVALID_VM_STATE,
8159 tr("The machine is not mutable (state is %s)"),
8160 Global::stringifyMachineState(mData->mMachineState));
8161 break;
8162 }
8163 case MutableOrRunningStateDep:
8164 {
8165 if ( mData->mRegistered
8166 && ( !i_isSessionMachine()
8167 || ( mData->mMachineState != MachineState_Aborted
8168 && mData->mMachineState != MachineState_Teleported
8169 && mData->mMachineState != MachineState_PoweredOff
8170 && !Global::IsOnline(mData->mMachineState)
8171 )
8172 )
8173 )
8174 return setError(VBOX_E_INVALID_VM_STATE,
8175 tr("The machine is not mutable (state is %s)"),
8176 Global::stringifyMachineState(mData->mMachineState));
8177 break;
8178 }
8179 case MutableOrSavedOrRunningStateDep:
8180 {
8181 if ( mData->mRegistered
8182 && ( !i_isSessionMachine()
8183 || ( mData->mMachineState != MachineState_Aborted
8184 && mData->mMachineState != MachineState_Teleported
8185 && mData->mMachineState != MachineState_Saved
8186 && mData->mMachineState != MachineState_PoweredOff
8187 && !Global::IsOnline(mData->mMachineState)
8188 )
8189 )
8190 )
8191 return setError(VBOX_E_INVALID_VM_STATE,
8192 tr("The machine is not mutable (state is %s)"),
8193 Global::stringifyMachineState(mData->mMachineState));
8194 break;
8195 }
8196 }
8197
8198 return S_OK;
8199}
8200
8201/**
8202 * Helper to initialize all associated child objects and allocate data
8203 * structures.
8204 *
8205 * This method must be called as a part of the object's initialization procedure
8206 * (usually done in the #init() method).
8207 *
8208 * @note Must be called only from #init() or from #registeredInit().
8209 */
8210HRESULT Machine::initDataAndChildObjects()
8211{
8212 AutoCaller autoCaller(this);
8213 AssertComRCReturnRC(autoCaller.rc());
8214 AssertComRCReturn( getObjectState().getState() == ObjectState::InInit
8215 || getObjectState().getState() == ObjectState::Limited, E_FAIL);
8216
8217 AssertReturn(!mData->mAccessible, E_FAIL);
8218
8219 /* allocate data structures */
8220 mSSData.allocate();
8221 mUserData.allocate();
8222 mHWData.allocate();
8223 mMediaData.allocate();
8224 mStorageControllers.allocate();
8225 mUSBControllers.allocate();
8226
8227 /* initialize mOSTypeId */
8228 mUserData->s.strOsType = mParent->i_getUnknownOSType()->i_id();
8229
8230 /* create associated BIOS settings object */
8231 unconst(mBIOSSettings).createObject();
8232 mBIOSSettings->init(this);
8233
8234 /* create an associated VRDE object (default is disabled) */
8235 unconst(mVRDEServer).createObject();
8236 mVRDEServer->init(this);
8237
8238 /* create associated serial port objects */
8239 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
8240 {
8241 unconst(mSerialPorts[slot]).createObject();
8242 mSerialPorts[slot]->init(this, slot);
8243 }
8244
8245 /* create associated parallel port objects */
8246 for (ULONG slot = 0; slot < RT_ELEMENTS(mParallelPorts); ++slot)
8247 {
8248 unconst(mParallelPorts[slot]).createObject();
8249 mParallelPorts[slot]->init(this, slot);
8250 }
8251
8252 /* create the audio adapter object (always present, default is disabled) */
8253 unconst(mAudioAdapter).createObject();
8254 mAudioAdapter->init(this);
8255
8256 /* create the USB device filters object (always present) */
8257 unconst(mUSBDeviceFilters).createObject();
8258 mUSBDeviceFilters->init(this);
8259
8260 /* create associated network adapter objects */
8261 mNetworkAdapters.resize(Global::getMaxNetworkAdapters(mHWData->mChipsetType));
8262 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
8263 {
8264 unconst(mNetworkAdapters[slot]).createObject();
8265 mNetworkAdapters[slot]->init(this, slot);
8266 }
8267
8268 /* create the bandwidth control */
8269 unconst(mBandwidthControl).createObject();
8270 mBandwidthControl->init(this);
8271
8272 return S_OK;
8273}
8274
8275/**
8276 * Helper to uninitialize all associated child objects and to free all data
8277 * structures.
8278 *
8279 * This method must be called as a part of the object's uninitialization
8280 * procedure (usually done in the #uninit() method).
8281 *
8282 * @note Must be called only from #uninit() or from #registeredInit().
8283 */
8284void Machine::uninitDataAndChildObjects()
8285{
8286 AutoCaller autoCaller(this);
8287 AssertComRCReturnVoid(autoCaller.rc());
8288 AssertComRCReturnVoid( getObjectState().getState() == ObjectState::InUninit
8289 || getObjectState().getState() == ObjectState::Limited);
8290
8291 /* tell all our other child objects we've been uninitialized */
8292 if (mBandwidthControl)
8293 {
8294 mBandwidthControl->uninit();
8295 unconst(mBandwidthControl).setNull();
8296 }
8297
8298 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
8299 {
8300 if (mNetworkAdapters[slot])
8301 {
8302 mNetworkAdapters[slot]->uninit();
8303 unconst(mNetworkAdapters[slot]).setNull();
8304 }
8305 }
8306
8307 if (mUSBDeviceFilters)
8308 {
8309 mUSBDeviceFilters->uninit();
8310 unconst(mUSBDeviceFilters).setNull();
8311 }
8312
8313 if (mAudioAdapter)
8314 {
8315 mAudioAdapter->uninit();
8316 unconst(mAudioAdapter).setNull();
8317 }
8318
8319 for (ULONG slot = 0; slot < RT_ELEMENTS(mParallelPorts); ++slot)
8320 {
8321 if (mParallelPorts[slot])
8322 {
8323 mParallelPorts[slot]->uninit();
8324 unconst(mParallelPorts[slot]).setNull();
8325 }
8326 }
8327
8328 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
8329 {
8330 if (mSerialPorts[slot])
8331 {
8332 mSerialPorts[slot]->uninit();
8333 unconst(mSerialPorts[slot]).setNull();
8334 }
8335 }
8336
8337 if (mVRDEServer)
8338 {
8339 mVRDEServer->uninit();
8340 unconst(mVRDEServer).setNull();
8341 }
8342
8343 if (mBIOSSettings)
8344 {
8345 mBIOSSettings->uninit();
8346 unconst(mBIOSSettings).setNull();
8347 }
8348
8349 /* Deassociate media (only when a real Machine or a SnapshotMachine
8350 * instance is uninitialized; SessionMachine instances refer to real
8351 * Machine media). This is necessary for a clean re-initialization of
8352 * the VM after successfully re-checking the accessibility state. Note
8353 * that in case of normal Machine or SnapshotMachine uninitialization (as
8354 * a result of unregistering or deleting the snapshot), outdated media
8355 * attachments will already be uninitialized and deleted, so this
8356 * code will not affect them. */
8357 if ( !!mMediaData
8358 && (!i_isSessionMachine())
8359 )
8360 {
8361 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
8362 it != mMediaData->mAttachments.end();
8363 ++it)
8364 {
8365 ComObjPtr<Medium> pMedium = (*it)->i_getMedium();
8366 if (pMedium.isNull())
8367 continue;
8368 HRESULT rc = pMedium->i_removeBackReference(mData->mUuid, i_getSnapshotId());
8369 AssertComRC(rc);
8370 }
8371 }
8372
8373 if (!i_isSessionMachine() && !i_isSnapshotMachine())
8374 {
8375 // clean up the snapshots list (Snapshot::uninit() will handle the snapshot's children recursively)
8376 if (mData->mFirstSnapshot)
8377 {
8378 // snapshots tree is protected by machine write lock; strictly
8379 // this isn't necessary here since we're deleting the entire
8380 // machine, but otherwise we assert in Snapshot::uninit()
8381 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8382 mData->mFirstSnapshot->uninit();
8383 mData->mFirstSnapshot.setNull();
8384 }
8385
8386 mData->mCurrentSnapshot.setNull();
8387 }
8388
8389 /* free data structures (the essential mData structure is not freed here
8390 * since it may be still in use) */
8391 mMediaData.free();
8392 mStorageControllers.free();
8393 mUSBControllers.free();
8394 mHWData.free();
8395 mUserData.free();
8396 mSSData.free();
8397}
8398
8399/**
8400 * Returns a pointer to the Machine object for this machine that acts like a
8401 * parent for complex machine data objects such as shared folders, etc.
8402 *
8403 * For primary Machine objects and for SnapshotMachine objects, returns this
8404 * object's pointer itself. For SessionMachine objects, returns the peer
8405 * (primary) machine pointer.
8406 */
8407Machine* Machine::i_getMachine()
8408{
8409 if (i_isSessionMachine())
8410 return (Machine*)mPeer;
8411 return this;
8412}
8413
8414/**
8415 * Makes sure that there are no machine state dependents. If necessary, waits
8416 * for the number of dependents to drop to zero.
8417 *
8418 * Make sure this method is called from under this object's write lock to
8419 * guarantee that no new dependents may be added when this method returns
8420 * control to the caller.
8421 *
8422 * @note Locks this object for writing. The lock will be released while waiting
8423 * (if necessary).
8424 *
8425 * @warning To be used only in methods that change the machine state!
8426 */
8427void Machine::i_ensureNoStateDependencies()
8428{
8429 AssertReturnVoid(isWriteLockOnCurrentThread());
8430
8431 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8432
8433 /* Wait for all state dependents if necessary */
8434 if (mData->mMachineStateDeps != 0)
8435 {
8436 /* lazy semaphore creation */
8437 if (mData->mMachineStateDepsSem == NIL_RTSEMEVENTMULTI)
8438 RTSemEventMultiCreate(&mData->mMachineStateDepsSem);
8439
8440 LogFlowThisFunc(("Waiting for state deps (%d) to drop to zero...\n",
8441 mData->mMachineStateDeps));
8442
8443 ++mData->mMachineStateChangePending;
8444
8445 /* reset the semaphore before waiting, the last dependent will signal
8446 * it */
8447 RTSemEventMultiReset(mData->mMachineStateDepsSem);
8448
8449 alock.release();
8450
8451 RTSemEventMultiWait(mData->mMachineStateDepsSem, RT_INDEFINITE_WAIT);
8452
8453 alock.acquire();
8454
8455 -- mData->mMachineStateChangePending;
8456 }
8457}
8458
8459/**
8460 * Changes the machine state and informs callbacks.
8461 *
8462 * This method is not intended to fail so it either returns S_OK or asserts (and
8463 * returns a failure).
8464 *
8465 * @note Locks this object for writing.
8466 */
8467HRESULT Machine::i_setMachineState(MachineState_T aMachineState)
8468{
8469 LogFlowThisFuncEnter();
8470 LogFlowThisFunc(("aMachineState=%s\n", Global::stringifyMachineState(aMachineState) ));
8471 Assert(aMachineState != MachineState_Null);
8472
8473 AutoCaller autoCaller(this);
8474 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
8475
8476 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
8477
8478 /* wait for state dependents to drop to zero */
8479 i_ensureNoStateDependencies();
8480
8481 MachineState_T const enmOldState = mData->mMachineState;
8482 if (enmOldState != aMachineState)
8483 {
8484 mData->mMachineState = aMachineState;
8485 RTTimeNow(&mData->mLastStateChange);
8486
8487#ifdef VBOX_WITH_DTRACE_R3_MAIN
8488 VBOXAPI_MACHINE_STATE_CHANGED(this, aMachineState, enmOldState, mData->mUuid.toStringCurly().c_str());
8489#endif
8490 mParent->i_onMachineStateChange(mData->mUuid, aMachineState);
8491 }
8492
8493 LogFlowThisFuncLeave();
8494 return S_OK;
8495}
8496
8497/**
8498 * Searches for a shared folder with the given logical name
8499 * in the collection of shared folders.
8500 *
8501 * @param aName logical name of the shared folder
8502 * @param aSharedFolder where to return the found object
8503 * @param aSetError whether to set the error info if the folder is
8504 * not found
8505 * @return
8506 * S_OK when found or VBOX_E_OBJECT_NOT_FOUND when not found
8507 *
8508 * @note
8509 * must be called from under the object's lock!
8510 */
8511HRESULT Machine::i_findSharedFolder(const Utf8Str &aName,
8512 ComObjPtr<SharedFolder> &aSharedFolder,
8513 bool aSetError /* = false */)
8514{
8515 HRESULT rc = VBOX_E_OBJECT_NOT_FOUND;
8516 for (HWData::SharedFolderList::const_iterator it = mHWData->mSharedFolders.begin();
8517 it != mHWData->mSharedFolders.end();
8518 ++it)
8519 {
8520 SharedFolder *pSF = *it;
8521 AutoCaller autoCaller(pSF);
8522 if (pSF->i_getName() == aName)
8523 {
8524 aSharedFolder = pSF;
8525 rc = S_OK;
8526 break;
8527 }
8528 }
8529
8530 if (aSetError && FAILED(rc))
8531 setError(rc, tr("Could not find a shared folder named '%s'"), aName.c_str());
8532
8533 return rc;
8534}
8535
8536/**
8537 * Initializes all machine instance data from the given settings structures
8538 * from XML. The exception is the machine UUID which needs special handling
8539 * depending on the caller's use case, so the caller needs to set that herself.
8540 *
8541 * This gets called in several contexts during machine initialization:
8542 *
8543 * -- When machine XML exists on disk already and needs to be loaded into memory,
8544 * for example, from registeredInit() to load all registered machines on
8545 * VirtualBox startup. In this case, puuidRegistry is NULL because the media
8546 * attached to the machine should be part of some media registry already.
8547 *
8548 * -- During OVF import, when a machine config has been constructed from an
8549 * OVF file. In this case, puuidRegistry is set to the machine UUID to
8550 * ensure that the media listed as attachments in the config (which have
8551 * been imported from the OVF) receive the correct registry ID.
8552 *
8553 * -- During VM cloning.
8554 *
8555 * @param config Machine settings from XML.
8556 * @param puuidRegistry If != NULL, Medium::setRegistryIdIfFirst() gets called with this registry ID
8557 * for each attached medium in the config.
8558 * @return
8559 */
8560HRESULT Machine::i_loadMachineDataFromSettings(const settings::MachineConfigFile &config,
8561 const Guid *puuidRegistry)
8562{
8563 // copy name, description, OS type, teleporter, UTC etc.
8564 mUserData->s = config.machineUserData;
8565
8566 // Decode the Icon overide data from config userdata and set onto Machine.
8567 #define DECODE_STR_MAX _1M
8568 const char* pszStr = config.machineUserData.ovIcon.c_str();
8569 ssize_t cbOut = RTBase64DecodedSize(pszStr, NULL);
8570 if (cbOut > DECODE_STR_MAX)
8571 return setError(E_FAIL,
8572 tr("Icon Data too long.'%d' > '%d'"),
8573 cbOut,
8574 DECODE_STR_MAX);
8575 mUserData->mIcon.resize(cbOut);
8576 int vrc = VINF_SUCCESS;
8577 if (cbOut)
8578 vrc = RTBase64Decode(pszStr, &mUserData->mIcon.front(), cbOut, NULL, NULL);
8579 if (RT_FAILURE(vrc))
8580 {
8581 mUserData->mIcon.resize(0);
8582 return setError(E_FAIL,
8583 tr("Failure to Decode Icon Data. '%s' (%Rrc)"),
8584 pszStr,
8585 vrc);
8586 }
8587
8588 // look up the object by Id to check it is valid
8589 ComPtr<IGuestOSType> guestOSType;
8590 HRESULT rc = mParent->GetGuestOSType(Bstr(mUserData->s.strOsType).raw(),
8591 guestOSType.asOutParam());
8592 if (FAILED(rc)) return rc;
8593
8594 // stateFile (optional)
8595 if (config.strStateFile.isEmpty())
8596 mSSData->strStateFilePath.setNull();
8597 else
8598 {
8599 Utf8Str stateFilePathFull(config.strStateFile);
8600 vrc = i_calculateFullPath(stateFilePathFull, stateFilePathFull);
8601 if (RT_FAILURE(vrc))
8602 return setError(E_FAIL,
8603 tr("Invalid saved state file path '%s' (%Rrc)"),
8604 config.strStateFile.c_str(),
8605 vrc);
8606 mSSData->strStateFilePath = stateFilePathFull;
8607 }
8608
8609 // snapshot folder needs special processing so set it again
8610 rc = COMSETTER(SnapshotFolder)(Bstr(config.machineUserData.strSnapshotFolder).raw());
8611 if (FAILED(rc)) return rc;
8612
8613 /* Copy the extra data items (Not in any case config is already the same as
8614 * mData->pMachineConfigFile, like when the xml files are read from disk. So
8615 * make sure the extra data map is copied). */
8616 mData->pMachineConfigFile->mapExtraDataItems = config.mapExtraDataItems;
8617
8618 /* currentStateModified (optional, default is true) */
8619 mData->mCurrentStateModified = config.fCurrentStateModified;
8620
8621 mData->mLastStateChange = config.timeLastStateChange;
8622
8623 /*
8624 * note: all mUserData members must be assigned prior this point because
8625 * we need to commit changes in order to let mUserData be shared by all
8626 * snapshot machine instances.
8627 */
8628 mUserData.commitCopy();
8629
8630 // machine registry, if present (must be loaded before snapshots)
8631 if (config.canHaveOwnMediaRegistry())
8632 {
8633 // determine machine folder
8634 Utf8Str strMachineFolder = i_getSettingsFileFull();
8635 strMachineFolder.stripFilename();
8636 rc = mParent->initMedia(i_getId(), // media registry ID == machine UUID
8637 config.mediaRegistry,
8638 strMachineFolder);
8639 if (FAILED(rc)) return rc;
8640 }
8641
8642 /* Snapshot node (optional) */
8643 size_t cRootSnapshots;
8644 if ((cRootSnapshots = config.llFirstSnapshot.size()))
8645 {
8646 // there must be only one root snapshot
8647 Assert(cRootSnapshots == 1);
8648
8649 const settings::Snapshot &snap = config.llFirstSnapshot.front();
8650
8651 rc = i_loadSnapshot(snap,
8652 config.uuidCurrentSnapshot,
8653 NULL); // no parent == first snapshot
8654 if (FAILED(rc)) return rc;
8655 }
8656
8657 // hardware data
8658 rc = i_loadHardware(config.hardwareMachine, &config.debugging, &config.autostart);
8659 if (FAILED(rc)) return rc;
8660
8661 // load storage controllers
8662 rc = i_loadStorageControllers(config.storageMachine,
8663 puuidRegistry,
8664 NULL /* puuidSnapshot */);
8665 if (FAILED(rc)) return rc;
8666
8667 /*
8668 * NOTE: the assignment below must be the last thing to do,
8669 * otherwise it will be not possible to change the settings
8670 * somewhere in the code above because all setters will be
8671 * blocked by i_checkStateDependency(MutableStateDep).
8672 */
8673
8674 /* set the machine state to Aborted or Saved when appropriate */
8675 if (config.fAborted)
8676 {
8677 mSSData->strStateFilePath.setNull();
8678
8679 /* no need to use i_setMachineState() during init() */
8680 mData->mMachineState = MachineState_Aborted;
8681 }
8682 else if (!mSSData->strStateFilePath.isEmpty())
8683 {
8684 /* no need to use i_setMachineState() during init() */
8685 mData->mMachineState = MachineState_Saved;
8686 }
8687
8688 // after loading settings, we are no longer different from the XML on disk
8689 mData->flModifications = 0;
8690
8691 return S_OK;
8692}
8693
8694/**
8695 * Recursively loads all snapshots starting from the given.
8696 *
8697 * @param aNode <Snapshot> node.
8698 * @param aCurSnapshotId Current snapshot ID from the settings file.
8699 * @param aParentSnapshot Parent snapshot.
8700 */
8701HRESULT Machine::i_loadSnapshot(const settings::Snapshot &data,
8702 const Guid &aCurSnapshotId,
8703 Snapshot *aParentSnapshot)
8704{
8705 AssertReturn(!i_isSnapshotMachine(), E_FAIL);
8706 AssertReturn(!i_isSessionMachine(), E_FAIL);
8707
8708 HRESULT rc = S_OK;
8709
8710 Utf8Str strStateFile;
8711 if (!data.strStateFile.isEmpty())
8712 {
8713 /* optional */
8714 strStateFile = data.strStateFile;
8715 int vrc = i_calculateFullPath(strStateFile, strStateFile);
8716 if (RT_FAILURE(vrc))
8717 return setError(E_FAIL,
8718 tr("Invalid saved state file path '%s' (%Rrc)"),
8719 strStateFile.c_str(),
8720 vrc);
8721 }
8722
8723 /* create a snapshot machine object */
8724 ComObjPtr<SnapshotMachine> pSnapshotMachine;
8725 pSnapshotMachine.createObject();
8726 rc = pSnapshotMachine->initFromSettings(this,
8727 data.hardware,
8728 &data.debugging,
8729 &data.autostart,
8730 data.storage,
8731 data.uuid.ref(),
8732 strStateFile);
8733 if (FAILED(rc)) return rc;
8734
8735 /* create a snapshot object */
8736 ComObjPtr<Snapshot> pSnapshot;
8737 pSnapshot.createObject();
8738 /* initialize the snapshot */
8739 rc = pSnapshot->init(mParent, // VirtualBox object
8740 data.uuid,
8741 data.strName,
8742 data.strDescription,
8743 data.timestamp,
8744 pSnapshotMachine,
8745 aParentSnapshot);
8746 if (FAILED(rc)) return rc;
8747
8748 /* memorize the first snapshot if necessary */
8749 if (!mData->mFirstSnapshot)
8750 mData->mFirstSnapshot = pSnapshot;
8751
8752 /* memorize the current snapshot when appropriate */
8753 if ( !mData->mCurrentSnapshot
8754 && pSnapshot->i_getId() == aCurSnapshotId
8755 )
8756 mData->mCurrentSnapshot = pSnapshot;
8757
8758 // now create the children
8759 for (settings::SnapshotsList::const_iterator it = data.llChildSnapshots.begin();
8760 it != data.llChildSnapshots.end();
8761 ++it)
8762 {
8763 const settings::Snapshot &childData = *it;
8764 // recurse
8765 rc = i_loadSnapshot(childData,
8766 aCurSnapshotId,
8767 pSnapshot); // parent = the one we created above
8768 if (FAILED(rc)) return rc;
8769 }
8770
8771 return rc;
8772}
8773
8774/**
8775 * Loads settings into mHWData.
8776 *
8777 * @param data Reference to the hardware settings.
8778 * @param pDbg Pointer to the debugging settings.
8779 * @param pAutostart Pointer to the autostart settings.
8780 */
8781HRESULT Machine::i_loadHardware(const settings::Hardware &data, const settings::Debugging *pDbg,
8782 const settings::Autostart *pAutostart)
8783{
8784 AssertReturn(!i_isSessionMachine(), E_FAIL);
8785
8786 HRESULT rc = S_OK;
8787
8788 try
8789 {
8790 /* The hardware version attribute (optional). */
8791 mHWData->mHWVersion = data.strVersion;
8792 mHWData->mHardwareUUID = data.uuid;
8793
8794 mHWData->mHWVirtExEnabled = data.fHardwareVirt;
8795 mHWData->mHWVirtExNestedPagingEnabled = data.fNestedPaging;
8796 mHWData->mHWVirtExLargePagesEnabled = data.fLargePages;
8797 mHWData->mHWVirtExVPIDEnabled = data.fVPID;
8798 mHWData->mHWVirtExUXEnabled = data.fUnrestrictedExecution;
8799 mHWData->mHWVirtExForceEnabled = data.fHardwareVirtForce;
8800 mHWData->mPAEEnabled = data.fPAE;
8801 mHWData->mLongMode = data.enmLongMode;
8802 mHWData->mTripleFaultReset = data.fTripleFaultReset;
8803 mHWData->mCPUCount = data.cCPUs;
8804 mHWData->mCPUHotPlugEnabled = data.fCpuHotPlug;
8805 mHWData->mCpuExecutionCap = data.ulCpuExecutionCap;
8806 mHWData->mCpuIdPortabilityLevel = data.uCpuIdPortabilityLevel;
8807
8808 // cpu
8809 if (mHWData->mCPUHotPlugEnabled)
8810 {
8811 for (settings::CpuList::const_iterator it = data.llCpus.begin();
8812 it != data.llCpus.end();
8813 ++it)
8814 {
8815 const settings::Cpu &cpu = *it;
8816
8817 mHWData->mCPUAttached[cpu.ulId] = true;
8818 }
8819 }
8820
8821 // cpuid leafs
8822 for (settings::CpuIdLeafsList::const_iterator it = data.llCpuIdLeafs.begin();
8823 it != data.llCpuIdLeafs.end();
8824 ++it)
8825 {
8826 const settings::CpuIdLeaf &leaf = *it;
8827
8828 switch (leaf.ulId)
8829 {
8830 case 0x0:
8831 case 0x1:
8832 case 0x2:
8833 case 0x3:
8834 case 0x4:
8835 case 0x5:
8836 case 0x6:
8837 case 0x7:
8838 case 0x8:
8839 case 0x9:
8840 case 0xA:
8841 mHWData->mCpuIdStdLeafs[leaf.ulId] = leaf;
8842 break;
8843
8844 case 0x80000000:
8845 case 0x80000001:
8846 case 0x80000002:
8847 case 0x80000003:
8848 case 0x80000004:
8849 case 0x80000005:
8850 case 0x80000006:
8851 case 0x80000007:
8852 case 0x80000008:
8853 case 0x80000009:
8854 case 0x8000000A:
8855 mHWData->mCpuIdExtLeafs[leaf.ulId - 0x80000000] = leaf;
8856 break;
8857
8858 default:
8859 /* just ignore */
8860 break;
8861 }
8862 }
8863
8864 mHWData->mMemorySize = data.ulMemorySizeMB;
8865 mHWData->mPageFusionEnabled = data.fPageFusionEnabled;
8866
8867 // boot order
8868 for (unsigned i = 0; i < RT_ELEMENTS(mHWData->mBootOrder); ++i)
8869 {
8870 settings::BootOrderMap::const_iterator it = data.mapBootOrder.find(i);
8871 if (it == data.mapBootOrder.end())
8872 mHWData->mBootOrder[i] = DeviceType_Null;
8873 else
8874 mHWData->mBootOrder[i] = it->second;
8875 }
8876
8877 mHWData->mGraphicsControllerType = data.graphicsControllerType;
8878 mHWData->mVRAMSize = data.ulVRAMSizeMB;
8879 mHWData->mMonitorCount = data.cMonitors;
8880 mHWData->mAccelerate3DEnabled = data.fAccelerate3D;
8881 mHWData->mAccelerate2DVideoEnabled = data.fAccelerate2DVideo;
8882 mHWData->mVideoCaptureWidth = data.ulVideoCaptureHorzRes;
8883 mHWData->mVideoCaptureHeight = data.ulVideoCaptureVertRes;
8884 mHWData->mVideoCaptureEnabled = data.fVideoCaptureEnabled;
8885 for (unsigned i = 0; i < RT_ELEMENTS(mHWData->maVideoCaptureScreens); ++i)
8886 mHWData->maVideoCaptureScreens[i] = ASMBitTest(&data.u64VideoCaptureScreens, i);
8887 AssertCompile(RT_ELEMENTS(mHWData->maVideoCaptureScreens) == sizeof(data.u64VideoCaptureScreens) * 8);
8888 mHWData->mVideoCaptureRate = data.ulVideoCaptureRate;
8889 mHWData->mVideoCaptureFPS = data.ulVideoCaptureFPS;
8890 if (!data.strVideoCaptureFile.isEmpty())
8891 i_calculateFullPath(data.strVideoCaptureFile, mHWData->mVideoCaptureFile);
8892 else
8893 mHWData->mVideoCaptureFile.setNull();
8894 mHWData->mFirmwareType = data.firmwareType;
8895 mHWData->mPointingHIDType = data.pointingHIDType;
8896 mHWData->mKeyboardHIDType = data.keyboardHIDType;
8897 mHWData->mChipsetType = data.chipsetType;
8898 mHWData->mParavirtProvider = data.paravirtProvider;
8899 mHWData->mEmulatedUSBCardReaderEnabled = data.fEmulatedUSBCardReader;
8900 mHWData->mHPETEnabled = data.fHPETEnabled;
8901
8902 /* VRDEServer */
8903 rc = mVRDEServer->i_loadSettings(data.vrdeSettings);
8904 if (FAILED(rc)) return rc;
8905
8906 /* BIOS */
8907 rc = mBIOSSettings->i_loadSettings(data.biosSettings);
8908 if (FAILED(rc)) return rc;
8909
8910 // Bandwidth control (must come before network adapters)
8911 rc = mBandwidthControl->i_loadSettings(data.ioSettings);
8912 if (FAILED(rc)) return rc;
8913
8914 /* Shared folders */
8915 for (settings::USBControllerList::const_iterator it = data.usbSettings.llUSBControllers.begin();
8916 it != data.usbSettings.llUSBControllers.end();
8917 ++it)
8918 {
8919 const settings::USBController &settingsCtrl = *it;
8920 ComObjPtr<USBController> newCtrl;
8921
8922 newCtrl.createObject();
8923 newCtrl->init(this, settingsCtrl.strName, settingsCtrl.enmType);
8924 mUSBControllers->push_back(newCtrl);
8925 }
8926
8927 /* USB device filters */
8928 rc = mUSBDeviceFilters->i_loadSettings(data.usbSettings);
8929 if (FAILED(rc)) return rc;
8930
8931 // network adapters
8932 size_t newCount = Global::getMaxNetworkAdapters(mHWData->mChipsetType);
8933 size_t oldCount = mNetworkAdapters.size();
8934 if (newCount > oldCount)
8935 {
8936 mNetworkAdapters.resize(newCount);
8937 for (size_t slot = oldCount; slot < mNetworkAdapters.size(); ++slot)
8938 {
8939 unconst(mNetworkAdapters[slot]).createObject();
8940 mNetworkAdapters[slot]->init(this, (ULONG)slot);
8941 }
8942 }
8943 else if (newCount < oldCount)
8944 mNetworkAdapters.resize(newCount);
8945 for (settings::NetworkAdaptersList::const_iterator it = data.llNetworkAdapters.begin();
8946 it != data.llNetworkAdapters.end();
8947 ++it)
8948 {
8949 const settings::NetworkAdapter &nic = *it;
8950
8951 /* slot unicity is guaranteed by XML Schema */
8952 AssertBreak(nic.ulSlot < mNetworkAdapters.size());
8953 rc = mNetworkAdapters[nic.ulSlot]->i_loadSettings(mBandwidthControl, nic);
8954 if (FAILED(rc)) return rc;
8955 }
8956
8957 // serial ports
8958 for (settings::SerialPortsList::const_iterator it = data.llSerialPorts.begin();
8959 it != data.llSerialPorts.end();
8960 ++it)
8961 {
8962 const settings::SerialPort &s = *it;
8963
8964 AssertBreak(s.ulSlot < RT_ELEMENTS(mSerialPorts));
8965 rc = mSerialPorts[s.ulSlot]->i_loadSettings(s);
8966 if (FAILED(rc)) return rc;
8967 }
8968
8969 // parallel ports (optional)
8970 for (settings::ParallelPortsList::const_iterator it = data.llParallelPorts.begin();
8971 it != data.llParallelPorts.end();
8972 ++it)
8973 {
8974 const settings::ParallelPort &p = *it;
8975
8976 AssertBreak(p.ulSlot < RT_ELEMENTS(mParallelPorts));
8977 rc = mParallelPorts[p.ulSlot]->i_loadSettings(p);
8978 if (FAILED(rc)) return rc;
8979 }
8980
8981 /* AudioAdapter */
8982 rc = mAudioAdapter->i_loadSettings(data.audioAdapter);
8983 if (FAILED(rc)) return rc;
8984
8985 /* Shared folders */
8986 for (settings::SharedFoldersList::const_iterator it = data.llSharedFolders.begin();
8987 it != data.llSharedFolders.end();
8988 ++it)
8989 {
8990 const settings::SharedFolder &sf = *it;
8991
8992 ComObjPtr<SharedFolder> sharedFolder;
8993 /* Check for double entries. Not allowed! */
8994 rc = i_findSharedFolder(sf.strName, sharedFolder, false /* aSetError */);
8995 if (SUCCEEDED(rc))
8996 return setError(VBOX_E_OBJECT_IN_USE,
8997 tr("Shared folder named '%s' already exists"),
8998 sf.strName.c_str());
8999
9000 /* Create the new shared folder. Don't break on error. This will be
9001 * reported when the machine starts. */
9002 sharedFolder.createObject();
9003 rc = sharedFolder->init(i_getMachine(),
9004 sf.strName,
9005 sf.strHostPath,
9006 RT_BOOL(sf.fWritable),
9007 RT_BOOL(sf.fAutoMount),
9008 false /* fFailOnError */);
9009 if (FAILED(rc)) return rc;
9010 mHWData->mSharedFolders.push_back(sharedFolder);
9011 }
9012
9013 // Clipboard
9014 mHWData->mClipboardMode = data.clipboardMode;
9015
9016 // drag'n'drop
9017 mHWData->mDnDMode = data.dndMode;
9018
9019 // guest settings
9020 mHWData->mMemoryBalloonSize = data.ulMemoryBalloonSize;
9021
9022 // IO settings
9023 mHWData->mIOCacheEnabled = data.ioSettings.fIOCacheEnabled;
9024 mHWData->mIOCacheSize = data.ioSettings.ulIOCacheSize;
9025
9026 // Host PCI devices
9027 for (settings::HostPCIDeviceAttachmentList::const_iterator it = data.pciAttachments.begin();
9028 it != data.pciAttachments.end();
9029 ++it)
9030 {
9031 const settings::HostPCIDeviceAttachment &hpda = *it;
9032 ComObjPtr<PCIDeviceAttachment> pda;
9033
9034 pda.createObject();
9035 pda->i_loadSettings(this, hpda);
9036 mHWData->mPCIDeviceAssignments.push_back(pda);
9037 }
9038
9039 /*
9040 * (The following isn't really real hardware, but it lives in HWData
9041 * for reasons of convenience.)
9042 */
9043
9044#ifdef VBOX_WITH_GUEST_PROPS
9045 /* Guest properties (optional) */
9046
9047 /* Only load transient guest properties for configs which have saved
9048 * state, because there shouldn't be any for powered off VMs. The same
9049 * logic applies for snapshots, as offline snapshots shouldn't have
9050 * any such properties. They confuse the code in various places.
9051 * Note: can't rely on the machine state, as it isn't set yet. */
9052 bool fSkipTransientGuestProperties = mSSData->strStateFilePath.isEmpty();
9053 /* apologies for the hacky unconst() usage, but this needs hacking
9054 * actually inconsistent settings into consistency, otherwise there
9055 * will be some corner cases where the inconsistency survives
9056 * surprisingly long without getting fixed, especially for snapshots
9057 * as there are no config changes. */
9058 settings::GuestPropertiesList &llGuestProperties = unconst(data.llGuestProperties);
9059 for (settings::GuestPropertiesList::iterator it = llGuestProperties.begin();
9060 it != llGuestProperties.end();
9061 /*nothing*/)
9062 {
9063 const settings::GuestProperty &prop = *it;
9064 uint32_t fFlags = guestProp::NILFLAG;
9065 guestProp::validateFlags(prop.strFlags.c_str(), &fFlags);
9066 if ( fSkipTransientGuestProperties
9067 && ( fFlags & guestProp::TRANSIENT
9068 || fFlags & guestProp::TRANSRESET))
9069 {
9070 it = llGuestProperties.erase(it);
9071 continue;
9072 }
9073 HWData::GuestProperty property = { prop.strValue, (LONG64) prop.timestamp, fFlags };
9074 mHWData->mGuestProperties[prop.strName] = property;
9075 ++it;
9076 }
9077#endif /* VBOX_WITH_GUEST_PROPS defined */
9078
9079 rc = i_loadDebugging(pDbg);
9080 if (FAILED(rc))
9081 return rc;
9082
9083 mHWData->mAutostart = *pAutostart;
9084
9085 /* default frontend */
9086 mHWData->mDefaultFrontend = data.strDefaultFrontend;
9087 }
9088 catch(std::bad_alloc &)
9089 {
9090 return E_OUTOFMEMORY;
9091 }
9092
9093 AssertComRC(rc);
9094 return rc;
9095}
9096
9097/**
9098 * Called from Machine::loadHardware() to load the debugging settings of the
9099 * machine.
9100 *
9101 * @param pDbg Pointer to the settings.
9102 */
9103HRESULT Machine::i_loadDebugging(const settings::Debugging *pDbg)
9104{
9105 mHWData->mDebugging = *pDbg;
9106 /* no more processing currently required, this will probably change. */
9107 return S_OK;
9108}
9109
9110/**
9111 * Called from i_loadMachineDataFromSettings() for the storage controller data, including media.
9112 *
9113 * @param data
9114 * @param puuidRegistry media registry ID to set media to or NULL; see Machine::i_loadMachineDataFromSettings()
9115 * @param puuidSnapshot
9116 * @return
9117 */
9118HRESULT Machine::i_loadStorageControllers(const settings::Storage &data,
9119 const Guid *puuidRegistry,
9120 const Guid *puuidSnapshot)
9121{
9122 AssertReturn(!i_isSessionMachine(), E_FAIL);
9123
9124 HRESULT rc = S_OK;
9125
9126 for (settings::StorageControllersList::const_iterator it = data.llStorageControllers.begin();
9127 it != data.llStorageControllers.end();
9128 ++it)
9129 {
9130 const settings::StorageController &ctlData = *it;
9131
9132 ComObjPtr<StorageController> pCtl;
9133 /* Try to find one with the name first. */
9134 rc = i_getStorageControllerByName(ctlData.strName, pCtl, false /* aSetError */);
9135 if (SUCCEEDED(rc))
9136 return setError(VBOX_E_OBJECT_IN_USE,
9137 tr("Storage controller named '%s' already exists"),
9138 ctlData.strName.c_str());
9139
9140 pCtl.createObject();
9141 rc = pCtl->init(this,
9142 ctlData.strName,
9143 ctlData.storageBus,
9144 ctlData.ulInstance,
9145 ctlData.fBootable);
9146 if (FAILED(rc)) return rc;
9147
9148 mStorageControllers->push_back(pCtl);
9149
9150 rc = pCtl->COMSETTER(ControllerType)(ctlData.controllerType);
9151 if (FAILED(rc)) return rc;
9152
9153 rc = pCtl->COMSETTER(PortCount)(ctlData.ulPortCount);
9154 if (FAILED(rc)) return rc;
9155
9156 rc = pCtl->COMSETTER(UseHostIOCache)(ctlData.fUseHostIOCache);
9157 if (FAILED(rc)) return rc;
9158
9159 /* Load the attached devices now. */
9160 rc = i_loadStorageDevices(pCtl,
9161 ctlData,
9162 puuidRegistry,
9163 puuidSnapshot);
9164 if (FAILED(rc)) return rc;
9165 }
9166
9167 return S_OK;
9168}
9169
9170/**
9171 * Called from i_loadStorageControllers for a controller's devices.
9172 *
9173 * @param aStorageController
9174 * @param data
9175 * @param puuidRegistry media registry ID to set media to or NULL; see Machine::i_loadMachineDataFromSettings()
9176 * @param aSnapshotId pointer to the snapshot ID if this is a snapshot machine
9177 * @return
9178 */
9179HRESULT Machine::i_loadStorageDevices(StorageController *aStorageController,
9180 const settings::StorageController &data,
9181 const Guid *puuidRegistry,
9182 const Guid *puuidSnapshot)
9183{
9184 HRESULT rc = S_OK;
9185
9186 /* paranoia: detect duplicate attachments */
9187 for (settings::AttachedDevicesList::const_iterator it = data.llAttachedDevices.begin();
9188 it != data.llAttachedDevices.end();
9189 ++it)
9190 {
9191 const settings::AttachedDevice &ad = *it;
9192
9193 for (settings::AttachedDevicesList::const_iterator it2 = it;
9194 it2 != data.llAttachedDevices.end();
9195 ++it2)
9196 {
9197 if (it == it2)
9198 continue;
9199
9200 const settings::AttachedDevice &ad2 = *it2;
9201
9202 if ( ad.lPort == ad2.lPort
9203 && ad.lDevice == ad2.lDevice)
9204 {
9205 return setError(E_FAIL,
9206 tr("Duplicate attachments for storage controller '%s', port %d, device %d of the virtual machine '%s'"),
9207 aStorageController->i_getName().c_str(),
9208 ad.lPort,
9209 ad.lDevice,
9210 mUserData->s.strName.c_str());
9211 }
9212 }
9213 }
9214
9215 for (settings::AttachedDevicesList::const_iterator it = data.llAttachedDevices.begin();
9216 it != data.llAttachedDevices.end();
9217 ++it)
9218 {
9219 const settings::AttachedDevice &dev = *it;
9220 ComObjPtr<Medium> medium;
9221
9222 switch (dev.deviceType)
9223 {
9224 case DeviceType_Floppy:
9225 case DeviceType_DVD:
9226 if (dev.strHostDriveSrc.isNotEmpty())
9227 rc = mParent->i_host()->i_findHostDriveByName(dev.deviceType, dev.strHostDriveSrc,
9228 false /* fRefresh */, medium);
9229 else
9230 rc = mParent->i_findRemoveableMedium(dev.deviceType,
9231 dev.uuid,
9232 false /* fRefresh */,
9233 false /* aSetError */,
9234 medium);
9235 if (rc == VBOX_E_OBJECT_NOT_FOUND)
9236 // This is not an error. The host drive or UUID might have vanished, so just go
9237 // ahead without this removeable medium attachment
9238 rc = S_OK;
9239 break;
9240
9241 case DeviceType_HardDisk:
9242 {
9243 /* find a hard disk by UUID */
9244 rc = mParent->i_findHardDiskById(dev.uuid, true /* aDoSetError */, &medium);
9245 if (FAILED(rc))
9246 {
9247 if (i_isSnapshotMachine())
9248 {
9249 // wrap another error message around the "cannot find hard disk" set by findHardDisk
9250 // so the user knows that the bad disk is in a snapshot somewhere
9251 com::ErrorInfo info;
9252 return setError(E_FAIL,
9253 tr("A differencing image of snapshot {%RTuuid} could not be found. %ls"),
9254 puuidSnapshot->raw(),
9255 info.getText().raw());
9256 }
9257 else
9258 return rc;
9259 }
9260
9261 AutoWriteLock hdLock(medium COMMA_LOCKVAL_SRC_POS);
9262
9263 if (medium->i_getType() == MediumType_Immutable)
9264 {
9265 if (i_isSnapshotMachine())
9266 return setError(E_FAIL,
9267 tr("Immutable hard disk '%s' with UUID {%RTuuid} cannot be directly attached to snapshot with UUID {%RTuuid} "
9268 "of the virtual machine '%s' ('%s')"),
9269 medium->i_getLocationFull().c_str(),
9270 dev.uuid.raw(),
9271 puuidSnapshot->raw(),
9272 mUserData->s.strName.c_str(),
9273 mData->m_strConfigFileFull.c_str());
9274
9275 return setError(E_FAIL,
9276 tr("Immutable hard disk '%s' with UUID {%RTuuid} cannot be directly attached to the virtual machine '%s' ('%s')"),
9277 medium->i_getLocationFull().c_str(),
9278 dev.uuid.raw(),
9279 mUserData->s.strName.c_str(),
9280 mData->m_strConfigFileFull.c_str());
9281 }
9282
9283 if (medium->i_getType() == MediumType_MultiAttach)
9284 {
9285 if (i_isSnapshotMachine())
9286 return setError(E_FAIL,
9287 tr("Multi-attach hard disk '%s' with UUID {%RTuuid} cannot be directly attached to snapshot with UUID {%RTuuid} "
9288 "of the virtual machine '%s' ('%s')"),
9289 medium->i_getLocationFull().c_str(),
9290 dev.uuid.raw(),
9291 puuidSnapshot->raw(),
9292 mUserData->s.strName.c_str(),
9293 mData->m_strConfigFileFull.c_str());
9294
9295 return setError(E_FAIL,
9296 tr("Multi-attach hard disk '%s' with UUID {%RTuuid} cannot be directly attached to the virtual machine '%s' ('%s')"),
9297 medium->i_getLocationFull().c_str(),
9298 dev.uuid.raw(),
9299 mUserData->s.strName.c_str(),
9300 mData->m_strConfigFileFull.c_str());
9301 }
9302
9303 if ( !i_isSnapshotMachine()
9304 && medium->i_getChildren().size() != 0
9305 )
9306 return setError(E_FAIL,
9307 tr("Hard disk '%s' with UUID {%RTuuid} cannot be directly attached to the virtual machine '%s' ('%s') "
9308 "because it has %d differencing child hard disks"),
9309 medium->i_getLocationFull().c_str(),
9310 dev.uuid.raw(),
9311 mUserData->s.strName.c_str(),
9312 mData->m_strConfigFileFull.c_str(),
9313 medium->i_getChildren().size());
9314
9315 if (i_findAttachment(mMediaData->mAttachments,
9316 medium))
9317 return setError(E_FAIL,
9318 tr("Hard disk '%s' with UUID {%RTuuid} is already attached to the virtual machine '%s' ('%s')"),
9319 medium->i_getLocationFull().c_str(),
9320 dev.uuid.raw(),
9321 mUserData->s.strName.c_str(),
9322 mData->m_strConfigFileFull.c_str());
9323
9324 break;
9325 }
9326
9327 default:
9328 return setError(E_FAIL,
9329 tr("Device '%s' with unknown type is attached to the virtual machine '%s' ('%s')"),
9330 medium->i_getLocationFull().c_str(),
9331 mUserData->s.strName.c_str(),
9332 mData->m_strConfigFileFull.c_str());
9333 }
9334
9335 if (FAILED(rc))
9336 break;
9337
9338 /* Bandwidth groups are loaded at this point. */
9339 ComObjPtr<BandwidthGroup> pBwGroup;
9340
9341 if (!dev.strBwGroup.isEmpty())
9342 {
9343 rc = mBandwidthControl->i_getBandwidthGroupByName(dev.strBwGroup, pBwGroup, false /* aSetError */);
9344 if (FAILED(rc))
9345 return setError(E_FAIL,
9346 tr("Device '%s' with unknown bandwidth group '%s' is attached to the virtual machine '%s' ('%s')"),
9347 medium->i_getLocationFull().c_str(),
9348 dev.strBwGroup.c_str(),
9349 mUserData->s.strName.c_str(),
9350 mData->m_strConfigFileFull.c_str());
9351 pBwGroup->i_reference();
9352 }
9353
9354 const Bstr controllerName = aStorageController->i_getName();
9355 ComObjPtr<MediumAttachment> pAttachment;
9356 pAttachment.createObject();
9357 rc = pAttachment->init(this,
9358 medium,
9359 controllerName,
9360 dev.lPort,
9361 dev.lDevice,
9362 dev.deviceType,
9363 false,
9364 dev.fPassThrough,
9365 dev.fTempEject,
9366 dev.fNonRotational,
9367 dev.fDiscard,
9368 dev.fHotPluggable,
9369 pBwGroup.isNull() ? Utf8Str::Empty : pBwGroup->i_getName());
9370 if (FAILED(rc)) break;
9371
9372 /* associate the medium with this machine and snapshot */
9373 if (!medium.isNull())
9374 {
9375 AutoCaller medCaller(medium);
9376 if (FAILED(medCaller.rc())) return medCaller.rc();
9377 AutoWriteLock mlock(medium COMMA_LOCKVAL_SRC_POS);
9378
9379 if (i_isSnapshotMachine())
9380 rc = medium->i_addBackReference(mData->mUuid, *puuidSnapshot);
9381 else
9382 rc = medium->i_addBackReference(mData->mUuid);
9383 /* If the medium->addBackReference fails it sets an appropriate
9384 * error message, so no need to do any guesswork here. */
9385
9386 if (puuidRegistry)
9387 // caller wants registry ID to be set on all attached media (OVF import case)
9388 medium->i_addRegistry(*puuidRegistry);
9389 }
9390
9391 if (FAILED(rc))
9392 break;
9393
9394 /* back up mMediaData to let registeredInit() properly rollback on failure
9395 * (= limited accessibility) */
9396 i_setModified(IsModified_Storage);
9397 mMediaData.backup();
9398 mMediaData->mAttachments.push_back(pAttachment);
9399 }
9400
9401 return rc;
9402}
9403
9404/**
9405 * Returns the snapshot with the given UUID or fails of no such snapshot exists.
9406 *
9407 * @param aId snapshot UUID to find (empty UUID refers the first snapshot)
9408 * @param aSnapshot where to return the found snapshot
9409 * @param aSetError true to set extended error info on failure
9410 */
9411HRESULT Machine::i_findSnapshotById(const Guid &aId,
9412 ComObjPtr<Snapshot> &aSnapshot,
9413 bool aSetError /* = false */)
9414{
9415 AutoReadLock chlock(this COMMA_LOCKVAL_SRC_POS);
9416
9417 if (!mData->mFirstSnapshot)
9418 {
9419 if (aSetError)
9420 return setError(E_FAIL, tr("This machine does not have any snapshots"));
9421 return E_FAIL;
9422 }
9423
9424 if (aId.isZero())
9425 aSnapshot = mData->mFirstSnapshot;
9426 else
9427 aSnapshot = mData->mFirstSnapshot->i_findChildOrSelf(aId.ref());
9428
9429 if (!aSnapshot)
9430 {
9431 if (aSetError)
9432 return setError(E_FAIL,
9433 tr("Could not find a snapshot with UUID {%s}"),
9434 aId.toString().c_str());
9435 return E_FAIL;
9436 }
9437
9438 return S_OK;
9439}
9440
9441/**
9442 * Returns the snapshot with the given name or fails of no such snapshot.
9443 *
9444 * @param aName snapshot name to find
9445 * @param aSnapshot where to return the found snapshot
9446 * @param aSetError true to set extended error info on failure
9447 */
9448HRESULT Machine::i_findSnapshotByName(const Utf8Str &strName,
9449 ComObjPtr<Snapshot> &aSnapshot,
9450 bool aSetError /* = false */)
9451{
9452 AssertReturn(!strName.isEmpty(), E_INVALIDARG);
9453
9454 AutoReadLock chlock(this COMMA_LOCKVAL_SRC_POS);
9455
9456 if (!mData->mFirstSnapshot)
9457 {
9458 if (aSetError)
9459 return setError(VBOX_E_OBJECT_NOT_FOUND,
9460 tr("This machine does not have any snapshots"));
9461 return VBOX_E_OBJECT_NOT_FOUND;
9462 }
9463
9464 aSnapshot = mData->mFirstSnapshot->i_findChildOrSelf(strName);
9465
9466 if (!aSnapshot)
9467 {
9468 if (aSetError)
9469 return setError(VBOX_E_OBJECT_NOT_FOUND,
9470 tr("Could not find a snapshot named '%s'"), strName.c_str());
9471 return VBOX_E_OBJECT_NOT_FOUND;
9472 }
9473
9474 return S_OK;
9475}
9476
9477/**
9478 * Returns a storage controller object with the given name.
9479 *
9480 * @param aName storage controller name to find
9481 * @param aStorageController where to return the found storage controller
9482 * @param aSetError true to set extended error info on failure
9483 */
9484HRESULT Machine::i_getStorageControllerByName(const Utf8Str &aName,
9485 ComObjPtr<StorageController> &aStorageController,
9486 bool aSetError /* = false */)
9487{
9488 AssertReturn(!aName.isEmpty(), E_INVALIDARG);
9489
9490 for (StorageControllerList::const_iterator it = mStorageControllers->begin();
9491 it != mStorageControllers->end();
9492 ++it)
9493 {
9494 if ((*it)->i_getName() == aName)
9495 {
9496 aStorageController = (*it);
9497 return S_OK;
9498 }
9499 }
9500
9501 if (aSetError)
9502 return setError(VBOX_E_OBJECT_NOT_FOUND,
9503 tr("Could not find a storage controller named '%s'"),
9504 aName.c_str());
9505 return VBOX_E_OBJECT_NOT_FOUND;
9506}
9507
9508/**
9509 * Returns a USB controller object with the given name.
9510 *
9511 * @param aName USB controller name to find
9512 * @param aUSBController where to return the found USB controller
9513 * @param aSetError true to set extended error info on failure
9514 */
9515HRESULT Machine::i_getUSBControllerByName(const Utf8Str &aName,
9516 ComObjPtr<USBController> &aUSBController,
9517 bool aSetError /* = false */)
9518{
9519 AssertReturn(!aName.isEmpty(), E_INVALIDARG);
9520
9521 for (USBControllerList::const_iterator it = mUSBControllers->begin();
9522 it != mUSBControllers->end();
9523 ++it)
9524 {
9525 if ((*it)->i_getName() == aName)
9526 {
9527 aUSBController = (*it);
9528 return S_OK;
9529 }
9530 }
9531
9532 if (aSetError)
9533 return setError(VBOX_E_OBJECT_NOT_FOUND,
9534 tr("Could not find a storage controller named '%s'"),
9535 aName.c_str());
9536 return VBOX_E_OBJECT_NOT_FOUND;
9537}
9538
9539/**
9540 * Returns the number of USB controller instance of the given type.
9541 *
9542 * @param enmType USB controller type.
9543 */
9544ULONG Machine::i_getUSBControllerCountByType(USBControllerType_T enmType)
9545{
9546 ULONG cCtrls = 0;
9547
9548 for (USBControllerList::const_iterator it = mUSBControllers->begin();
9549 it != mUSBControllers->end();
9550 ++it)
9551 {
9552 if ((*it)->i_getControllerType() == enmType)
9553 cCtrls++;
9554 }
9555
9556 return cCtrls;
9557}
9558
9559HRESULT Machine::i_getMediumAttachmentsOfController(const Utf8Str &aName,
9560 MediaData::AttachmentList &atts)
9561{
9562 AutoCaller autoCaller(this);
9563 if (FAILED(autoCaller.rc())) return autoCaller.rc();
9564
9565 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
9566
9567 for (MediaData::AttachmentList::iterator it = mMediaData->mAttachments.begin();
9568 it != mMediaData->mAttachments.end();
9569 ++it)
9570 {
9571 const ComObjPtr<MediumAttachment> &pAtt = *it;
9572 // should never happen, but deal with NULL pointers in the list.
9573 AssertStmt(!pAtt.isNull(), continue);
9574
9575 // getControllerName() needs caller+read lock
9576 AutoCaller autoAttCaller(pAtt);
9577 if (FAILED(autoAttCaller.rc()))
9578 {
9579 atts.clear();
9580 return autoAttCaller.rc();
9581 }
9582 AutoReadLock attLock(pAtt COMMA_LOCKVAL_SRC_POS);
9583
9584 if (pAtt->i_getControllerName() == aName)
9585 atts.push_back(pAtt);
9586 }
9587
9588 return S_OK;
9589}
9590
9591
9592/**
9593 * Helper for #i_saveSettings. Cares about renaming the settings directory and
9594 * file if the machine name was changed and about creating a new settings file
9595 * if this is a new machine.
9596 *
9597 * @note Must be never called directly but only from #saveSettings().
9598 */
9599HRESULT Machine::i_prepareSaveSettings(bool *pfNeedsGlobalSaveSettings)
9600{
9601 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
9602
9603 HRESULT rc = S_OK;
9604
9605 bool fSettingsFileIsNew = !mData->pMachineConfigFile->fileExists();
9606
9607 /// @todo need to handle primary group change, too
9608
9609 /* attempt to rename the settings file if machine name is changed */
9610 if ( mUserData->s.fNameSync
9611 && mUserData.isBackedUp()
9612 && ( mUserData.backedUpData()->s.strName != mUserData->s.strName
9613 || mUserData.backedUpData()->s.llGroups.front() != mUserData->s.llGroups.front())
9614 )
9615 {
9616 bool dirRenamed = false;
9617 bool fileRenamed = false;
9618
9619 Utf8Str configFile, newConfigFile;
9620 Utf8Str configFilePrev, newConfigFilePrev;
9621 Utf8Str configDir, newConfigDir;
9622
9623 do
9624 {
9625 int vrc = VINF_SUCCESS;
9626
9627 Utf8Str name = mUserData.backedUpData()->s.strName;
9628 Utf8Str newName = mUserData->s.strName;
9629 Utf8Str group = mUserData.backedUpData()->s.llGroups.front();
9630 if (group == "/")
9631 group.setNull();
9632 Utf8Str newGroup = mUserData->s.llGroups.front();
9633 if (newGroup == "/")
9634 newGroup.setNull();
9635
9636 configFile = mData->m_strConfigFileFull;
9637
9638 /* first, rename the directory if it matches the group and machine name */
9639 Utf8Str groupPlusName = Utf8StrFmt("%s%c%s",
9640 group.c_str(), RTPATH_DELIMITER, name.c_str());
9641 /** @todo hack, make somehow use of ComposeMachineFilename */
9642 if (mUserData->s.fDirectoryIncludesUUID)
9643 groupPlusName += Utf8StrFmt(" (%RTuuid)", mData->mUuid.raw());
9644 Utf8Str newGroupPlusName = Utf8StrFmt("%s%c%s",
9645 newGroup.c_str(), RTPATH_DELIMITER, newName.c_str());
9646 /** @todo hack, make somehow use of ComposeMachineFilename */
9647 if (mUserData->s.fDirectoryIncludesUUID)
9648 newGroupPlusName += Utf8StrFmt(" (%RTuuid)", mData->mUuid.raw());
9649 configDir = configFile;
9650 configDir.stripFilename();
9651 newConfigDir = configDir;
9652 if ( configDir.length() >= groupPlusName.length()
9653 && !RTPathCompare(configDir.substr(configDir.length() - groupPlusName.length(), groupPlusName.length()).c_str(),
9654 groupPlusName.c_str()))
9655 {
9656 newConfigDir = newConfigDir.substr(0, configDir.length() - groupPlusName.length());
9657 Utf8Str newConfigBaseDir(newConfigDir);
9658 newConfigDir.append(newGroupPlusName);
9659 /* consistency: use \ if appropriate on the platform */
9660 RTPathChangeToDosSlashes(newConfigDir.mutableRaw(), false);
9661 /* new dir and old dir cannot be equal here because of 'if'
9662 * above and because name != newName */
9663 Assert(configDir != newConfigDir);
9664 if (!fSettingsFileIsNew)
9665 {
9666 /* perform real rename only if the machine is not new */
9667 vrc = RTPathRename(configDir.c_str(), newConfigDir.c_str(), 0);
9668 if ( vrc == VERR_FILE_NOT_FOUND
9669 || vrc == VERR_PATH_NOT_FOUND)
9670 {
9671 /* create the parent directory, then retry renaming */
9672 Utf8Str parent(newConfigDir);
9673 parent.stripFilename();
9674 (void)RTDirCreateFullPath(parent.c_str(), 0700);
9675 vrc = RTPathRename(configDir.c_str(), newConfigDir.c_str(), 0);
9676 }
9677 if (RT_FAILURE(vrc))
9678 {
9679 rc = setError(E_FAIL,
9680 tr("Could not rename the directory '%s' to '%s' to save the settings file (%Rrc)"),
9681 configDir.c_str(),
9682 newConfigDir.c_str(),
9683 vrc);
9684 break;
9685 }
9686 /* delete subdirectories which are no longer needed */
9687 Utf8Str dir(configDir);
9688 dir.stripFilename();
9689 while (dir != newConfigBaseDir && dir != ".")
9690 {
9691 vrc = RTDirRemove(dir.c_str());
9692 if (RT_FAILURE(vrc))
9693 break;
9694 dir.stripFilename();
9695 }
9696 dirRenamed = true;
9697 }
9698 }
9699
9700 newConfigFile = Utf8StrFmt("%s%c%s.vbox",
9701 newConfigDir.c_str(), RTPATH_DELIMITER, newName.c_str());
9702
9703 /* then try to rename the settings file itself */
9704 if (newConfigFile != configFile)
9705 {
9706 /* get the path to old settings file in renamed directory */
9707 configFile = Utf8StrFmt("%s%c%s",
9708 newConfigDir.c_str(),
9709 RTPATH_DELIMITER,
9710 RTPathFilename(configFile.c_str()));
9711 if (!fSettingsFileIsNew)
9712 {
9713 /* perform real rename only if the machine is not new */
9714 vrc = RTFileRename(configFile.c_str(), newConfigFile.c_str(), 0);
9715 if (RT_FAILURE(vrc))
9716 {
9717 rc = setError(E_FAIL,
9718 tr("Could not rename the settings file '%s' to '%s' (%Rrc)"),
9719 configFile.c_str(),
9720 newConfigFile.c_str(),
9721 vrc);
9722 break;
9723 }
9724 fileRenamed = true;
9725 configFilePrev = configFile;
9726 configFilePrev += "-prev";
9727 newConfigFilePrev = newConfigFile;
9728 newConfigFilePrev += "-prev";
9729 RTFileRename(configFilePrev.c_str(), newConfigFilePrev.c_str(), 0);
9730 }
9731 }
9732
9733 // update m_strConfigFileFull amd mConfigFile
9734 mData->m_strConfigFileFull = newConfigFile;
9735 // compute the relative path too
9736 mParent->i_copyPathRelativeToConfig(newConfigFile, mData->m_strConfigFile);
9737
9738 // store the old and new so that VirtualBox::i_saveSettings() can update
9739 // the media registry
9740 if ( mData->mRegistered
9741 && (configDir != newConfigDir || configFile != newConfigFile))
9742 {
9743 mParent->i_rememberMachineNameChangeForMedia(configDir, newConfigDir);
9744
9745 if (pfNeedsGlobalSaveSettings)
9746 *pfNeedsGlobalSaveSettings = true;
9747 }
9748
9749 // in the saved state file path, replace the old directory with the new directory
9750 if (RTPathStartsWith(mSSData->strStateFilePath.c_str(), configDir.c_str()))
9751 mSSData->strStateFilePath = newConfigDir.append(mSSData->strStateFilePath.c_str() + configDir.length());
9752
9753 // and do the same thing for the saved state file paths of all the online snapshots
9754 if (mData->mFirstSnapshot)
9755 mData->mFirstSnapshot->i_updateSavedStatePaths(configDir.c_str(),
9756 newConfigDir.c_str());
9757 }
9758 while (0);
9759
9760 if (FAILED(rc))
9761 {
9762 /* silently try to rename everything back */
9763 if (fileRenamed)
9764 {
9765 RTFileRename(newConfigFilePrev.c_str(), configFilePrev.c_str(), 0);
9766 RTFileRename(newConfigFile.c_str(), configFile.c_str(), 0);
9767 }
9768 if (dirRenamed)
9769 RTPathRename(newConfigDir.c_str(), configDir.c_str(), 0);
9770 }
9771
9772 if (FAILED(rc)) return rc;
9773 }
9774
9775 if (fSettingsFileIsNew)
9776 {
9777 /* create a virgin config file */
9778 int vrc = VINF_SUCCESS;
9779
9780 /* ensure the settings directory exists */
9781 Utf8Str path(mData->m_strConfigFileFull);
9782 path.stripFilename();
9783 if (!RTDirExists(path.c_str()))
9784 {
9785 vrc = RTDirCreateFullPath(path.c_str(), 0700);
9786 if (RT_FAILURE(vrc))
9787 {
9788 return setError(E_FAIL,
9789 tr("Could not create a directory '%s' to save the settings file (%Rrc)"),
9790 path.c_str(),
9791 vrc);
9792 }
9793 }
9794
9795 /* Note: open flags must correlate with RTFileOpen() in lockConfig() */
9796 path = Utf8Str(mData->m_strConfigFileFull);
9797 RTFILE f = NIL_RTFILE;
9798 vrc = RTFileOpen(&f, path.c_str(),
9799 RTFILE_O_READWRITE | RTFILE_O_CREATE | RTFILE_O_DENY_WRITE);
9800 if (RT_FAILURE(vrc))
9801 return setError(E_FAIL,
9802 tr("Could not create the settings file '%s' (%Rrc)"),
9803 path.c_str(),
9804 vrc);
9805 RTFileClose(f);
9806 }
9807
9808 return rc;
9809}
9810
9811/**
9812 * Saves and commits machine data, user data and hardware data.
9813 *
9814 * Note that on failure, the data remains uncommitted.
9815 *
9816 * @a aFlags may combine the following flags:
9817 *
9818 * - SaveS_ResetCurStateModified: Resets mData->mCurrentStateModified to FALSE.
9819 * Used when saving settings after an operation that makes them 100%
9820 * correspond to the settings from the current snapshot.
9821 * - SaveS_InformCallbacksAnyway: Callbacks will be informed even if
9822 * #isReallyModified() returns false. This is necessary for cases when we
9823 * change machine data directly, not through the backup()/commit() mechanism.
9824 * - SaveS_Force: settings will be saved without doing a deep compare of the
9825 * settings structures. This is used when this is called because snapshots
9826 * have changed to avoid the overhead of the deep compare.
9827 *
9828 * @note Must be called from under this object's write lock. Locks children for
9829 * writing.
9830 *
9831 * @param pfNeedsGlobalSaveSettings Optional pointer to a bool that must have been
9832 * initialized to false and that will be set to true by this function if
9833 * the caller must invoke VirtualBox::i_saveSettings() because the global
9834 * settings have changed. This will happen if a machine rename has been
9835 * saved and the global machine and media registries will therefore need
9836 * updating.
9837 */
9838HRESULT Machine::i_saveSettings(bool *pfNeedsGlobalSaveSettings,
9839 int aFlags /*= 0*/)
9840{
9841 LogFlowThisFuncEnter();
9842
9843 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
9844
9845 /* make sure child objects are unable to modify the settings while we are
9846 * saving them */
9847 i_ensureNoStateDependencies();
9848
9849 AssertReturn(!i_isSnapshotMachine(),
9850 E_FAIL);
9851
9852 HRESULT rc = S_OK;
9853 bool fNeedsWrite = false;
9854
9855 /* First, prepare to save settings. It will care about renaming the
9856 * settings directory and file if the machine name was changed and about
9857 * creating a new settings file if this is a new machine. */
9858 rc = i_prepareSaveSettings(pfNeedsGlobalSaveSettings);
9859 if (FAILED(rc)) return rc;
9860
9861 // keep a pointer to the current settings structures
9862 settings::MachineConfigFile *pOldConfig = mData->pMachineConfigFile;
9863 settings::MachineConfigFile *pNewConfig = NULL;
9864
9865 try
9866 {
9867 // make a fresh one to have everyone write stuff into
9868 pNewConfig = new settings::MachineConfigFile(NULL);
9869 pNewConfig->copyBaseFrom(*mData->pMachineConfigFile);
9870
9871 // now go and copy all the settings data from COM to the settings structures
9872 // (this calles i_saveSettings() on all the COM objects in the machine)
9873 i_copyMachineDataToSettings(*pNewConfig);
9874
9875 if (aFlags & SaveS_ResetCurStateModified)
9876 {
9877 // this gets set by takeSnapshot() (if offline snapshot) and restoreSnapshot()
9878 mData->mCurrentStateModified = FALSE;
9879 fNeedsWrite = true; // always, no need to compare
9880 }
9881 else if (aFlags & SaveS_Force)
9882 {
9883 fNeedsWrite = true; // always, no need to compare
9884 }
9885 else
9886 {
9887 if (!mData->mCurrentStateModified)
9888 {
9889 // do a deep compare of the settings that we just saved with the settings
9890 // previously stored in the config file; this invokes MachineConfigFile::operator==
9891 // which does a deep compare of all the settings, which is expensive but less expensive
9892 // than writing out XML in vain
9893 bool fAnySettingsChanged = !(*pNewConfig == *pOldConfig);
9894
9895 // could still be modified if any settings changed
9896 mData->mCurrentStateModified = fAnySettingsChanged;
9897
9898 fNeedsWrite = fAnySettingsChanged;
9899 }
9900 else
9901 fNeedsWrite = true;
9902 }
9903
9904 pNewConfig->fCurrentStateModified = !!mData->mCurrentStateModified;
9905
9906 if (fNeedsWrite)
9907 // now spit it all out!
9908 pNewConfig->write(mData->m_strConfigFileFull);
9909
9910 mData->pMachineConfigFile = pNewConfig;
9911 delete pOldConfig;
9912 i_commit();
9913
9914 // after saving settings, we are no longer different from the XML on disk
9915 mData->flModifications = 0;
9916 }
9917 catch (HRESULT err)
9918 {
9919 // we assume that error info is set by the thrower
9920 rc = err;
9921
9922 // restore old config
9923 delete pNewConfig;
9924 mData->pMachineConfigFile = pOldConfig;
9925 }
9926 catch (...)
9927 {
9928 rc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
9929 }
9930
9931 if (fNeedsWrite || (aFlags & SaveS_InformCallbacksAnyway))
9932 {
9933 /* Fire the data change event, even on failure (since we've already
9934 * committed all data). This is done only for SessionMachines because
9935 * mutable Machine instances are always not registered (i.e. private
9936 * to the client process that creates them) and thus don't need to
9937 * inform callbacks. */
9938 if (i_isSessionMachine())
9939 mParent->i_onMachineDataChange(mData->mUuid);
9940 }
9941
9942 LogFlowThisFunc(("rc=%08X\n", rc));
9943 LogFlowThisFuncLeave();
9944 return rc;
9945}
9946
9947/**
9948 * Implementation for saving the machine settings into the given
9949 * settings::MachineConfigFile instance. This copies machine extradata
9950 * from the previous machine config file in the instance data, if any.
9951 *
9952 * This gets called from two locations:
9953 *
9954 * -- Machine::i_saveSettings(), during the regular XML writing;
9955 *
9956 * -- Appliance::buildXMLForOneVirtualSystem(), when a machine gets
9957 * exported to OVF and we write the VirtualBox proprietary XML
9958 * into a <vbox:Machine> tag.
9959 *
9960 * This routine fills all the fields in there, including snapshots, *except*
9961 * for the following:
9962 *
9963 * -- fCurrentStateModified. There is some special logic associated with that.
9964 *
9965 * The caller can then call MachineConfigFile::write() or do something else
9966 * with it.
9967 *
9968 * Caller must hold the machine lock!
9969 *
9970 * This throws XML errors and HRESULT, so the caller must have a catch block!
9971 */
9972void Machine::i_copyMachineDataToSettings(settings::MachineConfigFile &config)
9973{
9974 // deep copy extradata
9975 config.mapExtraDataItems = mData->pMachineConfigFile->mapExtraDataItems;
9976
9977 config.uuid = mData->mUuid;
9978
9979 // copy name, description, OS type, teleport, UTC etc.
9980 config.machineUserData = mUserData->s;
9981
9982 // Encode the Icon Override data from Machine and store on config userdata.
9983 std::vector<BYTE> iconByte;
9984 getIcon(iconByte);
9985 ssize_t cbData = iconByte.size();
9986 if (cbData > 0)
9987 {
9988 ssize_t cchOut = RTBase64EncodedLength(cbData);
9989 Utf8Str strIconData;
9990 strIconData.reserve(cchOut+1);
9991 int vrc = RTBase64Encode(&iconByte.front(), cbData,
9992 strIconData.mutableRaw(), strIconData.capacity(),
9993 NULL);
9994 if (RT_FAILURE(vrc))
9995 throw setError(E_FAIL, tr("Failure to Encode Icon Data. '%s' (%Rrc)"), strIconData.mutableRaw(), vrc);
9996 strIconData.jolt();
9997 config.machineUserData.ovIcon = strIconData;
9998 }
9999 else
10000 config.machineUserData.ovIcon.setNull();
10001
10002 if ( mData->mMachineState == MachineState_Saved
10003 || mData->mMachineState == MachineState_Restoring
10004 // when doing certain snapshot operations we may or may not have
10005 // a saved state in the current state, so keep everything as is
10006 || ( ( mData->mMachineState == MachineState_Snapshotting
10007 || mData->mMachineState == MachineState_DeletingSnapshot
10008 || mData->mMachineState == MachineState_RestoringSnapshot)
10009 && (!mSSData->strStateFilePath.isEmpty())
10010 )
10011 )
10012 {
10013 Assert(!mSSData->strStateFilePath.isEmpty());
10014 /* try to make the file name relative to the settings file dir */
10015 i_copyPathRelativeToMachine(mSSData->strStateFilePath, config.strStateFile);
10016 }
10017 else
10018 {
10019 Assert(mSSData->strStateFilePath.isEmpty() || mData->mMachineState == MachineState_Saving);
10020 config.strStateFile.setNull();
10021 }
10022
10023 if (mData->mCurrentSnapshot)
10024 config.uuidCurrentSnapshot = mData->mCurrentSnapshot->i_getId();
10025 else
10026 config.uuidCurrentSnapshot.clear();
10027
10028 config.timeLastStateChange = mData->mLastStateChange;
10029 config.fAborted = (mData->mMachineState == MachineState_Aborted);
10030 /// @todo Live Migration: config.fTeleported = (mData->mMachineState == MachineState_Teleported);
10031
10032 HRESULT rc = i_saveHardware(config.hardwareMachine, &config.debugging, &config.autostart);
10033 if (FAILED(rc)) throw rc;
10034
10035 rc = i_saveStorageControllers(config.storageMachine);
10036 if (FAILED(rc)) throw rc;
10037
10038 // save machine's media registry if this is VirtualBox 4.0 or later
10039 if (config.canHaveOwnMediaRegistry())
10040 {
10041 // determine machine folder
10042 Utf8Str strMachineFolder = i_getSettingsFileFull();
10043 strMachineFolder.stripFilename();
10044 mParent->i_saveMediaRegistry(config.mediaRegistry,
10045 i_getId(), // only media with registry ID == machine UUID
10046 strMachineFolder);
10047 // this throws HRESULT
10048 }
10049
10050 // save snapshots
10051 rc = i_saveAllSnapshots(config);
10052 if (FAILED(rc)) throw rc;
10053}
10054
10055/**
10056 * Saves all snapshots of the machine into the given machine config file. Called
10057 * from Machine::buildMachineXML() and SessionMachine::deleteSnapshotHandler().
10058 * @param config
10059 * @return
10060 */
10061HRESULT Machine::i_saveAllSnapshots(settings::MachineConfigFile &config)
10062{
10063 AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
10064
10065 HRESULT rc = S_OK;
10066
10067 try
10068 {
10069 config.llFirstSnapshot.clear();
10070
10071 if (mData->mFirstSnapshot)
10072 {
10073 // the settings use a list for "the first snapshot"
10074 config.llFirstSnapshot.push_back(settings::g_SnapshotEmpty);
10075
10076 // get reference to the snapshot on the list and work on that
10077 // element straight in the list to avoid excessive copying later
10078 rc = mData->mFirstSnapshot->i_saveSnapshot(config.llFirstSnapshot.back());
10079 if (FAILED(rc)) throw rc;
10080 }
10081
10082// if (mType == IsSessionMachine)
10083// mParent->onMachineDataChange(mData->mUuid); @todo is this necessary?
10084
10085 }
10086 catch (HRESULT err)
10087 {
10088 /* we assume that error info is set by the thrower */
10089 rc = err;
10090 }
10091 catch (...)
10092 {
10093 rc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
10094 }
10095
10096 return rc;
10097}
10098
10099/**
10100 * Saves the VM hardware configuration. It is assumed that the
10101 * given node is empty.
10102 *
10103 * @param data Reference to the settings object for the hardware config.
10104 * @param pDbg Pointer to the settings object for the debugging config
10105 * which happens to live in mHWData.
10106 * @param pAutostart Pointer to the settings object for the autostart config
10107 * which happens to live in mHWData.
10108 */
10109HRESULT Machine::i_saveHardware(settings::Hardware &data, settings::Debugging *pDbg,
10110 settings::Autostart *pAutostart)
10111{
10112 HRESULT rc = S_OK;
10113
10114 try
10115 {
10116 /* The hardware version attribute (optional).
10117 Automatically upgrade from 1 to 2 when there is no saved state. (ugly!) */
10118 if ( mHWData->mHWVersion == "1"
10119 && mSSData->strStateFilePath.isEmpty()
10120 )
10121 mHWData->mHWVersion = "2"; /** @todo Is this safe, to update mHWVersion here? If not some
10122 other point needs to be found where this can be done. */
10123
10124 data.strVersion = mHWData->mHWVersion;
10125 data.uuid = mHWData->mHardwareUUID;
10126
10127 // CPU
10128 data.fHardwareVirt = !!mHWData->mHWVirtExEnabled;
10129 data.fNestedPaging = !!mHWData->mHWVirtExNestedPagingEnabled;
10130 data.fLargePages = !!mHWData->mHWVirtExLargePagesEnabled;
10131 data.fVPID = !!mHWData->mHWVirtExVPIDEnabled;
10132 data.fUnrestrictedExecution = !!mHWData->mHWVirtExUXEnabled;
10133 data.fHardwareVirtForce = !!mHWData->mHWVirtExForceEnabled;
10134 data.fPAE = !!mHWData->mPAEEnabled;
10135 data.enmLongMode = mHWData->mLongMode;
10136 data.fTripleFaultReset = !!mHWData->mTripleFaultReset;
10137 data.cCPUs = mHWData->mCPUCount;
10138 data.fCpuHotPlug = !!mHWData->mCPUHotPlugEnabled;
10139 data.ulCpuExecutionCap = mHWData->mCpuExecutionCap;
10140 data.uCpuIdPortabilityLevel = mHWData->mCpuIdPortabilityLevel;
10141
10142 data.llCpus.clear();
10143 if (data.fCpuHotPlug)
10144 {
10145 for (unsigned idx = 0; idx < data.cCPUs; ++idx)
10146 {
10147 if (mHWData->mCPUAttached[idx])
10148 {
10149 settings::Cpu cpu;
10150 cpu.ulId = idx;
10151 data.llCpus.push_back(cpu);
10152 }
10153 }
10154 }
10155
10156 /* Standard and Extended CPUID leafs. */
10157 data.llCpuIdLeafs.clear();
10158 for (unsigned idx = 0; idx < RT_ELEMENTS(mHWData->mCpuIdStdLeafs); ++idx)
10159 if (mHWData->mCpuIdStdLeafs[idx].ulId != UINT32_MAX)
10160 data.llCpuIdLeafs.push_back(mHWData->mCpuIdStdLeafs[idx]);
10161 for (unsigned idx = 0; idx < RT_ELEMENTS(mHWData->mCpuIdExtLeafs); ++idx)
10162 if (mHWData->mCpuIdExtLeafs[idx].ulId != UINT32_MAX)
10163 data.llCpuIdLeafs.push_back(mHWData->mCpuIdExtLeafs[idx]);
10164
10165 // memory
10166 data.ulMemorySizeMB = mHWData->mMemorySize;
10167 data.fPageFusionEnabled = !!mHWData->mPageFusionEnabled;
10168
10169 // firmware
10170 data.firmwareType = mHWData->mFirmwareType;
10171
10172 // HID
10173 data.pointingHIDType = mHWData->mPointingHIDType;
10174 data.keyboardHIDType = mHWData->mKeyboardHIDType;
10175
10176 // chipset
10177 data.chipsetType = mHWData->mChipsetType;
10178
10179 // paravirt
10180 data.paravirtProvider = mHWData->mParavirtProvider;
10181
10182
10183 data.fEmulatedUSBCardReader = !!mHWData->mEmulatedUSBCardReaderEnabled;
10184
10185 // HPET
10186 data.fHPETEnabled = !!mHWData->mHPETEnabled;
10187
10188 // boot order
10189 data.mapBootOrder.clear();
10190 for (unsigned i = 0; i < RT_ELEMENTS(mHWData->mBootOrder); ++i)
10191 data.mapBootOrder[i] = mHWData->mBootOrder[i];
10192
10193 // display
10194 data.graphicsControllerType = mHWData->mGraphicsControllerType;
10195 data.ulVRAMSizeMB = mHWData->mVRAMSize;
10196 data.cMonitors = mHWData->mMonitorCount;
10197 data.fAccelerate3D = !!mHWData->mAccelerate3DEnabled;
10198 data.fAccelerate2DVideo = !!mHWData->mAccelerate2DVideoEnabled;
10199 data.ulVideoCaptureHorzRes = mHWData->mVideoCaptureWidth;
10200 data.ulVideoCaptureVertRes = mHWData->mVideoCaptureHeight;
10201 data.ulVideoCaptureRate = mHWData->mVideoCaptureRate;
10202 data.ulVideoCaptureFPS = mHWData->mVideoCaptureFPS;
10203 data.fVideoCaptureEnabled = !!mHWData->mVideoCaptureEnabled;
10204 for (unsigned i = 0; i < sizeof(data.u64VideoCaptureScreens) * 8; ++i)
10205 {
10206 if (mHWData->maVideoCaptureScreens[i])
10207 ASMBitSet(&data.u64VideoCaptureScreens, i);
10208 else
10209 ASMBitClear(&data.u64VideoCaptureScreens, i);
10210 }
10211 /* store relative video capture file if possible */
10212 i_copyPathRelativeToMachine(mHWData->mVideoCaptureFile, data.strVideoCaptureFile);
10213
10214 /* VRDEServer settings (optional) */
10215 rc = mVRDEServer->i_saveSettings(data.vrdeSettings);
10216 if (FAILED(rc)) throw rc;
10217
10218 /* BIOS (required) */
10219 rc = mBIOSSettings->i_saveSettings(data.biosSettings);
10220 if (FAILED(rc)) throw rc;
10221
10222 /* USB Controller (required) */
10223 for (USBControllerList::const_iterator it = mUSBControllers->begin(); it != mUSBControllers->end(); ++it)
10224 {
10225 ComObjPtr<USBController> ctrl = *it;
10226 settings::USBController settingsCtrl;
10227
10228 settingsCtrl.strName = ctrl->i_getName();
10229 settingsCtrl.enmType = ctrl->i_getControllerType();
10230
10231 data.usbSettings.llUSBControllers.push_back(settingsCtrl);
10232 }
10233
10234 /* USB device filters (required) */
10235 rc = mUSBDeviceFilters->i_saveSettings(data.usbSettings);
10236 if (FAILED(rc)) throw rc;
10237
10238 /* Network adapters (required) */
10239 size_t uMaxNICs = RT_MIN(Global::getMaxNetworkAdapters(mHWData->mChipsetType), mNetworkAdapters.size());
10240 data.llNetworkAdapters.clear();
10241 /* Write out only the nominal number of network adapters for this
10242 * chipset type. Since Machine::commit() hasn't been called there
10243 * may be extra NIC settings in the vector. */
10244 for (size_t slot = 0; slot < uMaxNICs; ++slot)
10245 {
10246 settings::NetworkAdapter nic;
10247 nic.ulSlot = (uint32_t)slot;
10248 /* paranoia check... must not be NULL, but must not crash either. */
10249 if (mNetworkAdapters[slot])
10250 {
10251 rc = mNetworkAdapters[slot]->i_saveSettings(nic);
10252 if (FAILED(rc)) throw rc;
10253
10254 data.llNetworkAdapters.push_back(nic);
10255 }
10256 }
10257
10258 /* Serial ports */
10259 data.llSerialPorts.clear();
10260 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
10261 {
10262 settings::SerialPort s;
10263 s.ulSlot = slot;
10264 rc = mSerialPorts[slot]->i_saveSettings(s);
10265 if (FAILED(rc)) return rc;
10266
10267 data.llSerialPorts.push_back(s);
10268 }
10269
10270 /* Parallel ports */
10271 data.llParallelPorts.clear();
10272 for (ULONG slot = 0; slot < RT_ELEMENTS(mParallelPorts); ++slot)
10273 {
10274 settings::ParallelPort p;
10275 p.ulSlot = slot;
10276 rc = mParallelPorts[slot]->i_saveSettings(p);
10277 if (FAILED(rc)) return rc;
10278
10279 data.llParallelPorts.push_back(p);
10280 }
10281
10282 /* Audio adapter */
10283 rc = mAudioAdapter->i_saveSettings(data.audioAdapter);
10284 if (FAILED(rc)) return rc;
10285
10286 /* Shared folders */
10287 data.llSharedFolders.clear();
10288 for (HWData::SharedFolderList::const_iterator it = mHWData->mSharedFolders.begin();
10289 it != mHWData->mSharedFolders.end();
10290 ++it)
10291 {
10292 SharedFolder *pSF = *it;
10293 AutoCaller sfCaller(pSF);
10294 AutoReadLock sfLock(pSF COMMA_LOCKVAL_SRC_POS);
10295 settings::SharedFolder sf;
10296 sf.strName = pSF->i_getName();
10297 sf.strHostPath = pSF->i_getHostPath();
10298 sf.fWritable = !!pSF->i_isWritable();
10299 sf.fAutoMount = !!pSF->i_isAutoMounted();
10300
10301 data.llSharedFolders.push_back(sf);
10302 }
10303
10304 // clipboard
10305 data.clipboardMode = mHWData->mClipboardMode;
10306
10307 // drag'n'drop
10308 data.dndMode = mHWData->mDnDMode;
10309
10310 /* Guest */
10311 data.ulMemoryBalloonSize = mHWData->mMemoryBalloonSize;
10312
10313 // IO settings
10314 data.ioSettings.fIOCacheEnabled = !!mHWData->mIOCacheEnabled;
10315 data.ioSettings.ulIOCacheSize = mHWData->mIOCacheSize;
10316
10317 /* BandwidthControl (required) */
10318 rc = mBandwidthControl->i_saveSettings(data.ioSettings);
10319 if (FAILED(rc)) throw rc;
10320
10321 /* Host PCI devices */
10322 for (HWData::PCIDeviceAssignmentList::const_iterator it = mHWData->mPCIDeviceAssignments.begin();
10323 it != mHWData->mPCIDeviceAssignments.end();
10324 ++it)
10325 {
10326 ComObjPtr<PCIDeviceAttachment> pda = *it;
10327 settings::HostPCIDeviceAttachment hpda;
10328
10329 rc = pda->i_saveSettings(hpda);
10330 if (FAILED(rc)) throw rc;
10331
10332 data.pciAttachments.push_back(hpda);
10333 }
10334
10335
10336 // guest properties
10337 data.llGuestProperties.clear();
10338#ifdef VBOX_WITH_GUEST_PROPS
10339 for (HWData::GuestPropertyMap::const_iterator it = mHWData->mGuestProperties.begin();
10340 it != mHWData->mGuestProperties.end();
10341 ++it)
10342 {
10343 HWData::GuestProperty property = it->second;
10344
10345 /* Remove transient guest properties at shutdown unless we
10346 * are saving state. Note that restoring snapshot intentionally
10347 * keeps them, they will be removed if appropriate once the final
10348 * machine state is set (as crashes etc. need to work). */
10349 if ( ( mData->mMachineState == MachineState_PoweredOff
10350 || mData->mMachineState == MachineState_Aborted
10351 || mData->mMachineState == MachineState_Teleported)
10352 && ( property.mFlags & guestProp::TRANSIENT
10353 || property.mFlags & guestProp::TRANSRESET))
10354 continue;
10355 settings::GuestProperty prop;
10356 prop.strName = it->first;
10357 prop.strValue = property.strValue;
10358 prop.timestamp = property.mTimestamp;
10359 char szFlags[guestProp::MAX_FLAGS_LEN + 1];
10360 guestProp::writeFlags(property.mFlags, szFlags);
10361 prop.strFlags = szFlags;
10362
10363 data.llGuestProperties.push_back(prop);
10364 }
10365
10366 /* I presume this doesn't require a backup(). */
10367 mData->mGuestPropertiesModified = FALSE;
10368#endif /* VBOX_WITH_GUEST_PROPS defined */
10369
10370 *pDbg = mHWData->mDebugging;
10371 *pAutostart = mHWData->mAutostart;
10372
10373 data.strDefaultFrontend = mHWData->mDefaultFrontend;
10374 }
10375 catch(std::bad_alloc &)
10376 {
10377 return E_OUTOFMEMORY;
10378 }
10379
10380 AssertComRC(rc);
10381 return rc;
10382}
10383
10384/**
10385 * Saves the storage controller configuration.
10386 *
10387 * @param aNode <StorageControllers> node to save the VM hardware configuration to.
10388 */
10389HRESULT Machine::i_saveStorageControllers(settings::Storage &data)
10390{
10391 data.llStorageControllers.clear();
10392
10393 for (StorageControllerList::const_iterator it = mStorageControllers->begin();
10394 it != mStorageControllers->end();
10395 ++it)
10396 {
10397 HRESULT rc;
10398 ComObjPtr<StorageController> pCtl = *it;
10399
10400 settings::StorageController ctl;
10401 ctl.strName = pCtl->i_getName();
10402 ctl.controllerType = pCtl->i_getControllerType();
10403 ctl.storageBus = pCtl->i_getStorageBus();
10404 ctl.ulInstance = pCtl->i_getInstance();
10405 ctl.fBootable = pCtl->i_getBootable();
10406
10407 /* Save the port count. */
10408 ULONG portCount;
10409 rc = pCtl->COMGETTER(PortCount)(&portCount);
10410 ComAssertComRCRet(rc, rc);
10411 ctl.ulPortCount = portCount;
10412
10413 /* Save fUseHostIOCache */
10414 BOOL fUseHostIOCache;
10415 rc = pCtl->COMGETTER(UseHostIOCache)(&fUseHostIOCache);
10416 ComAssertComRCRet(rc, rc);
10417 ctl.fUseHostIOCache = !!fUseHostIOCache;
10418
10419 /* save the devices now. */
10420 rc = i_saveStorageDevices(pCtl, ctl);
10421 ComAssertComRCRet(rc, rc);
10422
10423 data.llStorageControllers.push_back(ctl);
10424 }
10425
10426 return S_OK;
10427}
10428
10429/**
10430 * Saves the hard disk configuration.
10431 */
10432HRESULT Machine::i_saveStorageDevices(ComObjPtr<StorageController> aStorageController,
10433 settings::StorageController &data)
10434{
10435 MediaData::AttachmentList atts;
10436
10437 HRESULT rc = i_getMediumAttachmentsOfController(aStorageController->i_getName(), atts);
10438 if (FAILED(rc)) return rc;
10439
10440 data.llAttachedDevices.clear();
10441 for (MediaData::AttachmentList::const_iterator it = atts.begin();
10442 it != atts.end();
10443 ++it)
10444 {
10445 settings::AttachedDevice dev;
10446 IMediumAttachment *iA = *it;
10447 MediumAttachment *pAttach = static_cast<MediumAttachment *>(iA);
10448 Medium *pMedium = pAttach->i_getMedium();
10449
10450 dev.deviceType = pAttach->i_getType();
10451 dev.lPort = pAttach->i_getPort();
10452 dev.lDevice = pAttach->i_getDevice();
10453 dev.fPassThrough = pAttach->i_getPassthrough();
10454 dev.fHotPluggable = pAttach->i_getHotPluggable();
10455 if (pMedium)
10456 {
10457 if (pMedium->i_isHostDrive())
10458 dev.strHostDriveSrc = pMedium->i_getLocationFull();
10459 else
10460 dev.uuid = pMedium->i_getId();
10461 dev.fTempEject = pAttach->i_getTempEject();
10462 dev.fNonRotational = pAttach->i_getNonRotational();
10463 dev.fDiscard = pAttach->i_getDiscard();
10464 }
10465
10466 dev.strBwGroup = pAttach->i_getBandwidthGroup();
10467
10468 data.llAttachedDevices.push_back(dev);
10469 }
10470
10471 return S_OK;
10472}
10473
10474/**
10475 * Saves machine state settings as defined by aFlags
10476 * (SaveSTS_* values).
10477 *
10478 * @param aFlags Combination of SaveSTS_* flags.
10479 *
10480 * @note Locks objects for writing.
10481 */
10482HRESULT Machine::i_saveStateSettings(int aFlags)
10483{
10484 if (aFlags == 0)
10485 return S_OK;
10486
10487 AutoCaller autoCaller(this);
10488 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
10489
10490 /* This object's write lock is also necessary to serialize file access
10491 * (prevent concurrent reads and writes) */
10492 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
10493
10494 HRESULT rc = S_OK;
10495
10496 Assert(mData->pMachineConfigFile);
10497
10498 try
10499 {
10500 if (aFlags & SaveSTS_CurStateModified)
10501 mData->pMachineConfigFile->fCurrentStateModified = true;
10502
10503 if (aFlags & SaveSTS_StateFilePath)
10504 {
10505 if (!mSSData->strStateFilePath.isEmpty())
10506 /* try to make the file name relative to the settings file dir */
10507 i_copyPathRelativeToMachine(mSSData->strStateFilePath, mData->pMachineConfigFile->strStateFile);
10508 else
10509 mData->pMachineConfigFile->strStateFile.setNull();
10510 }
10511
10512 if (aFlags & SaveSTS_StateTimeStamp)
10513 {
10514 Assert( mData->mMachineState != MachineState_Aborted
10515 || mSSData->strStateFilePath.isEmpty());
10516
10517 mData->pMachineConfigFile->timeLastStateChange = mData->mLastStateChange;
10518
10519 mData->pMachineConfigFile->fAborted = (mData->mMachineState == MachineState_Aborted);
10520//@todo live migration mData->pMachineConfigFile->fTeleported = (mData->mMachineState == MachineState_Teleported);
10521 }
10522
10523 mData->pMachineConfigFile->write(mData->m_strConfigFileFull);
10524 }
10525 catch (...)
10526 {
10527 rc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
10528 }
10529
10530 return rc;
10531}
10532
10533/**
10534 * Ensures that the given medium is added to a media registry. If this machine
10535 * was created with 4.0 or later, then the machine registry is used. Otherwise
10536 * the global VirtualBox media registry is used.
10537 *
10538 * Caller must NOT hold machine lock, media tree or any medium locks!
10539 *
10540 * @param pMedium
10541 */
10542void Machine::i_addMediumToRegistry(ComObjPtr<Medium> &pMedium)
10543{
10544 /* Paranoia checks: do not hold machine or media tree locks. */
10545 AssertReturnVoid(!isWriteLockOnCurrentThread());
10546 AssertReturnVoid(!mParent->i_getMediaTreeLockHandle().isWriteLockOnCurrentThread());
10547
10548 ComObjPtr<Medium> pBase;
10549 {
10550 AutoReadLock treeLock(&mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
10551 pBase = pMedium->i_getBase();
10552 }
10553
10554 /* Paranoia checks: do not hold medium locks. */
10555 AssertReturnVoid(!pMedium->isWriteLockOnCurrentThread());
10556 AssertReturnVoid(!pBase->isWriteLockOnCurrentThread());
10557
10558 // decide which medium registry to use now that the medium is attached:
10559 Guid uuid;
10560 if (mData->pMachineConfigFile->canHaveOwnMediaRegistry())
10561 // machine XML is VirtualBox 4.0 or higher:
10562 uuid = i_getId(); // machine UUID
10563 else
10564 uuid = mParent->i_getGlobalRegistryId(); // VirtualBox global registry UUID
10565
10566 if (pMedium->i_addRegistry(uuid))
10567 mParent->i_markRegistryModified(uuid);
10568
10569 /* For more complex hard disk structures it can happen that the base
10570 * medium isn't yet associated with any medium registry. Do that now. */
10571 if (pMedium != pBase)
10572 {
10573 /* Tree lock needed by Medium::addRegistry when recursing. */
10574 AutoReadLock treeLock(&mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
10575 if (pBase->i_addRegistryRecursive(uuid))
10576 {
10577 treeLock.release();
10578 mParent->i_markRegistryModified(uuid);
10579 }
10580 }
10581}
10582
10583/**
10584 * Creates differencing hard disks for all normal hard disks attached to this
10585 * machine and a new set of attachments to refer to created disks.
10586 *
10587 * Used when taking a snapshot or when deleting the current state. Gets called
10588 * from SessionMachine::BeginTakingSnapshot() and SessionMachine::restoreSnapshotHandler().
10589 *
10590 * This method assumes that mMediaData contains the original hard disk attachments
10591 * it needs to create diffs for. On success, these attachments will be replaced
10592 * with the created diffs. On failure, #deleteImplicitDiffs() is implicitly
10593 * called to delete created diffs which will also rollback mMediaData and restore
10594 * whatever was backed up before calling this method.
10595 *
10596 * Attachments with non-normal hard disks are left as is.
10597 *
10598 * If @a aOnline is @c false then the original hard disks that require implicit
10599 * diffs will be locked for reading. Otherwise it is assumed that they are
10600 * already locked for writing (when the VM was started). Note that in the latter
10601 * case it is responsibility of the caller to lock the newly created diffs for
10602 * writing if this method succeeds.
10603 *
10604 * @param aProgress Progress object to run (must contain at least as
10605 * many operations left as the number of hard disks
10606 * attached).
10607 * @param aOnline Whether the VM was online prior to this operation.
10608 *
10609 * @note The progress object is not marked as completed, neither on success nor
10610 * on failure. This is a responsibility of the caller.
10611 *
10612 * @note Locks this object and the media tree for writing.
10613 */
10614HRESULT Machine::i_createImplicitDiffs(IProgress *aProgress,
10615 ULONG aWeight,
10616 bool aOnline)
10617{
10618 LogFlowThisFunc(("aOnline=%d\n", aOnline));
10619
10620 AutoCaller autoCaller(this);
10621 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
10622
10623 AutoMultiWriteLock2 alock(this->lockHandle(),
10624 &mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
10625
10626 /* must be in a protective state because we release the lock below */
10627 AssertReturn( mData->mMachineState == MachineState_Snapshotting
10628 || mData->mMachineState == MachineState_OnlineSnapshotting
10629 || mData->mMachineState == MachineState_LiveSnapshotting
10630 || mData->mMachineState == MachineState_RestoringSnapshot
10631 || mData->mMachineState == MachineState_DeletingSnapshot
10632 , E_FAIL);
10633
10634 HRESULT rc = S_OK;
10635
10636 // use appropriate locked media map (online or offline)
10637 MediumLockListMap lockedMediaOffline;
10638 MediumLockListMap *lockedMediaMap;
10639 if (aOnline)
10640 lockedMediaMap = &mData->mSession.mLockedMedia;
10641 else
10642 lockedMediaMap = &lockedMediaOffline;
10643
10644 try
10645 {
10646 if (!aOnline)
10647 {
10648 /* lock all attached hard disks early to detect "in use"
10649 * situations before creating actual diffs */
10650 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
10651 it != mMediaData->mAttachments.end();
10652 ++it)
10653 {
10654 MediumAttachment* pAtt = *it;
10655 if (pAtt->i_getType() == DeviceType_HardDisk)
10656 {
10657 Medium* pMedium = pAtt->i_getMedium();
10658 Assert(pMedium);
10659
10660 MediumLockList *pMediumLockList(new MediumLockList());
10661 alock.release();
10662 rc = pMedium->i_createMediumLockList(true /* fFailIfInaccessible */,
10663 false /* fMediumLockWrite */,
10664 false /* fMediumLockWriteAll */,
10665 NULL,
10666 *pMediumLockList);
10667 alock.acquire();
10668 if (FAILED(rc))
10669 {
10670 delete pMediumLockList;
10671 throw rc;
10672 }
10673 rc = lockedMediaMap->Insert(pAtt, pMediumLockList);
10674 if (FAILED(rc))
10675 {
10676 throw setError(rc,
10677 tr("Collecting locking information for all attached media failed"));
10678 }
10679 }
10680 }
10681
10682 /* Now lock all media. If this fails, nothing is locked. */
10683 alock.release();
10684 rc = lockedMediaMap->Lock();
10685 alock.acquire();
10686 if (FAILED(rc))
10687 {
10688 throw setError(rc,
10689 tr("Locking of attached media failed"));
10690 }
10691 }
10692
10693 /* remember the current list (note that we don't use backup() since
10694 * mMediaData may be already backed up) */
10695 MediaData::AttachmentList atts = mMediaData->mAttachments;
10696
10697 /* start from scratch */
10698 mMediaData->mAttachments.clear();
10699
10700 /* go through remembered attachments and create diffs for normal hard
10701 * disks and attach them */
10702 for (MediaData::AttachmentList::const_iterator it = atts.begin();
10703 it != atts.end();
10704 ++it)
10705 {
10706 MediumAttachment* pAtt = *it;
10707
10708 DeviceType_T devType = pAtt->i_getType();
10709 Medium* pMedium = pAtt->i_getMedium();
10710
10711 if ( devType != DeviceType_HardDisk
10712 || pMedium == NULL
10713 || pMedium->i_getType() != MediumType_Normal)
10714 {
10715 /* copy the attachment as is */
10716
10717 /** @todo the progress object created in SessionMachine::TakeSnaphot
10718 * only expects operations for hard disks. Later other
10719 * device types need to show up in the progress as well. */
10720 if (devType == DeviceType_HardDisk)
10721 {
10722 if (pMedium == NULL)
10723 aProgress->SetNextOperation(Bstr(tr("Skipping attachment without medium")).raw(),
10724 aWeight); // weight
10725 else
10726 aProgress->SetNextOperation(BstrFmt(tr("Skipping medium '%s'"),
10727 pMedium->i_getBase()->i_getName().c_str()).raw(),
10728 aWeight); // weight
10729 }
10730
10731 mMediaData->mAttachments.push_back(pAtt);
10732 continue;
10733 }
10734
10735 /* need a diff */
10736 aProgress->SetNextOperation(BstrFmt(tr("Creating differencing hard disk for '%s'"),
10737 pMedium->i_getBase()->i_getName().c_str()).raw(),
10738 aWeight); // weight
10739
10740 Utf8Str strFullSnapshotFolder;
10741 i_calculateFullPath(mUserData->s.strSnapshotFolder, strFullSnapshotFolder);
10742
10743 ComObjPtr<Medium> diff;
10744 diff.createObject();
10745 // store the diff in the same registry as the parent
10746 // (this cannot fail here because we can't create implicit diffs for
10747 // unregistered images)
10748 Guid uuidRegistryParent;
10749 bool fInRegistry = pMedium->i_getFirstRegistryMachineId(uuidRegistryParent);
10750 Assert(fInRegistry); NOREF(fInRegistry);
10751 rc = diff->init(mParent,
10752 pMedium->i_getPreferredDiffFormat(),
10753 strFullSnapshotFolder.append(RTPATH_SLASH_STR),
10754 uuidRegistryParent,
10755 DeviceType_HardDisk);
10756 if (FAILED(rc)) throw rc;
10757
10758 /** @todo r=bird: How is the locking and diff image cleaned up if we fail before
10759 * the push_back? Looks like we're going to release medium with the
10760 * wrong kind of lock (general issue with if we fail anywhere at all)
10761 * and an orphaned VDI in the snapshots folder. */
10762
10763 /* update the appropriate lock list */
10764 MediumLockList *pMediumLockList;
10765 rc = lockedMediaMap->Get(pAtt, pMediumLockList);
10766 AssertComRCThrowRC(rc);
10767 if (aOnline)
10768 {
10769 alock.release();
10770 /* The currently attached medium will be read-only, change
10771 * the lock type to read. */
10772 rc = pMediumLockList->Update(pMedium, false);
10773 alock.acquire();
10774 AssertComRCThrowRC(rc);
10775 }
10776
10777 /* release the locks before the potentially lengthy operation */
10778 alock.release();
10779 rc = pMedium->i_createDiffStorage(diff, MediumVariant_Standard,
10780 pMediumLockList,
10781 NULL /* aProgress */,
10782 true /* aWait */);
10783 alock.acquire();
10784 if (FAILED(rc)) throw rc;
10785
10786 /* actual lock list update is done in Medium::commitMedia */
10787
10788 rc = diff->i_addBackReference(mData->mUuid);
10789 AssertComRCThrowRC(rc);
10790
10791 /* add a new attachment */
10792 ComObjPtr<MediumAttachment> attachment;
10793 attachment.createObject();
10794 rc = attachment->init(this,
10795 diff,
10796 pAtt->i_getControllerName(),
10797 pAtt->i_getPort(),
10798 pAtt->i_getDevice(),
10799 DeviceType_HardDisk,
10800 true /* aImplicit */,
10801 false /* aPassthrough */,
10802 false /* aTempEject */,
10803 pAtt->i_getNonRotational(),
10804 pAtt->i_getDiscard(),
10805 pAtt->i_getHotPluggable(),
10806 pAtt->i_getBandwidthGroup());
10807 if (FAILED(rc)) throw rc;
10808
10809 rc = lockedMediaMap->ReplaceKey(pAtt, attachment);
10810 AssertComRCThrowRC(rc);
10811 mMediaData->mAttachments.push_back(attachment);
10812 }
10813 }
10814 catch (HRESULT aRC) { rc = aRC; }
10815
10816 /* unlock all hard disks we locked when there is no VM */
10817 if (!aOnline)
10818 {
10819 ErrorInfoKeeper eik;
10820
10821 HRESULT rc1 = lockedMediaMap->Clear();
10822 AssertComRC(rc1);
10823 }
10824
10825 return rc;
10826}
10827
10828/**
10829 * Deletes implicit differencing hard disks created either by
10830 * #createImplicitDiffs() or by #AttachDevice() and rolls back mMediaData.
10831 *
10832 * Note that to delete hard disks created by #AttachDevice() this method is
10833 * called from #fixupMedia() when the changes are rolled back.
10834 *
10835 * @note Locks this object and the media tree for writing.
10836 */
10837HRESULT Machine::i_deleteImplicitDiffs(bool aOnline)
10838{
10839 LogFlowThisFunc(("aOnline=%d\n", aOnline));
10840
10841 AutoCaller autoCaller(this);
10842 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
10843
10844 AutoMultiWriteLock2 alock(this->lockHandle(),
10845 &mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
10846
10847 /* We absolutely must have backed up state. */
10848 AssertReturn(mMediaData.isBackedUp(), E_FAIL);
10849
10850 /* Check if there are any implicitly created diff images. */
10851 bool fImplicitDiffs = false;
10852 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
10853 it != mMediaData->mAttachments.end();
10854 ++it)
10855 {
10856 const ComObjPtr<MediumAttachment> &pAtt = *it;
10857 if (pAtt->i_isImplicit())
10858 {
10859 fImplicitDiffs = true;
10860 break;
10861 }
10862 }
10863 /* If there is nothing to do, leave early. This saves lots of image locking
10864 * effort. It also avoids a MachineStateChanged event without real reason.
10865 * This is important e.g. when loading a VM config, because there should be
10866 * no events. Otherwise API clients can become thoroughly confused for
10867 * inaccessible VMs (the code for loading VM configs uses this method for
10868 * cleanup if the config makes no sense), as they take such events as an
10869 * indication that the VM is alive, and they would force the VM config to
10870 * be reread, leading to an endless loop. */
10871 if (!fImplicitDiffs)
10872 return S_OK;
10873
10874 HRESULT rc = S_OK;
10875 MachineState_T oldState = mData->mMachineState;
10876
10877 /* will release the lock before the potentially lengthy operation,
10878 * so protect with the special state (unless already protected) */
10879 if ( oldState != MachineState_Snapshotting
10880 && oldState != MachineState_OnlineSnapshotting
10881 && oldState != MachineState_LiveSnapshotting
10882 && oldState != MachineState_RestoringSnapshot
10883 && oldState != MachineState_DeletingSnapshot
10884 && oldState != MachineState_DeletingSnapshotOnline
10885 && oldState != MachineState_DeletingSnapshotPaused
10886 )
10887 i_setMachineState(MachineState_SettingUp);
10888
10889 // use appropriate locked media map (online or offline)
10890 MediumLockListMap lockedMediaOffline;
10891 MediumLockListMap *lockedMediaMap;
10892 if (aOnline)
10893 lockedMediaMap = &mData->mSession.mLockedMedia;
10894 else
10895 lockedMediaMap = &lockedMediaOffline;
10896
10897 try
10898 {
10899 if (!aOnline)
10900 {
10901 /* lock all attached hard disks early to detect "in use"
10902 * situations before deleting actual diffs */
10903 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
10904 it != mMediaData->mAttachments.end();
10905 ++it)
10906 {
10907 MediumAttachment* pAtt = *it;
10908 if (pAtt->i_getType() == DeviceType_HardDisk)
10909 {
10910 Medium* pMedium = pAtt->i_getMedium();
10911 Assert(pMedium);
10912
10913 MediumLockList *pMediumLockList(new MediumLockList());
10914 alock.release();
10915 rc = pMedium->i_createMediumLockList(true /* fFailIfInaccessible */,
10916 false /* fMediumLockWrite */,
10917 false /* fMediumLockWriteAll */,
10918 NULL,
10919 *pMediumLockList);
10920 alock.acquire();
10921
10922 if (FAILED(rc))
10923 {
10924 delete pMediumLockList;
10925 throw rc;
10926 }
10927
10928 rc = lockedMediaMap->Insert(pAtt, pMediumLockList);
10929 if (FAILED(rc))
10930 throw rc;
10931 }
10932 }
10933
10934 if (FAILED(rc))
10935 throw rc;
10936 } // end of offline
10937
10938 /* Lock lists are now up to date and include implicitly created media */
10939
10940 /* Go through remembered attachments and delete all implicitly created
10941 * diffs and fix up the attachment information */
10942 const MediaData::AttachmentList &oldAtts = mMediaData.backedUpData()->mAttachments;
10943 MediaData::AttachmentList implicitAtts;
10944 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
10945 it != mMediaData->mAttachments.end();
10946 ++it)
10947 {
10948 ComObjPtr<MediumAttachment> pAtt = *it;
10949 ComObjPtr<Medium> pMedium = pAtt->i_getMedium();
10950 if (pMedium.isNull())
10951 continue;
10952
10953 // Implicit attachments go on the list for deletion and back references are removed.
10954 if (pAtt->i_isImplicit())
10955 {
10956 /* Deassociate and mark for deletion */
10957 LogFlowThisFunc(("Detaching '%s', pending deletion\n", pAtt->i_getLogName()));
10958 rc = pMedium->i_removeBackReference(mData->mUuid);
10959 if (FAILED(rc))
10960 throw rc;
10961 implicitAtts.push_back(pAtt);
10962 continue;
10963 }
10964
10965 /* Was this medium attached before? */
10966 if (!i_findAttachment(oldAtts, pMedium))
10967 {
10968 /* no: de-associate */
10969 LogFlowThisFunc(("Detaching '%s', no deletion\n", pAtt->i_getLogName()));
10970 rc = pMedium->i_removeBackReference(mData->mUuid);
10971 if (FAILED(rc))
10972 throw rc;
10973 continue;
10974 }
10975 LogFlowThisFunc(("Not detaching '%s'\n", pAtt->i_getLogName()));
10976 }
10977
10978 /* If there are implicit attachments to delete, throw away the lock
10979 * map contents (which will unlock all media) since the medium
10980 * attachments will be rolled back. Below we need to completely
10981 * recreate the lock map anyway since it is infinitely complex to
10982 * do this incrementally (would need reconstructing each attachment
10983 * change, which would be extremely hairy). */
10984 if (implicitAtts.size() != 0)
10985 {
10986 ErrorInfoKeeper eik;
10987
10988 HRESULT rc1 = lockedMediaMap->Clear();
10989 AssertComRC(rc1);
10990 }
10991
10992 /* rollback hard disk changes */
10993 mMediaData.rollback();
10994
10995 MultiResult mrc(S_OK);
10996
10997 // Delete unused implicit diffs.
10998 if (implicitAtts.size() != 0)
10999 {
11000 alock.release();
11001
11002 for (MediaData::AttachmentList::const_iterator it = implicitAtts.begin(); it != implicitAtts.end(); ++it)
11003 {
11004 // Remove medium associated with this attachment.
11005 ComObjPtr<MediumAttachment> pAtt = *it;
11006 Assert(pAtt);
11007 LogFlowThisFunc(("Deleting '%s'\n", pAtt->i_getLogName()));
11008 ComObjPtr<Medium> pMedium = pAtt->i_getMedium();
11009 Assert(pMedium);
11010
11011 rc = pMedium->i_deleteStorage(NULL /*aProgress*/, true /*aWait*/);
11012 // continue on delete failure, just collect error messages
11013 AssertMsg(SUCCEEDED(rc), ("rc=%Rhrc it=%s hd=%s\n", rc, pAtt->i_getLogName(),
11014 pMedium->i_getLocationFull().c_str() ));
11015 mrc = rc;
11016 }
11017 // Clear the list of deleted implicit attachments now, while not
11018 // holding the lock, as it will ultimately trigger Medium::uninit()
11019 // calls which assume that the media tree lock isn't held.
11020 implicitAtts.clear();
11021
11022 alock.acquire();
11023
11024 /* if there is a VM recreate media lock map as mentioned above,
11025 * otherwise it is a waste of time and we leave things unlocked */
11026 if (aOnline)
11027 {
11028 const ComObjPtr<SessionMachine> pMachine = mData->mSession.mMachine;
11029 /* must never be NULL, but better safe than sorry */
11030 if (!pMachine.isNull())
11031 {
11032 alock.release();
11033 rc = mData->mSession.mMachine->i_lockMedia();
11034 alock.acquire();
11035 if (FAILED(rc))
11036 throw rc;
11037 }
11038 }
11039 }
11040 }
11041 catch (HRESULT aRC) {rc = aRC;}
11042
11043 if (mData->mMachineState == MachineState_SettingUp)
11044 i_setMachineState(oldState);
11045
11046 /* unlock all hard disks we locked when there is no VM */
11047 if (!aOnline)
11048 {
11049 ErrorInfoKeeper eik;
11050
11051 HRESULT rc1 = lockedMediaMap->Clear();
11052 AssertComRC(rc1);
11053 }
11054
11055 return rc;
11056}
11057
11058
11059/**
11060 * Looks through the given list of media attachments for one with the given parameters
11061 * and returns it, or NULL if not found. The list is a parameter so that backup lists
11062 * can be searched as well if needed.
11063 *
11064 * @param list
11065 * @param aControllerName
11066 * @param aControllerPort
11067 * @param aDevice
11068 * @return
11069 */
11070MediumAttachment* Machine::i_findAttachment(const MediaData::AttachmentList &ll,
11071 const Utf8Str &aControllerName,
11072 LONG aControllerPort,
11073 LONG aDevice)
11074{
11075 for (MediaData::AttachmentList::const_iterator it = ll.begin(); it != ll.end(); ++it)
11076 {
11077 MediumAttachment *pAttach = *it;
11078 if (pAttach->i_matches(aControllerName, aControllerPort, aDevice))
11079 return pAttach;
11080 }
11081
11082 return NULL;
11083}
11084
11085/**
11086 * Looks through the given list of media attachments for one with the given parameters
11087 * and returns it, or NULL if not found. The list is a parameter so that backup lists
11088 * can be searched as well if needed.
11089 *
11090 * @param list
11091 * @param aControllerName
11092 * @param aControllerPort
11093 * @param aDevice
11094 * @return
11095 */
11096MediumAttachment* Machine::i_findAttachment(const MediaData::AttachmentList &ll,
11097 ComObjPtr<Medium> pMedium)
11098{
11099 for (MediaData::AttachmentList::const_iterator it = ll.begin(); it != ll.end(); ++it)
11100 {
11101 MediumAttachment *pAttach = *it;
11102 ComObjPtr<Medium> pMediumThis = pAttach->i_getMedium();
11103 if (pMediumThis == pMedium)
11104 return pAttach;
11105 }
11106
11107 return NULL;
11108}
11109
11110/**
11111 * Looks through the given list of media attachments for one with the given parameters
11112 * and returns it, or NULL if not found. The list is a parameter so that backup lists
11113 * can be searched as well if needed.
11114 *
11115 * @param list
11116 * @param aControllerName
11117 * @param aControllerPort
11118 * @param aDevice
11119 * @return
11120 */
11121MediumAttachment* Machine::i_findAttachment(const MediaData::AttachmentList &ll,
11122 Guid &id)
11123{
11124 for (MediaData::AttachmentList::const_iterator it = ll.begin(); it != ll.end(); ++it)
11125 {
11126 MediumAttachment *pAttach = *it;
11127 ComObjPtr<Medium> pMediumThis = pAttach->i_getMedium();
11128 if (pMediumThis->i_getId() == id)
11129 return pAttach;
11130 }
11131
11132 return NULL;
11133}
11134
11135/**
11136 * Main implementation for Machine::DetachDevice. This also gets called
11137 * from Machine::prepareUnregister() so it has been taken out for simplicity.
11138 *
11139 * @param pAttach Medium attachment to detach.
11140 * @param writeLock Machine write lock which the caller must have locked once. This may be released temporarily in here.
11141 * @param pSnapshot If NULL, then the detachment is for the current machine. Otherwise this is for a
11142 * SnapshotMachine, and this must be its snapshot.
11143 * @return
11144 */
11145HRESULT Machine::i_detachDevice(MediumAttachment *pAttach,
11146 AutoWriteLock &writeLock,
11147 Snapshot *pSnapshot)
11148{
11149 ComObjPtr<Medium> oldmedium = pAttach->i_getMedium();
11150 DeviceType_T mediumType = pAttach->i_getType();
11151
11152 LogFlowThisFunc(("Entering, medium of attachment is %s\n", oldmedium ? oldmedium->i_getLocationFull().c_str() : "NULL"));
11153
11154 if (pAttach->i_isImplicit())
11155 {
11156 /* attempt to implicitly delete the implicitly created diff */
11157
11158 /// @todo move the implicit flag from MediumAttachment to Medium
11159 /// and forbid any hard disk operation when it is implicit. Or maybe
11160 /// a special media state for it to make it even more simple.
11161
11162 Assert(mMediaData.isBackedUp());
11163
11164 /* will release the lock before the potentially lengthy operation, so
11165 * protect with the special state */
11166 MachineState_T oldState = mData->mMachineState;
11167 i_setMachineState(MachineState_SettingUp);
11168
11169 writeLock.release();
11170
11171 HRESULT rc = oldmedium->i_deleteStorage(NULL /*aProgress*/,
11172 true /*aWait*/);
11173
11174 writeLock.acquire();
11175
11176 i_setMachineState(oldState);
11177
11178 if (FAILED(rc)) return rc;
11179 }
11180
11181 i_setModified(IsModified_Storage);
11182 mMediaData.backup();
11183 mMediaData->mAttachments.remove(pAttach);
11184
11185 if (!oldmedium.isNull())
11186 {
11187 // if this is from a snapshot, do not defer detachment to commitMedia()
11188 if (pSnapshot)
11189 oldmedium->i_removeBackReference(mData->mUuid, pSnapshot->i_getId());
11190 // else if non-hard disk media, do not defer detachment to commitMedia() either
11191 else if (mediumType != DeviceType_HardDisk)
11192 oldmedium->i_removeBackReference(mData->mUuid);
11193 }
11194
11195 return S_OK;
11196}
11197
11198/**
11199 * Goes thru all media of the given list and
11200 *
11201 * 1) calls i_detachDevice() on each of them for this machine and
11202 * 2) adds all Medium objects found in the process to the given list,
11203 * depending on cleanupMode.
11204 *
11205 * If cleanupMode is CleanupMode_DetachAllReturnHardDisksOnly, this only
11206 * adds hard disks to the list. If it is CleanupMode_Full, this adds all
11207 * media to the list.
11208 *
11209 * This gets called from Machine::Unregister, both for the actual Machine and
11210 * the SnapshotMachine objects that might be found in the snapshots.
11211 *
11212 * Requires caller and locking. The machine lock must be passed in because it
11213 * will be passed on to i_detachDevice which needs it for temporary unlocking.
11214 *
11215 * @param writeLock Machine lock from top-level caller; this gets passed to i_detachDevice.
11216 * @param pSnapshot Must be NULL when called for a "real" Machine or a snapshot object if called for a SnapshotMachine.
11217 * @param cleanupMode If DetachAllReturnHardDisksOnly, only hard disk media get added to llMedia; if
11218 * Full, then all media get added;
11219 * otherwise no media get added.
11220 * @param llMedia Caller's list to receive Medium objects which got detached so caller can close() them, depending on cleanupMode.
11221 * @return
11222 */
11223HRESULT Machine::i_detachAllMedia(AutoWriteLock &writeLock,
11224 Snapshot *pSnapshot,
11225 CleanupMode_T cleanupMode,
11226 MediaList &llMedia)
11227{
11228 Assert(isWriteLockOnCurrentThread());
11229
11230 HRESULT rc;
11231
11232 // make a temporary list because i_detachDevice invalidates iterators into
11233 // mMediaData->mAttachments
11234 MediaData::AttachmentList llAttachments2 = mMediaData->mAttachments;
11235
11236 for (MediaData::AttachmentList::iterator it = llAttachments2.begin(); it != llAttachments2.end(); ++it)
11237 {
11238 ComObjPtr<MediumAttachment> &pAttach = *it;
11239 ComObjPtr<Medium> pMedium = pAttach->i_getMedium();
11240
11241 if (!pMedium.isNull())
11242 {
11243 AutoCaller mac(pMedium);
11244 if (FAILED(mac.rc())) return mac.rc();
11245 AutoReadLock lock(pMedium COMMA_LOCKVAL_SRC_POS);
11246 DeviceType_T devType = pMedium->i_getDeviceType();
11247 if ( ( cleanupMode == CleanupMode_DetachAllReturnHardDisksOnly
11248 && devType == DeviceType_HardDisk)
11249 || (cleanupMode == CleanupMode_Full)
11250 )
11251 {
11252 llMedia.push_back(pMedium);
11253 ComObjPtr<Medium> pParent = pMedium->i_getParent();
11254 /* Not allowed to keep this lock as below we need the parent
11255 * medium lock, and the lock order is parent to child. */
11256 lock.release();
11257 /*
11258 * Search for medias which are not attached to any machine, but
11259 * in the chain to an attached disk. Mediums are only consided
11260 * if they are:
11261 * - have only one child
11262 * - no references to any machines
11263 * - are of normal medium type
11264 */
11265 while (!pParent.isNull())
11266 {
11267 AutoCaller mac1(pParent);
11268 if (FAILED(mac1.rc())) return mac1.rc();
11269 AutoReadLock lock1(pParent COMMA_LOCKVAL_SRC_POS);
11270 if (pParent->i_getChildren().size() == 1)
11271 {
11272 if ( pParent->i_getMachineBackRefCount() == 0
11273 && pParent->i_getType() == MediumType_Normal
11274 && find(llMedia.begin(), llMedia.end(), pParent) == llMedia.end())
11275 llMedia.push_back(pParent);
11276 }
11277 else
11278 break;
11279 pParent = pParent->i_getParent();
11280 }
11281 }
11282 }
11283
11284 // real machine: then we need to use the proper method
11285 rc = i_detachDevice(pAttach, writeLock, pSnapshot);
11286
11287 if (FAILED(rc))
11288 return rc;
11289 }
11290
11291 return S_OK;
11292}
11293
11294/**
11295 * Perform deferred hard disk detachments.
11296 *
11297 * Does nothing if the hard disk attachment data (mMediaData) is not changed (not
11298 * backed up).
11299 *
11300 * If @a aOnline is @c true then this method will also unlock the old hard disks
11301 * for which the new implicit diffs were created and will lock these new diffs for
11302 * writing.
11303 *
11304 * @param aOnline Whether the VM was online prior to this operation.
11305 *
11306 * @note Locks this object for writing!
11307 */
11308void Machine::i_commitMedia(bool aOnline /*= false*/)
11309{
11310 AutoCaller autoCaller(this);
11311 AssertComRCReturnVoid(autoCaller.rc());
11312
11313 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
11314
11315 LogFlowThisFunc(("Entering, aOnline=%d\n", aOnline));
11316
11317 HRESULT rc = S_OK;
11318
11319 /* no attach/detach operations -- nothing to do */
11320 if (!mMediaData.isBackedUp())
11321 return;
11322
11323 MediaData::AttachmentList &oldAtts = mMediaData.backedUpData()->mAttachments;
11324 bool fMediaNeedsLocking = false;
11325
11326 /* enumerate new attachments */
11327 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
11328 it != mMediaData->mAttachments.end();
11329 ++it)
11330 {
11331 MediumAttachment *pAttach = *it;
11332
11333 pAttach->i_commit();
11334
11335 Medium* pMedium = pAttach->i_getMedium();
11336 bool fImplicit = pAttach->i_isImplicit();
11337
11338 LogFlowThisFunc(("Examining current medium '%s' (implicit: %d)\n",
11339 (pMedium) ? pMedium->i_getName().c_str() : "NULL",
11340 fImplicit));
11341
11342 /** @todo convert all this Machine-based voodoo to MediumAttachment
11343 * based commit logic. */
11344 if (fImplicit)
11345 {
11346 /* convert implicit attachment to normal */
11347 pAttach->i_setImplicit(false);
11348
11349 if ( aOnline
11350 && pMedium
11351 && pAttach->i_getType() == DeviceType_HardDisk
11352 )
11353 {
11354 /* update the appropriate lock list */
11355 MediumLockList *pMediumLockList;
11356 rc = mData->mSession.mLockedMedia.Get(pAttach, pMediumLockList);
11357 AssertComRC(rc);
11358 if (pMediumLockList)
11359 {
11360 /* unlock if there's a need to change the locking */
11361 if (!fMediaNeedsLocking)
11362 {
11363 rc = mData->mSession.mLockedMedia.Unlock();
11364 AssertComRC(rc);
11365 fMediaNeedsLocking = true;
11366 }
11367 rc = pMediumLockList->Update(pMedium->i_getParent(), false);
11368 AssertComRC(rc);
11369 rc = pMediumLockList->Append(pMedium, true);
11370 AssertComRC(rc);
11371 }
11372 }
11373
11374 continue;
11375 }
11376
11377 if (pMedium)
11378 {
11379 /* was this medium attached before? */
11380 for (MediaData::AttachmentList::iterator oldIt = oldAtts.begin(); oldIt != oldAtts.end(); ++oldIt)
11381 {
11382 MediumAttachment *pOldAttach = *oldIt;
11383 if (pOldAttach->i_getMedium() == pMedium)
11384 {
11385 LogFlowThisFunc(("--> medium '%s' was attached before, will not remove\n", pMedium->i_getName().c_str()));
11386
11387 /* yes: remove from old to avoid de-association */
11388 oldAtts.erase(oldIt);
11389 break;
11390 }
11391 }
11392 }
11393 }
11394
11395 /* enumerate remaining old attachments and de-associate from the
11396 * current machine state */
11397 for (MediaData::AttachmentList::const_iterator it = oldAtts.begin(); it != oldAtts.end(); ++it)
11398 {
11399 MediumAttachment *pAttach = *it;
11400 Medium* pMedium = pAttach->i_getMedium();
11401
11402 /* Detach only hard disks, since DVD/floppy media is detached
11403 * instantly in MountMedium. */
11404 if (pAttach->i_getType() == DeviceType_HardDisk && pMedium)
11405 {
11406 LogFlowThisFunc(("detaching medium '%s' from machine\n", pMedium->i_getName().c_str()));
11407
11408 /* now de-associate from the current machine state */
11409 rc = pMedium->i_removeBackReference(mData->mUuid);
11410 AssertComRC(rc);
11411
11412 if (aOnline)
11413 {
11414 /* unlock since medium is not used anymore */
11415 MediumLockList *pMediumLockList;
11416 rc = mData->mSession.mLockedMedia.Get(pAttach, pMediumLockList);
11417 if (RT_UNLIKELY(rc == VBOX_E_INVALID_OBJECT_STATE))
11418 {
11419 /* this happens for online snapshots, there the attachment
11420 * is changing, but only to a diff image created under
11421 * the old one, so there is no separate lock list */
11422 Assert(!pMediumLockList);
11423 }
11424 else
11425 {
11426 AssertComRC(rc);
11427 if (pMediumLockList)
11428 {
11429 rc = mData->mSession.mLockedMedia.Remove(pAttach);
11430 AssertComRC(rc);
11431 }
11432 }
11433 }
11434 }
11435 }
11436
11437 /* take media locks again so that the locking state is consistent */
11438 if (fMediaNeedsLocking)
11439 {
11440 Assert(aOnline);
11441 rc = mData->mSession.mLockedMedia.Lock();
11442 AssertComRC(rc);
11443 }
11444
11445 /* commit the hard disk changes */
11446 mMediaData.commit();
11447
11448 if (i_isSessionMachine())
11449 {
11450 /*
11451 * Update the parent machine to point to the new owner.
11452 * This is necessary because the stored parent will point to the
11453 * session machine otherwise and cause crashes or errors later
11454 * when the session machine gets invalid.
11455 */
11456 /** @todo Change the MediumAttachment class to behave like any other
11457 * class in this regard by creating peer MediumAttachment
11458 * objects for session machines and share the data with the peer
11459 * machine.
11460 */
11461 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
11462 it != mMediaData->mAttachments.end();
11463 ++it)
11464 (*it)->i_updateParentMachine(mPeer);
11465
11466 /* attach new data to the primary machine and reshare it */
11467 mPeer->mMediaData.attach(mMediaData);
11468 }
11469
11470 return;
11471}
11472
11473/**
11474 * Perform deferred deletion of implicitly created diffs.
11475 *
11476 * Does nothing if the hard disk attachment data (mMediaData) is not changed (not
11477 * backed up).
11478 *
11479 * @note Locks this object for writing!
11480 */
11481void Machine::i_rollbackMedia()
11482{
11483 AutoCaller autoCaller(this);
11484 AssertComRCReturnVoid(autoCaller.rc());
11485
11486 // AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
11487 LogFlowThisFunc(("Entering rollbackMedia\n"));
11488
11489 HRESULT rc = S_OK;
11490
11491 /* no attach/detach operations -- nothing to do */
11492 if (!mMediaData.isBackedUp())
11493 return;
11494
11495 /* enumerate new attachments */
11496 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
11497 it != mMediaData->mAttachments.end();
11498 ++it)
11499 {
11500 MediumAttachment *pAttach = *it;
11501 /* Fix up the backrefs for DVD/floppy media. */
11502 if (pAttach->i_getType() != DeviceType_HardDisk)
11503 {
11504 Medium* pMedium = pAttach->i_getMedium();
11505 if (pMedium)
11506 {
11507 rc = pMedium->i_removeBackReference(mData->mUuid);
11508 AssertComRC(rc);
11509 }
11510 }
11511
11512 (*it)->i_rollback();
11513
11514 pAttach = *it;
11515 /* Fix up the backrefs for DVD/floppy media. */
11516 if (pAttach->i_getType() != DeviceType_HardDisk)
11517 {
11518 Medium* pMedium = pAttach->i_getMedium();
11519 if (pMedium)
11520 {
11521 rc = pMedium->i_addBackReference(mData->mUuid);
11522 AssertComRC(rc);
11523 }
11524 }
11525 }
11526
11527 /** @todo convert all this Machine-based voodoo to MediumAttachment
11528 * based rollback logic. */
11529 i_deleteImplicitDiffs(Global::IsOnline(mData->mMachineState));
11530
11531 return;
11532}
11533
11534/**
11535 * Returns true if the settings file is located in the directory named exactly
11536 * as the machine; this means, among other things, that the machine directory
11537 * should be auto-renamed.
11538 *
11539 * @param aSettingsDir if not NULL, the full machine settings file directory
11540 * name will be assigned there.
11541 *
11542 * @note Doesn't lock anything.
11543 * @note Not thread safe (must be called from this object's lock).
11544 */
11545bool Machine::i_isInOwnDir(Utf8Str *aSettingsDir /* = NULL */) const
11546{
11547 Utf8Str strMachineDirName(mData->m_strConfigFileFull); // path/to/machinesfolder/vmname/vmname.vbox
11548 strMachineDirName.stripFilename(); // path/to/machinesfolder/vmname
11549 if (aSettingsDir)
11550 *aSettingsDir = strMachineDirName;
11551 strMachineDirName.stripPath(); // vmname
11552 Utf8Str strConfigFileOnly(mData->m_strConfigFileFull); // path/to/machinesfolder/vmname/vmname.vbox
11553 strConfigFileOnly.stripPath() // vmname.vbox
11554 .stripSuffix(); // vmname
11555 /** @todo hack, make somehow use of ComposeMachineFilename */
11556 if (mUserData->s.fDirectoryIncludesUUID)
11557 strConfigFileOnly += Utf8StrFmt(" (%RTuuid)", mData->mUuid.raw());
11558
11559 AssertReturn(!strMachineDirName.isEmpty(), false);
11560 AssertReturn(!strConfigFileOnly.isEmpty(), false);
11561
11562 return strMachineDirName == strConfigFileOnly;
11563}
11564
11565/**
11566 * Discards all changes to machine settings.
11567 *
11568 * @param aNotify Whether to notify the direct session about changes or not.
11569 *
11570 * @note Locks objects for writing!
11571 */
11572void Machine::i_rollback(bool aNotify)
11573{
11574 AutoCaller autoCaller(this);
11575 AssertComRCReturn(autoCaller.rc(), (void)0);
11576
11577 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
11578
11579 if (!mStorageControllers.isNull())
11580 {
11581 if (mStorageControllers.isBackedUp())
11582 {
11583 /* unitialize all new devices (absent in the backed up list). */
11584 StorageControllerList::const_iterator it = mStorageControllers->begin();
11585 StorageControllerList *backedList = mStorageControllers.backedUpData();
11586 while (it != mStorageControllers->end())
11587 {
11588 if ( std::find(backedList->begin(), backedList->end(), *it)
11589 == backedList->end()
11590 )
11591 {
11592 (*it)->uninit();
11593 }
11594 ++it;
11595 }
11596
11597 /* restore the list */
11598 mStorageControllers.rollback();
11599 }
11600
11601 /* rollback any changes to devices after restoring the list */
11602 if (mData->flModifications & IsModified_Storage)
11603 {
11604 StorageControllerList::const_iterator it = mStorageControllers->begin();
11605 while (it != mStorageControllers->end())
11606 {
11607 (*it)->i_rollback();
11608 ++it;
11609 }
11610 }
11611 }
11612
11613 if (!mUSBControllers.isNull())
11614 {
11615 if (mUSBControllers.isBackedUp())
11616 {
11617 /* unitialize all new devices (absent in the backed up list). */
11618 USBControllerList::const_iterator it = mUSBControllers->begin();
11619 USBControllerList *backedList = mUSBControllers.backedUpData();
11620 while (it != mUSBControllers->end())
11621 {
11622 if ( std::find(backedList->begin(), backedList->end(), *it)
11623 == backedList->end()
11624 )
11625 {
11626 (*it)->uninit();
11627 }
11628 ++it;
11629 }
11630
11631 /* restore the list */
11632 mUSBControllers.rollback();
11633 }
11634
11635 /* rollback any changes to devices after restoring the list */
11636 if (mData->flModifications & IsModified_USB)
11637 {
11638 USBControllerList::const_iterator it = mUSBControllers->begin();
11639 while (it != mUSBControllers->end())
11640 {
11641 (*it)->i_rollback();
11642 ++it;
11643 }
11644 }
11645 }
11646
11647 mUserData.rollback();
11648
11649 mHWData.rollback();
11650
11651 if (mData->flModifications & IsModified_Storage)
11652 i_rollbackMedia();
11653
11654 if (mBIOSSettings)
11655 mBIOSSettings->i_rollback();
11656
11657 if (mVRDEServer && (mData->flModifications & IsModified_VRDEServer))
11658 mVRDEServer->i_rollback();
11659
11660 if (mAudioAdapter)
11661 mAudioAdapter->i_rollback();
11662
11663 if (mUSBDeviceFilters && (mData->flModifications & IsModified_USB))
11664 mUSBDeviceFilters->i_rollback();
11665
11666 if (mBandwidthControl && (mData->flModifications & IsModified_BandwidthControl))
11667 mBandwidthControl->i_rollback();
11668
11669 if (!mHWData.isNull())
11670 mNetworkAdapters.resize(Global::getMaxNetworkAdapters(mHWData->mChipsetType));
11671 NetworkAdapterVector networkAdapters(mNetworkAdapters.size());
11672 ComPtr<ISerialPort> serialPorts[RT_ELEMENTS(mSerialPorts)];
11673 ComPtr<IParallelPort> parallelPorts[RT_ELEMENTS(mParallelPorts)];
11674
11675 if (mData->flModifications & IsModified_NetworkAdapters)
11676 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
11677 if ( mNetworkAdapters[slot]
11678 && mNetworkAdapters[slot]->i_isModified())
11679 {
11680 mNetworkAdapters[slot]->i_rollback();
11681 networkAdapters[slot] = mNetworkAdapters[slot];
11682 }
11683
11684 if (mData->flModifications & IsModified_SerialPorts)
11685 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
11686 if ( mSerialPorts[slot]
11687 && mSerialPorts[slot]->i_isModified())
11688 {
11689 mSerialPorts[slot]->i_rollback();
11690 serialPorts[slot] = mSerialPorts[slot];
11691 }
11692
11693 if (mData->flModifications & IsModified_ParallelPorts)
11694 for (ULONG slot = 0; slot < RT_ELEMENTS(mParallelPorts); ++slot)
11695 if ( mParallelPorts[slot]
11696 && mParallelPorts[slot]->i_isModified())
11697 {
11698 mParallelPorts[slot]->i_rollback();
11699 parallelPorts[slot] = mParallelPorts[slot];
11700 }
11701
11702 if (aNotify)
11703 {
11704 /* inform the direct session about changes */
11705
11706 ComObjPtr<Machine> that = this;
11707 uint32_t flModifications = mData->flModifications;
11708 alock.release();
11709
11710 if (flModifications & IsModified_SharedFolders)
11711 that->i_onSharedFolderChange();
11712
11713 if (flModifications & IsModified_VRDEServer)
11714 that->i_onVRDEServerChange(/* aRestart */ TRUE);
11715 if (flModifications & IsModified_USB)
11716 that->i_onUSBControllerChange();
11717
11718 for (ULONG slot = 0; slot < networkAdapters.size(); ++slot)
11719 if (networkAdapters[slot])
11720 that->i_onNetworkAdapterChange(networkAdapters[slot], FALSE);
11721 for (ULONG slot = 0; slot < RT_ELEMENTS(serialPorts); ++slot)
11722 if (serialPorts[slot])
11723 that->i_onSerialPortChange(serialPorts[slot]);
11724 for (ULONG slot = 0; slot < RT_ELEMENTS(parallelPorts); ++slot)
11725 if (parallelPorts[slot])
11726 that->i_onParallelPortChange(parallelPorts[slot]);
11727
11728 if (flModifications & IsModified_Storage)
11729 that->i_onStorageControllerChange();
11730
11731#if 0
11732 if (flModifications & IsModified_BandwidthControl)
11733 that->onBandwidthControlChange();
11734#endif
11735 }
11736}
11737
11738/**
11739 * Commits all the changes to machine settings.
11740 *
11741 * Note that this operation is supposed to never fail.
11742 *
11743 * @note Locks this object and children for writing.
11744 */
11745void Machine::i_commit()
11746{
11747 AutoCaller autoCaller(this);
11748 AssertComRCReturnVoid(autoCaller.rc());
11749
11750 AutoCaller peerCaller(mPeer);
11751 AssertComRCReturnVoid(peerCaller.rc());
11752
11753 AutoMultiWriteLock2 alock(mPeer, this COMMA_LOCKVAL_SRC_POS);
11754
11755 /*
11756 * use safe commit to ensure Snapshot machines (that share mUserData)
11757 * will still refer to a valid memory location
11758 */
11759 mUserData.commitCopy();
11760
11761 mHWData.commit();
11762
11763 if (mMediaData.isBackedUp())
11764 i_commitMedia(Global::IsOnline(mData->mMachineState));
11765
11766 mBIOSSettings->i_commit();
11767 mVRDEServer->i_commit();
11768 mAudioAdapter->i_commit();
11769 mUSBDeviceFilters->i_commit();
11770 mBandwidthControl->i_commit();
11771
11772 /* Since mNetworkAdapters is a list which might have been changed (resized)
11773 * without using the Backupable<> template we need to handle the copying
11774 * of the list entries manually, including the creation of peers for the
11775 * new objects. */
11776 bool commitNetworkAdapters = false;
11777 size_t newSize = Global::getMaxNetworkAdapters(mHWData->mChipsetType);
11778 if (mPeer)
11779 {
11780 /* commit everything, even the ones which will go away */
11781 for (size_t slot = 0; slot < mNetworkAdapters.size(); slot++)
11782 mNetworkAdapters[slot]->i_commit();
11783 /* copy over the new entries, creating a peer and uninit the original */
11784 mPeer->mNetworkAdapters.resize(RT_MAX(newSize, mPeer->mNetworkAdapters.size()));
11785 for (size_t slot = 0; slot < newSize; slot++)
11786 {
11787 /* look if this adapter has a peer device */
11788 ComObjPtr<NetworkAdapter> peer = mNetworkAdapters[slot]->i_getPeer();
11789 if (!peer)
11790 {
11791 /* no peer means the adapter is a newly created one;
11792 * create a peer owning data this data share it with */
11793 peer.createObject();
11794 peer->init(mPeer, mNetworkAdapters[slot], true /* aReshare */);
11795 }
11796 mPeer->mNetworkAdapters[slot] = peer;
11797 }
11798 /* uninit any no longer needed network adapters */
11799 for (size_t slot = newSize; slot < mNetworkAdapters.size(); ++slot)
11800 mNetworkAdapters[slot]->uninit();
11801 for (size_t slot = newSize; slot < mPeer->mNetworkAdapters.size(); ++slot)
11802 {
11803 if (mPeer->mNetworkAdapters[slot])
11804 mPeer->mNetworkAdapters[slot]->uninit();
11805 }
11806 /* Keep the original network adapter count until this point, so that
11807 * discarding a chipset type change will not lose settings. */
11808 mNetworkAdapters.resize(newSize);
11809 mPeer->mNetworkAdapters.resize(newSize);
11810 }
11811 else
11812 {
11813 /* we have no peer (our parent is the newly created machine);
11814 * just commit changes to the network adapters */
11815 commitNetworkAdapters = true;
11816 }
11817 if (commitNetworkAdapters)
11818 for (size_t slot = 0; slot < mNetworkAdapters.size(); ++slot)
11819 mNetworkAdapters[slot]->i_commit();
11820
11821 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
11822 mSerialPorts[slot]->i_commit();
11823 for (ULONG slot = 0; slot < RT_ELEMENTS(mParallelPorts); ++slot)
11824 mParallelPorts[slot]->i_commit();
11825
11826 bool commitStorageControllers = false;
11827
11828 if (mStorageControllers.isBackedUp())
11829 {
11830 mStorageControllers.commit();
11831
11832 if (mPeer)
11833 {
11834 /* Commit all changes to new controllers (this will reshare data with
11835 * peers for those who have peers) */
11836 StorageControllerList *newList = new StorageControllerList();
11837 StorageControllerList::const_iterator it = mStorageControllers->begin();
11838 while (it != mStorageControllers->end())
11839 {
11840 (*it)->i_commit();
11841
11842 /* look if this controller has a peer device */
11843 ComObjPtr<StorageController> peer = (*it)->i_getPeer();
11844 if (!peer)
11845 {
11846 /* no peer means the device is a newly created one;
11847 * create a peer owning data this device share it with */
11848 peer.createObject();
11849 peer->init(mPeer, *it, true /* aReshare */);
11850 }
11851 else
11852 {
11853 /* remove peer from the old list */
11854 mPeer->mStorageControllers->remove(peer);
11855 }
11856 /* and add it to the new list */
11857 newList->push_back(peer);
11858
11859 ++it;
11860 }
11861
11862 /* uninit old peer's controllers that are left */
11863 it = mPeer->mStorageControllers->begin();
11864 while (it != mPeer->mStorageControllers->end())
11865 {
11866 (*it)->uninit();
11867 ++it;
11868 }
11869
11870 /* attach new list of controllers to our peer */
11871 mPeer->mStorageControllers.attach(newList);
11872 }
11873 else
11874 {
11875 /* we have no peer (our parent is the newly created machine);
11876 * just commit changes to devices */
11877 commitStorageControllers = true;
11878 }
11879 }
11880 else
11881 {
11882 /* the list of controllers itself is not changed,
11883 * just commit changes to controllers themselves */
11884 commitStorageControllers = true;
11885 }
11886
11887 if (commitStorageControllers)
11888 {
11889 StorageControllerList::const_iterator it = mStorageControllers->begin();
11890 while (it != mStorageControllers->end())
11891 {
11892 (*it)->i_commit();
11893 ++it;
11894 }
11895 }
11896
11897 bool commitUSBControllers = false;
11898
11899 if (mUSBControllers.isBackedUp())
11900 {
11901 mUSBControllers.commit();
11902
11903 if (mPeer)
11904 {
11905 /* Commit all changes to new controllers (this will reshare data with
11906 * peers for those who have peers) */
11907 USBControllerList *newList = new USBControllerList();
11908 USBControllerList::const_iterator it = mUSBControllers->begin();
11909 while (it != mUSBControllers->end())
11910 {
11911 (*it)->i_commit();
11912
11913 /* look if this controller has a peer device */
11914 ComObjPtr<USBController> peer = (*it)->i_getPeer();
11915 if (!peer)
11916 {
11917 /* no peer means the device is a newly created one;
11918 * create a peer owning data this device share it with */
11919 peer.createObject();
11920 peer->init(mPeer, *it, true /* aReshare */);
11921 }
11922 else
11923 {
11924 /* remove peer from the old list */
11925 mPeer->mUSBControllers->remove(peer);
11926 }
11927 /* and add it to the new list */
11928 newList->push_back(peer);
11929
11930 ++it;
11931 }
11932
11933 /* uninit old peer's controllers that are left */
11934 it = mPeer->mUSBControllers->begin();
11935 while (it != mPeer->mUSBControllers->end())
11936 {
11937 (*it)->uninit();
11938 ++it;
11939 }
11940
11941 /* attach new list of controllers to our peer */
11942 mPeer->mUSBControllers.attach(newList);
11943 }
11944 else
11945 {
11946 /* we have no peer (our parent is the newly created machine);
11947 * just commit changes to devices */
11948 commitUSBControllers = true;
11949 }
11950 }
11951 else
11952 {
11953 /* the list of controllers itself is not changed,
11954 * just commit changes to controllers themselves */
11955 commitUSBControllers = true;
11956 }
11957
11958 if (commitUSBControllers)
11959 {
11960 USBControllerList::const_iterator it = mUSBControllers->begin();
11961 while (it != mUSBControllers->end())
11962 {
11963 (*it)->i_commit();
11964 ++it;
11965 }
11966 }
11967
11968 if (i_isSessionMachine())
11969 {
11970 /* attach new data to the primary machine and reshare it */
11971 mPeer->mUserData.attach(mUserData);
11972 mPeer->mHWData.attach(mHWData);
11973 /* mMediaData is reshared by fixupMedia */
11974 // mPeer->mMediaData.attach(mMediaData);
11975 Assert(mPeer->mMediaData.data() == mMediaData.data());
11976 }
11977}
11978
11979/**
11980 * Copies all the hardware data from the given machine.
11981 *
11982 * Currently, only called when the VM is being restored from a snapshot. In
11983 * particular, this implies that the VM is not running during this method's
11984 * call.
11985 *
11986 * @note This method must be called from under this object's lock.
11987 *
11988 * @note This method doesn't call #commit(), so all data remains backed up and
11989 * unsaved.
11990 */
11991void Machine::i_copyFrom(Machine *aThat)
11992{
11993 AssertReturnVoid(!i_isSnapshotMachine());
11994 AssertReturnVoid(aThat->i_isSnapshotMachine());
11995
11996 AssertReturnVoid(!Global::IsOnline(mData->mMachineState));
11997
11998 mHWData.assignCopy(aThat->mHWData);
11999
12000 // create copies of all shared folders (mHWData after attaching a copy
12001 // contains just references to original objects)
12002 for (HWData::SharedFolderList::iterator it = mHWData->mSharedFolders.begin();
12003 it != mHWData->mSharedFolders.end();
12004 ++it)
12005 {
12006 ComObjPtr<SharedFolder> folder;
12007 folder.createObject();
12008 HRESULT rc = folder->initCopy(i_getMachine(), *it);
12009 AssertComRC(rc);
12010 *it = folder;
12011 }
12012
12013 mBIOSSettings->i_copyFrom(aThat->mBIOSSettings);
12014 mVRDEServer->i_copyFrom(aThat->mVRDEServer);
12015 mAudioAdapter->i_copyFrom(aThat->mAudioAdapter);
12016 mUSBDeviceFilters->i_copyFrom(aThat->mUSBDeviceFilters);
12017 mBandwidthControl->i_copyFrom(aThat->mBandwidthControl);
12018
12019 /* create private copies of all controllers */
12020 mStorageControllers.backup();
12021 mStorageControllers->clear();
12022 for (StorageControllerList::iterator it = aThat->mStorageControllers->begin();
12023 it != aThat->mStorageControllers->end();
12024 ++it)
12025 {
12026 ComObjPtr<StorageController> ctrl;
12027 ctrl.createObject();
12028 ctrl->initCopy(this, *it);
12029 mStorageControllers->push_back(ctrl);
12030 }
12031
12032 /* create private copies of all USB controllers */
12033 mUSBControllers.backup();
12034 mUSBControllers->clear();
12035 for (USBControllerList::iterator it = aThat->mUSBControllers->begin();
12036 it != aThat->mUSBControllers->end();
12037 ++it)
12038 {
12039 ComObjPtr<USBController> ctrl;
12040 ctrl.createObject();
12041 ctrl->initCopy(this, *it);
12042 mUSBControllers->push_back(ctrl);
12043 }
12044
12045 mNetworkAdapters.resize(aThat->mNetworkAdapters.size());
12046 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
12047 mNetworkAdapters[slot]->i_copyFrom(aThat->mNetworkAdapters[slot]);
12048 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
12049 mSerialPorts[slot]->i_copyFrom(aThat->mSerialPorts[slot]);
12050 for (ULONG slot = 0; slot < RT_ELEMENTS(mParallelPorts); ++slot)
12051 mParallelPorts[slot]->i_copyFrom(aThat->mParallelPorts[slot]);
12052}
12053
12054/**
12055 * Returns whether the given storage controller is hotplug capable.
12056 *
12057 * @returns true if the controller supports hotplugging
12058 * false otherwise.
12059 * @param enmCtrlType The controller type to check for.
12060 */
12061bool Machine::i_isControllerHotplugCapable(StorageControllerType_T enmCtrlType)
12062{
12063 ComPtr<ISystemProperties> systemProperties;
12064 HRESULT rc = mParent->COMGETTER(SystemProperties)(systemProperties.asOutParam());
12065 if (FAILED(rc))
12066 return false;
12067
12068 BOOL aHotplugCapable = FALSE;
12069 systemProperties->GetStorageControllerHotplugCapable(enmCtrlType, &aHotplugCapable);
12070
12071 return RT_BOOL(aHotplugCapable);
12072}
12073
12074#ifdef VBOX_WITH_RESOURCE_USAGE_API
12075
12076void Machine::i_getDiskList(MediaList &list)
12077{
12078 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
12079 it != mMediaData->mAttachments.end();
12080 ++it)
12081 {
12082 MediumAttachment* pAttach = *it;
12083 /* just in case */
12084 AssertStmt(pAttach, continue);
12085
12086 AutoCaller localAutoCallerA(pAttach);
12087 if (FAILED(localAutoCallerA.rc())) continue;
12088
12089 AutoReadLock local_alockA(pAttach COMMA_LOCKVAL_SRC_POS);
12090
12091 if (pAttach->i_getType() == DeviceType_HardDisk)
12092 list.push_back(pAttach->i_getMedium());
12093 }
12094}
12095
12096void Machine::i_registerMetrics(PerformanceCollector *aCollector, Machine *aMachine, RTPROCESS pid)
12097{
12098 AssertReturnVoid(isWriteLockOnCurrentThread());
12099 AssertPtrReturnVoid(aCollector);
12100
12101 pm::CollectorHAL *hal = aCollector->getHAL();
12102 /* Create sub metrics */
12103 pm::SubMetric *cpuLoadUser = new pm::SubMetric("CPU/Load/User",
12104 "Percentage of processor time spent in user mode by the VM process.");
12105 pm::SubMetric *cpuLoadKernel = new pm::SubMetric("CPU/Load/Kernel",
12106 "Percentage of processor time spent in kernel mode by the VM process.");
12107 pm::SubMetric *ramUsageUsed = new pm::SubMetric("RAM/Usage/Used",
12108 "Size of resident portion of VM process in memory.");
12109 pm::SubMetric *diskUsageUsed = new pm::SubMetric("Disk/Usage/Used",
12110 "Actual size of all VM disks combined.");
12111 pm::SubMetric *machineNetRx = new pm::SubMetric("Net/Rate/Rx",
12112 "Network receive rate.");
12113 pm::SubMetric *machineNetTx = new pm::SubMetric("Net/Rate/Tx",
12114 "Network transmit rate.");
12115 /* Create and register base metrics */
12116 pm::BaseMetric *cpuLoad = new pm::MachineCpuLoadRaw(hal, aMachine, pid,
12117 cpuLoadUser, cpuLoadKernel);
12118 aCollector->registerBaseMetric(cpuLoad);
12119 pm::BaseMetric *ramUsage = new pm::MachineRamUsage(hal, aMachine, pid,
12120 ramUsageUsed);
12121 aCollector->registerBaseMetric(ramUsage);
12122 MediaList disks;
12123 i_getDiskList(disks);
12124 pm::BaseMetric *diskUsage = new pm::MachineDiskUsage(hal, aMachine, disks,
12125 diskUsageUsed);
12126 aCollector->registerBaseMetric(diskUsage);
12127
12128 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadUser, 0));
12129 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadUser,
12130 new pm::AggregateAvg()));
12131 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadUser,
12132 new pm::AggregateMin()));
12133 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadUser,
12134 new pm::AggregateMax()));
12135 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadKernel, 0));
12136 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadKernel,
12137 new pm::AggregateAvg()));
12138 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadKernel,
12139 new pm::AggregateMin()));
12140 aCollector->registerMetric(new pm::Metric(cpuLoad, cpuLoadKernel,
12141 new pm::AggregateMax()));
12142
12143 aCollector->registerMetric(new pm::Metric(ramUsage, ramUsageUsed, 0));
12144 aCollector->registerMetric(new pm::Metric(ramUsage, ramUsageUsed,
12145 new pm::AggregateAvg()));
12146 aCollector->registerMetric(new pm::Metric(ramUsage, ramUsageUsed,
12147 new pm::AggregateMin()));
12148 aCollector->registerMetric(new pm::Metric(ramUsage, ramUsageUsed,
12149 new pm::AggregateMax()));
12150
12151 aCollector->registerMetric(new pm::Metric(diskUsage, diskUsageUsed, 0));
12152 aCollector->registerMetric(new pm::Metric(diskUsage, diskUsageUsed,
12153 new pm::AggregateAvg()));
12154 aCollector->registerMetric(new pm::Metric(diskUsage, diskUsageUsed,
12155 new pm::AggregateMin()));
12156 aCollector->registerMetric(new pm::Metric(diskUsage, diskUsageUsed,
12157 new pm::AggregateMax()));
12158
12159
12160 /* Guest metrics collector */
12161 mCollectorGuest = new pm::CollectorGuest(aMachine, pid);
12162 aCollector->registerGuest(mCollectorGuest);
12163 Log7(("{%p} " LOG_FN_FMT ": mCollectorGuest=%p\n", this, __PRETTY_FUNCTION__, mCollectorGuest));
12164
12165 /* Create sub metrics */
12166 pm::SubMetric *guestLoadUser = new pm::SubMetric("Guest/CPU/Load/User",
12167 "Percentage of processor time spent in user mode as seen by the guest.");
12168 pm::SubMetric *guestLoadKernel = new pm::SubMetric("Guest/CPU/Load/Kernel",
12169 "Percentage of processor time spent in kernel mode as seen by the guest.");
12170 pm::SubMetric *guestLoadIdle = new pm::SubMetric("Guest/CPU/Load/Idle",
12171 "Percentage of processor time spent idling as seen by the guest.");
12172
12173 /* The total amount of physical ram is fixed now, but we'll support dynamic guest ram configurations in the future. */
12174 pm::SubMetric *guestMemTotal = new pm::SubMetric("Guest/RAM/Usage/Total", "Total amount of physical guest RAM.");
12175 pm::SubMetric *guestMemFree = new pm::SubMetric("Guest/RAM/Usage/Free", "Free amount of physical guest RAM.");
12176 pm::SubMetric *guestMemBalloon = new pm::SubMetric("Guest/RAM/Usage/Balloon", "Amount of ballooned physical guest RAM.");
12177 pm::SubMetric *guestMemShared = new pm::SubMetric("Guest/RAM/Usage/Shared", "Amount of shared physical guest RAM.");
12178 pm::SubMetric *guestMemCache = new pm::SubMetric(
12179 "Guest/RAM/Usage/Cache", "Total amount of guest (disk) cache memory.");
12180
12181 pm::SubMetric *guestPagedTotal = new pm::SubMetric(
12182 "Guest/Pagefile/Usage/Total", "Total amount of space in the page file.");
12183
12184 /* Create and register base metrics */
12185 pm::BaseMetric *machineNetRate = new pm::MachineNetRate(mCollectorGuest, aMachine,
12186 machineNetRx, machineNetTx);
12187 aCollector->registerBaseMetric(machineNetRate);
12188
12189 pm::BaseMetric *guestCpuLoad = new pm::GuestCpuLoad(mCollectorGuest, aMachine,
12190 guestLoadUser, guestLoadKernel, guestLoadIdle);
12191 aCollector->registerBaseMetric(guestCpuLoad);
12192
12193 pm::BaseMetric *guestCpuMem = new pm::GuestRamUsage(mCollectorGuest, aMachine,
12194 guestMemTotal, guestMemFree,
12195 guestMemBalloon, guestMemShared,
12196 guestMemCache, guestPagedTotal);
12197 aCollector->registerBaseMetric(guestCpuMem);
12198
12199 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetRx, 0));
12200 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetRx, new pm::AggregateAvg()));
12201 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetRx, new pm::AggregateMin()));
12202 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetRx, new pm::AggregateMax()));
12203
12204 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetTx, 0));
12205 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetTx, new pm::AggregateAvg()));
12206 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetTx, new pm::AggregateMin()));
12207 aCollector->registerMetric(new pm::Metric(machineNetRate, machineNetTx, new pm::AggregateMax()));
12208
12209 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadUser, 0));
12210 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadUser, new pm::AggregateAvg()));
12211 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadUser, new pm::AggregateMin()));
12212 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadUser, new pm::AggregateMax()));
12213
12214 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadKernel, 0));
12215 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadKernel, new pm::AggregateAvg()));
12216 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadKernel, new pm::AggregateMin()));
12217 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadKernel, new pm::AggregateMax()));
12218
12219 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadIdle, 0));
12220 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadIdle, new pm::AggregateAvg()));
12221 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadIdle, new pm::AggregateMin()));
12222 aCollector->registerMetric(new pm::Metric(guestCpuLoad, guestLoadIdle, new pm::AggregateMax()));
12223
12224 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemTotal, 0));
12225 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemTotal, new pm::AggregateAvg()));
12226 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemTotal, new pm::AggregateMin()));
12227 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemTotal, new pm::AggregateMax()));
12228
12229 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemFree, 0));
12230 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemFree, new pm::AggregateAvg()));
12231 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemFree, new pm::AggregateMin()));
12232 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemFree, new pm::AggregateMax()));
12233
12234 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemBalloon, 0));
12235 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemBalloon, new pm::AggregateAvg()));
12236 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemBalloon, new pm::AggregateMin()));
12237 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemBalloon, new pm::AggregateMax()));
12238
12239 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemShared, 0));
12240 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemShared, new pm::AggregateAvg()));
12241 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemShared, new pm::AggregateMin()));
12242 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemShared, new pm::AggregateMax()));
12243
12244 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemCache, 0));
12245 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemCache, new pm::AggregateAvg()));
12246 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemCache, new pm::AggregateMin()));
12247 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestMemCache, new pm::AggregateMax()));
12248
12249 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestPagedTotal, 0));
12250 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestPagedTotal, new pm::AggregateAvg()));
12251 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestPagedTotal, new pm::AggregateMin()));
12252 aCollector->registerMetric(new pm::Metric(guestCpuMem, guestPagedTotal, new pm::AggregateMax()));
12253}
12254
12255void Machine::i_unregisterMetrics(PerformanceCollector *aCollector, Machine *aMachine)
12256{
12257 AssertReturnVoid(isWriteLockOnCurrentThread());
12258
12259 if (aCollector)
12260 {
12261 aCollector->unregisterMetricsFor(aMachine);
12262 aCollector->unregisterBaseMetricsFor(aMachine);
12263 }
12264}
12265
12266#endif /* VBOX_WITH_RESOURCE_USAGE_API */
12267
12268
12269////////////////////////////////////////////////////////////////////////////////
12270
12271DEFINE_EMPTY_CTOR_DTOR(SessionMachine)
12272
12273HRESULT SessionMachine::FinalConstruct()
12274{
12275 LogFlowThisFunc(("\n"));
12276
12277 mClientToken = NULL;
12278
12279 return BaseFinalConstruct();
12280}
12281
12282void SessionMachine::FinalRelease()
12283{
12284 LogFlowThisFunc(("\n"));
12285
12286 Assert(!mClientToken);
12287 /* paranoia, should not hang around any more */
12288 if (mClientToken)
12289 {
12290 delete mClientToken;
12291 mClientToken = NULL;
12292 }
12293
12294 uninit(Uninit::Unexpected);
12295
12296 BaseFinalRelease();
12297}
12298
12299/**
12300 * @note Must be called only by Machine::LockMachine() from its own write lock.
12301 */
12302HRESULT SessionMachine::init(Machine *aMachine)
12303{
12304 LogFlowThisFuncEnter();
12305 LogFlowThisFunc(("mName={%s}\n", aMachine->mUserData->s.strName.c_str()));
12306
12307 AssertReturn(aMachine, E_INVALIDARG);
12308
12309 AssertReturn(aMachine->lockHandle()->isWriteLockOnCurrentThread(), E_FAIL);
12310
12311 /* Enclose the state transition NotReady->InInit->Ready */
12312 AutoInitSpan autoInitSpan(this);
12313 AssertReturn(autoInitSpan.isOk(), E_FAIL);
12314
12315 HRESULT rc = S_OK;
12316
12317 /* create the machine client token */
12318 try
12319 {
12320 mClientToken = new ClientToken(aMachine, this);
12321 if (!mClientToken->isReady())
12322 {
12323 delete mClientToken;
12324 mClientToken = NULL;
12325 rc = E_FAIL;
12326 }
12327 }
12328 catch (std::bad_alloc &)
12329 {
12330 rc = E_OUTOFMEMORY;
12331 }
12332 if (FAILED(rc))
12333 return rc;
12334
12335 /* memorize the peer Machine */
12336 unconst(mPeer) = aMachine;
12337 /* share the parent pointer */
12338 unconst(mParent) = aMachine->mParent;
12339
12340 /* take the pointers to data to share */
12341 mData.share(aMachine->mData);
12342 mSSData.share(aMachine->mSSData);
12343
12344 mUserData.share(aMachine->mUserData);
12345 mHWData.share(aMachine->mHWData);
12346 mMediaData.share(aMachine->mMediaData);
12347
12348 mStorageControllers.allocate();
12349 for (StorageControllerList::const_iterator it = aMachine->mStorageControllers->begin();
12350 it != aMachine->mStorageControllers->end();
12351 ++it)
12352 {
12353 ComObjPtr<StorageController> ctl;
12354 ctl.createObject();
12355 ctl->init(this, *it);
12356 mStorageControllers->push_back(ctl);
12357 }
12358
12359 mUSBControllers.allocate();
12360 for (USBControllerList::const_iterator it = aMachine->mUSBControllers->begin();
12361 it != aMachine->mUSBControllers->end();
12362 ++it)
12363 {
12364 ComObjPtr<USBController> ctl;
12365 ctl.createObject();
12366 ctl->init(this, *it);
12367 mUSBControllers->push_back(ctl);
12368 }
12369
12370 unconst(mBIOSSettings).createObject();
12371 mBIOSSettings->init(this, aMachine->mBIOSSettings);
12372 /* create another VRDEServer object that will be mutable */
12373 unconst(mVRDEServer).createObject();
12374 mVRDEServer->init(this, aMachine->mVRDEServer);
12375 /* create another audio adapter object that will be mutable */
12376 unconst(mAudioAdapter).createObject();
12377 mAudioAdapter->init(this, aMachine->mAudioAdapter);
12378 /* create a list of serial ports that will be mutable */
12379 for (ULONG slot = 0; slot < RT_ELEMENTS(mSerialPorts); ++slot)
12380 {
12381 unconst(mSerialPorts[slot]).createObject();
12382 mSerialPorts[slot]->init(this, aMachine->mSerialPorts[slot]);
12383 }
12384 /* create a list of parallel ports that will be mutable */
12385 for (ULONG slot = 0; slot < RT_ELEMENTS(mParallelPorts); ++slot)
12386 {
12387 unconst(mParallelPorts[slot]).createObject();
12388 mParallelPorts[slot]->init(this, aMachine->mParallelPorts[slot]);
12389 }
12390
12391 /* create another USB device filters object that will be mutable */
12392 unconst(mUSBDeviceFilters).createObject();
12393 mUSBDeviceFilters->init(this, aMachine->mUSBDeviceFilters);
12394
12395 /* create a list of network adapters that will be mutable */
12396 mNetworkAdapters.resize(aMachine->mNetworkAdapters.size());
12397 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
12398 {
12399 unconst(mNetworkAdapters[slot]).createObject();
12400 mNetworkAdapters[slot]->init(this, aMachine->mNetworkAdapters[slot]);
12401 }
12402
12403 /* create another bandwidth control object that will be mutable */
12404 unconst(mBandwidthControl).createObject();
12405 mBandwidthControl->init(this, aMachine->mBandwidthControl);
12406
12407 /* default is to delete saved state on Saved -> PoweredOff transition */
12408 mRemoveSavedState = true;
12409
12410 /* Confirm a successful initialization when it's the case */
12411 autoInitSpan.setSucceeded();
12412
12413 miNATNetworksStarted = 0;
12414
12415 LogFlowThisFuncLeave();
12416 return rc;
12417}
12418
12419/**
12420 * Uninitializes this session object. If the reason is other than
12421 * Uninit::Unexpected, then this method MUST be called from #checkForDeath()
12422 * or the client watcher code.
12423 *
12424 * @param aReason uninitialization reason
12425 *
12426 * @note Locks mParent + this object for writing.
12427 */
12428void SessionMachine::uninit(Uninit::Reason aReason)
12429{
12430 LogFlowThisFuncEnter();
12431 LogFlowThisFunc(("reason=%d\n", aReason));
12432
12433 /*
12434 * Strongly reference ourselves to prevent this object deletion after
12435 * mData->mSession.mMachine.setNull() below (which can release the last
12436 * reference and call the destructor). Important: this must be done before
12437 * accessing any members (and before AutoUninitSpan that does it as well).
12438 * This self reference will be released as the very last step on return.
12439 */
12440 ComObjPtr<SessionMachine> selfRef = this;
12441
12442 /* Enclose the state transition Ready->InUninit->NotReady */
12443 AutoUninitSpan autoUninitSpan(this);
12444 if (autoUninitSpan.uninitDone())
12445 {
12446 LogFlowThisFunc(("Already uninitialized\n"));
12447 LogFlowThisFuncLeave();
12448 return;
12449 }
12450
12451 if (autoUninitSpan.initFailed())
12452 {
12453 /* We've been called by init() because it's failed. It's not really
12454 * necessary (nor it's safe) to perform the regular uninit sequence
12455 * below, the following is enough.
12456 */
12457 LogFlowThisFunc(("Initialization failed.\n"));
12458 /* destroy the machine client token */
12459 if (mClientToken)
12460 {
12461 delete mClientToken;
12462 mClientToken = NULL;
12463 }
12464 uninitDataAndChildObjects();
12465 mData.free();
12466 unconst(mParent) = NULL;
12467 unconst(mPeer) = NULL;
12468 LogFlowThisFuncLeave();
12469 return;
12470 }
12471
12472 MachineState_T lastState;
12473 {
12474 AutoReadLock tempLock(this COMMA_LOCKVAL_SRC_POS);
12475 lastState = mData->mMachineState;
12476 }
12477 NOREF(lastState);
12478
12479#ifdef VBOX_WITH_USB
12480 // release all captured USB devices, but do this before requesting the locks below
12481 if (aReason == Uninit::Abnormal && Global::IsOnline(lastState))
12482 {
12483 /* Console::captureUSBDevices() is called in the VM process only after
12484 * setting the machine state to Starting or Restoring.
12485 * Console::detachAllUSBDevices() will be called upon successful
12486 * termination. So, we need to release USB devices only if there was
12487 * an abnormal termination of a running VM.
12488 *
12489 * This is identical to SessionMachine::DetachAllUSBDevices except
12490 * for the aAbnormal argument. */
12491 HRESULT rc = mUSBDeviceFilters->i_notifyProxy(false /* aInsertFilters */);
12492 AssertComRC(rc);
12493 NOREF(rc);
12494
12495 USBProxyService *service = mParent->i_host()->i_usbProxyService();
12496 if (service)
12497 service->detachAllDevicesFromVM(this, true /* aDone */, true /* aAbnormal */);
12498 }
12499#endif /* VBOX_WITH_USB */
12500
12501 // we need to lock this object in uninit() because the lock is shared
12502 // with mPeer (as well as data we modify below). mParent lock is needed
12503 // by several calls to it, and USB needs host lock.
12504 AutoMultiWriteLock3 multilock(mParent, mParent->i_host(), this COMMA_LOCKVAL_SRC_POS);
12505
12506#ifdef VBOX_WITH_RESOURCE_USAGE_API
12507 /*
12508 * It is safe to call Machine::i_unregisterMetrics() here because
12509 * PerformanceCollector::samplerCallback no longer accesses guest methods
12510 * holding the lock.
12511 */
12512 i_unregisterMetrics(mParent->i_performanceCollector(), mPeer);
12513 /* The guest must be unregistered after its metrics (@bugref{5949}). */
12514 Log7(("{%p} " LOG_FN_FMT ": mCollectorGuest=%p\n", this, __PRETTY_FUNCTION__, mCollectorGuest));
12515 if (mCollectorGuest)
12516 {
12517 mParent->i_performanceCollector()->unregisterGuest(mCollectorGuest);
12518 // delete mCollectorGuest; => CollectorGuestManager::destroyUnregistered()
12519 mCollectorGuest = NULL;
12520 }
12521#endif
12522
12523 if (aReason == Uninit::Abnormal)
12524 {
12525 Log1WarningThisFunc(("ABNORMAL client termination! (wasBusy=%d)\n", Global::IsOnlineOrTransient(lastState)));
12526
12527 /* reset the state to Aborted */
12528 if (mData->mMachineState != MachineState_Aborted)
12529 i_setMachineState(MachineState_Aborted);
12530 }
12531
12532 // any machine settings modified?
12533 if (mData->flModifications)
12534 {
12535 Log1WarningThisFunc(("Discarding unsaved settings changes!\n"));
12536 i_rollback(false /* aNotify */);
12537 }
12538
12539 mData->mSession.mPID = NIL_RTPROCESS;
12540
12541 if (aReason == Uninit::Unexpected)
12542 {
12543 /* Uninitialization didn't come from #checkForDeath(), so tell the
12544 * client watcher thread to update the set of machines that have open
12545 * sessions. */
12546 mParent->i_updateClientWatcher();
12547 }
12548
12549 /* uninitialize all remote controls */
12550 if (mData->mSession.mRemoteControls.size())
12551 {
12552 LogFlowThisFunc(("Closing remote sessions (%d):\n",
12553 mData->mSession.mRemoteControls.size()));
12554
12555 Data::Session::RemoteControlList::iterator it =
12556 mData->mSession.mRemoteControls.begin();
12557 while (it != mData->mSession.mRemoteControls.end())
12558 {
12559 LogFlowThisFunc((" Calling remoteControl->Uninitialize()...\n"));
12560 HRESULT rc = (*it)->Uninitialize();
12561 LogFlowThisFunc((" remoteControl->Uninitialize() returned %08X\n", rc));
12562 if (FAILED(rc))
12563 Log1WarningThisFunc(("Forgot to close the remote session?\n"));
12564 ++it;
12565 }
12566 mData->mSession.mRemoteControls.clear();
12567 }
12568
12569 /* Remove all references to the NAT network service. The service will stop
12570 * if all references (also from other VMs) are removed. */
12571 for (; miNATNetworksStarted > 0; miNATNetworksStarted--)
12572 {
12573 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
12574 {
12575 NetworkAttachmentType_T type;
12576 HRESULT hrc;
12577
12578 hrc = mNetworkAdapters[slot]->COMGETTER(AttachmentType)(&type);
12579 if ( SUCCEEDED(hrc)
12580 && type == NetworkAttachmentType_NATNetwork)
12581 {
12582 Bstr name;
12583 hrc = mNetworkAdapters[slot]->COMGETTER(NATNetwork)(name.asOutParam());
12584 if (SUCCEEDED(hrc))
12585 {
12586 multilock.release();
12587 LogRel(("VM '%s' stops using NAT network '%ls'\n",
12588 mUserData->s.strName.c_str(), name.raw()));
12589 mParent->i_natNetworkRefDec(name.raw());
12590 multilock.acquire();
12591 }
12592 }
12593 }
12594 }
12595
12596 /*
12597 * An expected uninitialization can come only from #checkForDeath().
12598 * Otherwise it means that something's gone really wrong (for example,
12599 * the Session implementation has released the VirtualBox reference
12600 * before it triggered #OnSessionEnd(), or before releasing IPC semaphore,
12601 * etc). However, it's also possible, that the client releases the IPC
12602 * semaphore correctly (i.e. before it releases the VirtualBox reference),
12603 * but the VirtualBox release event comes first to the server process.
12604 * This case is practically possible, so we should not assert on an
12605 * unexpected uninit, just log a warning.
12606 */
12607
12608 if ((aReason == Uninit::Unexpected))
12609 Log1WarningThisFunc(("Unexpected SessionMachine uninitialization!\n"));
12610
12611 if (aReason != Uninit::Normal)
12612 {
12613 mData->mSession.mDirectControl.setNull();
12614 }
12615 else
12616 {
12617 /* this must be null here (see #OnSessionEnd()) */
12618 Assert(mData->mSession.mDirectControl.isNull());
12619 Assert(mData->mSession.mState == SessionState_Unlocking);
12620 Assert(!mData->mSession.mProgress.isNull());
12621 }
12622 if (mData->mSession.mProgress)
12623 {
12624 if (aReason == Uninit::Normal)
12625 mData->mSession.mProgress->i_notifyComplete(S_OK);
12626 else
12627 mData->mSession.mProgress->i_notifyComplete(E_FAIL,
12628 COM_IIDOF(ISession),
12629 getComponentName(),
12630 tr("The VM session was aborted"));
12631 mData->mSession.mProgress.setNull();
12632 }
12633
12634 /* remove the association between the peer machine and this session machine */
12635 Assert( (SessionMachine*)mData->mSession.mMachine == this
12636 || aReason == Uninit::Unexpected);
12637
12638 /* reset the rest of session data */
12639 mData->mSession.mLockType = LockType_Null;
12640 mData->mSession.mMachine.setNull();
12641 mData->mSession.mState = SessionState_Unlocked;
12642 mData->mSession.mName.setNull();
12643
12644 /* destroy the machine client token before leaving the exclusive lock */
12645 if (mClientToken)
12646 {
12647 delete mClientToken;
12648 mClientToken = NULL;
12649 }
12650
12651 /* fire an event */
12652 mParent->i_onSessionStateChange(mData->mUuid, SessionState_Unlocked);
12653
12654 uninitDataAndChildObjects();
12655
12656 /* free the essential data structure last */
12657 mData.free();
12658
12659 /* release the exclusive lock before setting the below two to NULL */
12660 multilock.release();
12661
12662 unconst(mParent) = NULL;
12663 unconst(mPeer) = NULL;
12664
12665 LogFlowThisFuncLeave();
12666}
12667
12668// util::Lockable interface
12669////////////////////////////////////////////////////////////////////////////////
12670
12671/**
12672 * Overrides VirtualBoxBase::lockHandle() in order to share the lock handle
12673 * with the primary Machine instance (mPeer).
12674 */
12675RWLockHandle *SessionMachine::lockHandle() const
12676{
12677 AssertReturn(mPeer != NULL, NULL);
12678 return mPeer->lockHandle();
12679}
12680
12681// IInternalMachineControl methods
12682////////////////////////////////////////////////////////////////////////////////
12683
12684/**
12685 * Passes collected guest statistics to performance collector object
12686 */
12687HRESULT SessionMachine::reportVmStatistics(ULONG aValidStats, ULONG aCpuUser,
12688 ULONG aCpuKernel, ULONG aCpuIdle,
12689 ULONG aMemTotal, ULONG aMemFree,
12690 ULONG aMemBalloon, ULONG aMemShared,
12691 ULONG aMemCache, ULONG aPageTotal,
12692 ULONG aAllocVMM, ULONG aFreeVMM,
12693 ULONG aBalloonedVMM, ULONG aSharedVMM,
12694 ULONG aVmNetRx, ULONG aVmNetTx)
12695{
12696#ifdef VBOX_WITH_RESOURCE_USAGE_API
12697 if (mCollectorGuest)
12698 mCollectorGuest->updateStats(aValidStats, aCpuUser, aCpuKernel, aCpuIdle,
12699 aMemTotal, aMemFree, aMemBalloon, aMemShared,
12700 aMemCache, aPageTotal, aAllocVMM, aFreeVMM,
12701 aBalloonedVMM, aSharedVMM, aVmNetRx, aVmNetTx);
12702
12703 return S_OK;
12704#else
12705 NOREF(aValidStats);
12706 NOREF(aCpuUser);
12707 NOREF(aCpuKernel);
12708 NOREF(aCpuIdle);
12709 NOREF(aMemTotal);
12710 NOREF(aMemFree);
12711 NOREF(aMemBalloon);
12712 NOREF(aMemShared);
12713 NOREF(aMemCache);
12714 NOREF(aPageTotal);
12715 NOREF(aAllocVMM);
12716 NOREF(aFreeVMM);
12717 NOREF(aBalloonedVMM);
12718 NOREF(aSharedVMM);
12719 NOREF(aVmNetRx);
12720 NOREF(aVmNetTx);
12721 return E_NOTIMPL;
12722#endif
12723}
12724
12725////////////////////////////////////////////////////////////////////////////////
12726//
12727// SessionMachine task records
12728//
12729////////////////////////////////////////////////////////////////////////////////
12730
12731/**
12732 * Task record for saving the machine state.
12733 */
12734struct SessionMachine::SaveStateTask
12735 : public Machine::Task
12736{
12737 SaveStateTask(SessionMachine *m,
12738 Progress *p,
12739 const Utf8Str &t,
12740 Reason_T enmReason,
12741 const Utf8Str &strStateFilePath)
12742 : Task(m, p, t),
12743 m_enmReason(enmReason),
12744 m_strStateFilePath(strStateFilePath)
12745 {}
12746
12747 void handler()
12748 {
12749 ((SessionMachine *)(Machine *)m_pMachine)->i_saveStateHandler(*this);
12750 }
12751
12752 Reason_T m_enmReason;
12753 Utf8Str m_strStateFilePath;
12754};
12755
12756/**
12757 * Task thread implementation for SessionMachine::SaveState(), called from
12758 * SessionMachine::taskHandler().
12759 *
12760 * @note Locks this object for writing.
12761 *
12762 * @param task
12763 * @return
12764 */
12765void SessionMachine::i_saveStateHandler(SaveStateTask &task)
12766{
12767 LogFlowThisFuncEnter();
12768
12769 AutoCaller autoCaller(this);
12770 LogFlowThisFunc(("state=%d\n", getObjectState().getState()));
12771 if (FAILED(autoCaller.rc()))
12772 {
12773 /* we might have been uninitialized because the session was accidentally
12774 * closed by the client, so don't assert */
12775 HRESULT rc = setError(E_FAIL,
12776 tr("The session has been accidentally closed"));
12777 task.m_pProgress->i_notifyComplete(rc);
12778 LogFlowThisFuncLeave();
12779 return;
12780 }
12781
12782 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
12783
12784 HRESULT rc = S_OK;
12785
12786 try
12787 {
12788 ComPtr<IInternalSessionControl> directControl;
12789 if (mData->mSession.mLockType == LockType_VM)
12790 directControl = mData->mSession.mDirectControl;
12791 if (directControl.isNull())
12792 throw setError(VBOX_E_INVALID_VM_STATE,
12793 tr("Trying to save state without a running VM"));
12794 alock.release();
12795 BOOL fSuspendedBySave;
12796 rc = directControl->SaveStateWithReason(task.m_enmReason, task.m_pProgress, Bstr(task.m_strStateFilePath).raw(), task.m_machineStateBackup != MachineState_Paused, &fSuspendedBySave);
12797 Assert(!fSuspendedBySave);
12798 alock.acquire();
12799
12800 AssertStmt( (SUCCEEDED(rc) && mData->mMachineState == MachineState_Saved)
12801 || (FAILED(rc) && mData->mMachineState == MachineState_Saving),
12802 throw E_FAIL);
12803
12804 if (SUCCEEDED(rc))
12805 {
12806 mSSData->strStateFilePath = task.m_strStateFilePath;
12807
12808 /* save all VM settings */
12809 rc = i_saveSettings(NULL);
12810 // no need to check whether VirtualBox.xml needs saving also since
12811 // we can't have a name change pending at this point
12812 }
12813 else
12814 {
12815 // On failure, set the state to the state we had at the beginning.
12816 i_setMachineState(task.m_machineStateBackup);
12817 i_updateMachineStateOnClient();
12818
12819 // Delete the saved state file (might have been already created).
12820 // No need to check whether this is shared with a snapshot here
12821 // because we certainly created a fresh saved state file here.
12822 RTFileDelete(task.m_strStateFilePath.c_str());
12823 }
12824 }
12825 catch (HRESULT aRC) { rc = aRC; }
12826
12827 task.m_pProgress->i_notifyComplete(rc);
12828
12829 LogFlowThisFuncLeave();
12830}
12831
12832/**
12833 * @note Locks this object for writing.
12834 */
12835HRESULT SessionMachine::saveState(ComPtr<IProgress> &aProgress)
12836{
12837 return i_saveStateWithReason(Reason_Unspecified, aProgress);
12838}
12839
12840HRESULT SessionMachine::i_saveStateWithReason(Reason_T aReason, ComPtr<IProgress> &aProgress)
12841{
12842 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
12843
12844 HRESULT rc = i_checkStateDependency(MutableOrRunningStateDep);
12845 if (FAILED(rc)) return rc;
12846
12847 if ( mData->mMachineState != MachineState_Running
12848 && mData->mMachineState != MachineState_Paused
12849 )
12850 return setError(VBOX_E_INVALID_VM_STATE,
12851 tr("Cannot save the execution state as the machine is not running or paused (machine state: %s)"),
12852 Global::stringifyMachineState(mData->mMachineState));
12853
12854 ComObjPtr<Progress> pProgress;
12855 pProgress.createObject();
12856 rc = pProgress->init(i_getVirtualBox(),
12857 static_cast<IMachine *>(this) /* aInitiator */,
12858 Bstr(tr("Saving the execution state of the virtual machine")).raw(),
12859 FALSE /* aCancelable */);
12860 if (FAILED(rc))
12861 return rc;
12862
12863 Utf8Str strStateFilePath;
12864 i_composeSavedStateFilename(strStateFilePath);
12865
12866 /* create and start the task on a separate thread (note that it will not
12867 * start working until we release alock) */
12868 SaveStateTask *pTask = new SaveStateTask(this, pProgress, "SaveState", aReason, strStateFilePath);
12869 rc = pTask->createThread();
12870 if (FAILED(rc))
12871 return rc;
12872
12873 /* set the state to Saving (expected by Session::SaveStateWithReason()) */
12874 i_setMachineState(MachineState_Saving);
12875 i_updateMachineStateOnClient();
12876
12877 pProgress.queryInterfaceTo(aProgress.asOutParam());
12878
12879 return S_OK;
12880}
12881
12882/**
12883 * @note Locks this object for writing.
12884 */
12885HRESULT SessionMachine::adoptSavedState(const com::Utf8Str &aSavedStateFile)
12886{
12887 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
12888
12889 HRESULT rc = i_checkStateDependency(MutableStateDep);
12890 if (FAILED(rc)) return rc;
12891
12892 if ( mData->mMachineState != MachineState_PoweredOff
12893 && mData->mMachineState != MachineState_Teleported
12894 && mData->mMachineState != MachineState_Aborted
12895 )
12896 return setError(VBOX_E_INVALID_VM_STATE,
12897 tr("Cannot adopt the saved machine state as the machine is not in Powered Off, Teleported or Aborted state (machine state: %s)"),
12898 Global::stringifyMachineState(mData->mMachineState));
12899
12900 com::Utf8Str stateFilePathFull;
12901 int vrc = i_calculateFullPath(aSavedStateFile, stateFilePathFull);
12902 if (RT_FAILURE(vrc))
12903 return setError(VBOX_E_FILE_ERROR,
12904 tr("Invalid saved state file path '%s' (%Rrc)"),
12905 aSavedStateFile.c_str(),
12906 vrc);
12907
12908 mSSData->strStateFilePath = stateFilePathFull;
12909
12910 /* The below i_setMachineState() will detect the state transition and will
12911 * update the settings file */
12912
12913 return i_setMachineState(MachineState_Saved);
12914}
12915
12916/**
12917 * @note Locks this object for writing.
12918 */
12919HRESULT SessionMachine::discardSavedState(BOOL aFRemoveFile)
12920{
12921 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
12922
12923 HRESULT rc = i_checkStateDependency(MutableOrSavedStateDep);
12924 if (FAILED(rc)) return rc;
12925
12926 if (mData->mMachineState != MachineState_Saved)
12927 return setError(VBOX_E_INVALID_VM_STATE,
12928 tr("Cannot delete the machine state as the machine is not in the saved state (machine state: %s)"),
12929 Global::stringifyMachineState(mData->mMachineState));
12930
12931 mRemoveSavedState = RT_BOOL(aFRemoveFile);
12932
12933 /*
12934 * Saved -> PoweredOff transition will be detected in the SessionMachine
12935 * and properly handled.
12936 */
12937 rc = i_setMachineState(MachineState_PoweredOff);
12938 return rc;
12939}
12940
12941
12942/**
12943 * @note Locks the same as #i_setMachineState() does.
12944 */
12945HRESULT SessionMachine::updateState(MachineState_T aState)
12946{
12947 return i_setMachineState(aState);
12948}
12949
12950/**
12951 * @note Locks this object for writing.
12952 */
12953HRESULT SessionMachine::beginPowerUp(const ComPtr<IProgress> &aProgress)
12954{
12955 IProgress* pProgress(aProgress);
12956
12957 LogFlowThisFunc(("aProgress=%p\n", pProgress));
12958
12959 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
12960
12961 if (mData->mSession.mState != SessionState_Locked)
12962 return VBOX_E_INVALID_OBJECT_STATE;
12963
12964 if (!mData->mSession.mProgress.isNull())
12965 mData->mSession.mProgress->setOtherProgressObject(pProgress);
12966
12967 /* If we didn't reference the NAT network service yet, add a reference to
12968 * force a start */
12969 if (miNATNetworksStarted < 1)
12970 {
12971 for (ULONG slot = 0; slot < mNetworkAdapters.size(); ++slot)
12972 {
12973 NetworkAttachmentType_T type;
12974 HRESULT hrc;
12975 hrc = mNetworkAdapters[slot]->COMGETTER(AttachmentType)(&type);
12976 if ( SUCCEEDED(hrc)
12977 && type == NetworkAttachmentType_NATNetwork)
12978 {
12979 Bstr name;
12980 hrc = mNetworkAdapters[slot]->COMGETTER(NATNetwork)(name.asOutParam());
12981 if (SUCCEEDED(hrc))
12982 {
12983 LogRel(("VM '%s' starts using NAT network '%ls'\n",
12984 mUserData->s.strName.c_str(), name.raw()));
12985 mPeer->lockHandle()->unlockWrite();
12986 mParent->i_natNetworkRefInc(name.raw());
12987#ifdef RT_LOCK_STRICT
12988 mPeer->lockHandle()->lockWrite(RT_SRC_POS);
12989#else
12990 mPeer->lockHandle()->lockWrite();
12991#endif
12992 }
12993 }
12994 }
12995 miNATNetworksStarted++;
12996 }
12997
12998 LogFlowThisFunc(("returns S_OK.\n"));
12999 return S_OK;
13000}
13001
13002/**
13003 * @note Locks this object for writing.
13004 */
13005HRESULT SessionMachine::endPowerUp(LONG aResult)
13006{
13007 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
13008
13009 if (mData->mSession.mState != SessionState_Locked)
13010 return VBOX_E_INVALID_OBJECT_STATE;
13011
13012 /* Finalize the LaunchVMProcess progress object. */
13013 if (mData->mSession.mProgress)
13014 {
13015 mData->mSession.mProgress->notifyComplete((HRESULT)aResult);
13016 mData->mSession.mProgress.setNull();
13017 }
13018
13019 if (SUCCEEDED((HRESULT)aResult))
13020 {
13021#ifdef VBOX_WITH_RESOURCE_USAGE_API
13022 /* The VM has been powered up successfully, so it makes sense
13023 * now to offer the performance metrics for a running machine
13024 * object. Doing it earlier wouldn't be safe. */
13025 i_registerMetrics(mParent->i_performanceCollector(), mPeer,
13026 mData->mSession.mPID);
13027#endif /* VBOX_WITH_RESOURCE_USAGE_API */
13028 }
13029
13030 return S_OK;
13031}
13032
13033/**
13034 * @note Locks this object for writing.
13035 */
13036HRESULT SessionMachine::beginPoweringDown(ComPtr<IProgress> &aProgress)
13037{
13038 LogFlowThisFuncEnter();
13039
13040 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
13041
13042 AssertReturn(mConsoleTaskData.mLastState == MachineState_Null,
13043 E_FAIL);
13044
13045 /* create a progress object to track operation completion */
13046 ComObjPtr<Progress> pProgress;
13047 pProgress.createObject();
13048 pProgress->init(i_getVirtualBox(),
13049 static_cast<IMachine *>(this) /* aInitiator */,
13050 Bstr(tr("Stopping the virtual machine")).raw(),
13051 FALSE /* aCancelable */);
13052
13053 /* fill in the console task data */
13054 mConsoleTaskData.mLastState = mData->mMachineState;
13055 mConsoleTaskData.mProgress = pProgress;
13056
13057 /* set the state to Stopping (this is expected by Console::PowerDown()) */
13058 i_setMachineState(MachineState_Stopping);
13059
13060 pProgress.queryInterfaceTo(aProgress.asOutParam());
13061
13062 return S_OK;
13063}
13064
13065/**
13066 * @note Locks this object for writing.
13067 */
13068HRESULT SessionMachine::endPoweringDown(LONG aResult,
13069 const com::Utf8Str &aErrMsg)
13070{
13071 LogFlowThisFuncEnter();
13072
13073 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
13074
13075 AssertReturn( ( (SUCCEEDED(aResult) && mData->mMachineState == MachineState_PoweredOff)
13076 || (FAILED(aResult) && mData->mMachineState == MachineState_Stopping))
13077 && mConsoleTaskData.mLastState != MachineState_Null,
13078 E_FAIL);
13079
13080 /*
13081 * On failure, set the state to the state we had when BeginPoweringDown()
13082 * was called (this is expected by Console::PowerDown() and the associated
13083 * task). On success the VM process already changed the state to
13084 * MachineState_PoweredOff, so no need to do anything.
13085 */
13086 if (FAILED(aResult))
13087 i_setMachineState(mConsoleTaskData.mLastState);
13088
13089 /* notify the progress object about operation completion */
13090 Assert(mConsoleTaskData.mProgress);
13091 if (SUCCEEDED(aResult))
13092 mConsoleTaskData.mProgress->i_notifyComplete(S_OK);
13093 else
13094 {
13095 if (aErrMsg.length())
13096 mConsoleTaskData.mProgress->i_notifyComplete(aResult,
13097 COM_IIDOF(ISession),
13098 getComponentName(),
13099 aErrMsg.c_str());
13100 else
13101 mConsoleTaskData.mProgress->i_notifyComplete(aResult);
13102 }
13103
13104 /* clear out the temporary saved state data */
13105 mConsoleTaskData.mLastState = MachineState_Null;
13106 mConsoleTaskData.mProgress.setNull();
13107
13108 LogFlowThisFuncLeave();
13109 return S_OK;
13110}
13111
13112
13113/**
13114 * Goes through the USB filters of the given machine to see if the given
13115 * device matches any filter or not.
13116 *
13117 * @note Locks the same as USBController::hasMatchingFilter() does.
13118 */
13119HRESULT SessionMachine::runUSBDeviceFilters(const ComPtr<IUSBDevice> &aDevice,
13120 BOOL *aMatched,
13121 ULONG *aMaskedInterfaces)
13122{
13123 LogFlowThisFunc(("\n"));
13124
13125#ifdef VBOX_WITH_USB
13126 *aMatched = mUSBDeviceFilters->i_hasMatchingFilter(aDevice, aMaskedInterfaces);
13127#else
13128 NOREF(aDevice);
13129 NOREF(aMaskedInterfaces);
13130 *aMatched = FALSE;
13131#endif
13132
13133 return S_OK;
13134}
13135
13136/**
13137 * @note Locks the same as Host::captureUSBDevice() does.
13138 */
13139HRESULT SessionMachine::captureUSBDevice(const com::Guid &aId, const com::Utf8Str &aCaptureFilename)
13140{
13141 LogFlowThisFunc(("\n"));
13142
13143#ifdef VBOX_WITH_USB
13144 /* if captureDeviceForVM() fails, it must have set extended error info */
13145 clearError();
13146 MultiResult rc = mParent->i_host()->i_checkUSBProxyService();
13147 if (FAILED(rc)) return rc;
13148
13149 USBProxyService *service = mParent->i_host()->i_usbProxyService();
13150 AssertReturn(service, E_FAIL);
13151 return service->captureDeviceForVM(this, aId.ref(), aCaptureFilename);
13152#else
13153 NOREF(aId);
13154 return E_NOTIMPL;
13155#endif
13156}
13157
13158/**
13159 * @note Locks the same as Host::detachUSBDevice() does.
13160 */
13161HRESULT SessionMachine::detachUSBDevice(const com::Guid &aId,
13162 BOOL aDone)
13163{
13164 LogFlowThisFunc(("\n"));
13165
13166#ifdef VBOX_WITH_USB
13167 USBProxyService *service = mParent->i_host()->i_usbProxyService();
13168 AssertReturn(service, E_FAIL);
13169 return service->detachDeviceFromVM(this, aId.ref(), !!aDone);
13170#else
13171 NOREF(aId);
13172 NOREF(aDone);
13173 return E_NOTIMPL;
13174#endif
13175}
13176
13177/**
13178 * Inserts all machine filters to the USB proxy service and then calls
13179 * Host::autoCaptureUSBDevices().
13180 *
13181 * Called by Console from the VM process upon VM startup.
13182 *
13183 * @note Locks what called methods lock.
13184 */
13185HRESULT SessionMachine::autoCaptureUSBDevices()
13186{
13187 LogFlowThisFunc(("\n"));
13188
13189#ifdef VBOX_WITH_USB
13190 HRESULT rc = mUSBDeviceFilters->i_notifyProxy(true /* aInsertFilters */);
13191 AssertComRC(rc);
13192 NOREF(rc);
13193
13194 USBProxyService *service = mParent->i_host()->i_usbProxyService();
13195 AssertReturn(service, E_FAIL);
13196 return service->autoCaptureDevicesForVM(this);
13197#else
13198 return S_OK;
13199#endif
13200}
13201
13202/**
13203 * Removes all machine filters from the USB proxy service and then calls
13204 * Host::detachAllUSBDevices().
13205 *
13206 * Called by Console from the VM process upon normal VM termination or by
13207 * SessionMachine::uninit() upon abnormal VM termination (from under the
13208 * Machine/SessionMachine lock).
13209 *
13210 * @note Locks what called methods lock.
13211 */
13212HRESULT SessionMachine::detachAllUSBDevices(BOOL aDone)
13213{
13214 LogFlowThisFunc(("\n"));
13215
13216#ifdef VBOX_WITH_USB
13217 HRESULT rc = mUSBDeviceFilters->i_notifyProxy(false /* aInsertFilters */);
13218 AssertComRC(rc);
13219 NOREF(rc);
13220
13221 USBProxyService *service = mParent->i_host()->i_usbProxyService();
13222 AssertReturn(service, E_FAIL);
13223 return service->detachAllDevicesFromVM(this, !!aDone, false /* aAbnormal */);
13224#else
13225 NOREF(aDone);
13226 return S_OK;
13227#endif
13228}
13229
13230/**
13231 * @note Locks this object for writing.
13232 */
13233HRESULT SessionMachine::onSessionEnd(const ComPtr<ISession> &aSession,
13234 ComPtr<IProgress> &aProgress)
13235{
13236 LogFlowThisFuncEnter();
13237
13238 LogFlowThisFunc(("callerstate=%d\n", getObjectState().getState()));
13239 /*
13240 * We don't assert below because it might happen that a non-direct session
13241 * informs us it is closed right after we've been uninitialized -- it's ok.
13242 */
13243
13244 /* get IInternalSessionControl interface */
13245 ComPtr<IInternalSessionControl> control(aSession);
13246
13247 ComAssertRet(!control.isNull(), E_INVALIDARG);
13248
13249 /* Creating a Progress object requires the VirtualBox lock, and
13250 * thus locking it here is required by the lock order rules. */
13251 AutoMultiWriteLock2 alock(mParent, this COMMA_LOCKVAL_SRC_POS);
13252
13253 if (control == mData->mSession.mDirectControl)
13254 {
13255 /* The direct session is being normally closed by the client process
13256 * ----------------------------------------------------------------- */
13257
13258 /* go to the closing state (essential for all open*Session() calls and
13259 * for #checkForDeath()) */
13260 Assert(mData->mSession.mState == SessionState_Locked);
13261 mData->mSession.mState = SessionState_Unlocking;
13262
13263 /* set direct control to NULL to release the remote instance */
13264 mData->mSession.mDirectControl.setNull();
13265 LogFlowThisFunc(("Direct control is set to NULL\n"));
13266
13267 if (mData->mSession.mProgress)
13268 {
13269 /* finalize the progress, someone might wait if a frontend
13270 * closes the session before powering on the VM. */
13271 mData->mSession.mProgress->notifyComplete(E_FAIL,
13272 COM_IIDOF(ISession),
13273 getComponentName(),
13274 tr("The VM session was closed before any attempt to power it on"));
13275 mData->mSession.mProgress.setNull();
13276 }
13277
13278 /* Create the progress object the client will use to wait until
13279 * #checkForDeath() is called to uninitialize this session object after
13280 * it releases the IPC semaphore.
13281 * Note! Because we're "reusing" mProgress here, this must be a proxy
13282 * object just like for LaunchVMProcess. */
13283 Assert(mData->mSession.mProgress.isNull());
13284 ComObjPtr<ProgressProxy> progress;
13285 progress.createObject();
13286 ComPtr<IUnknown> pPeer(mPeer);
13287 progress->init(mParent, pPeer,
13288 Bstr(tr("Closing session")).raw(),
13289 FALSE /* aCancelable */);
13290 progress.queryInterfaceTo(aProgress.asOutParam());
13291 mData->mSession.mProgress = progress;
13292 }
13293 else
13294 {
13295 /* the remote session is being normally closed */
13296 Data::Session::RemoteControlList::iterator it =
13297 mData->mSession.mRemoteControls.begin();
13298 while (it != mData->mSession.mRemoteControls.end())
13299 {
13300 if (control == *it)
13301 break;
13302 ++it;
13303 }
13304 BOOL found = it != mData->mSession.mRemoteControls.end();
13305 ComAssertMsgRet(found, ("The session is not found in the session list!"),
13306 E_INVALIDARG);
13307 // This MUST be erase(it), not remove(*it) as the latter triggers a
13308 // very nasty use after free due to the place where the value "lives".
13309 mData->mSession.mRemoteControls.erase(it);
13310 }
13311
13312 /* signal the client watcher thread, because the client is going away */
13313 mParent->i_updateClientWatcher();
13314
13315 LogFlowThisFuncLeave();
13316 return S_OK;
13317}
13318
13319HRESULT SessionMachine::pullGuestProperties(std::vector<com::Utf8Str> &aNames,
13320 std::vector<com::Utf8Str> &aValues,
13321 std::vector<LONG64> &aTimestamps,
13322 std::vector<com::Utf8Str> &aFlags)
13323{
13324 LogFlowThisFunc(("\n"));
13325
13326#ifdef VBOX_WITH_GUEST_PROPS
13327 using namespace guestProp;
13328
13329 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13330
13331 size_t cEntries = mHWData->mGuestProperties.size();
13332 aNames.resize(cEntries);
13333 aValues.resize(cEntries);
13334 aTimestamps.resize(cEntries);
13335 aFlags.resize(cEntries);
13336
13337 size_t i = 0;
13338 for (HWData::GuestPropertyMap::iterator it = mHWData->mGuestProperties.begin();
13339 it != mHWData->mGuestProperties.end();
13340 ++it, ++i)
13341 {
13342 char szFlags[MAX_FLAGS_LEN + 1];
13343 aNames[i] = it->first;
13344 aValues[i] = it->second.strValue;
13345 aTimestamps[i] = it->second.mTimestamp;
13346
13347 /* If it is NULL, keep it NULL. */
13348 if (it->second.mFlags)
13349 {
13350 writeFlags(it->second.mFlags, szFlags);
13351 aFlags[i] = szFlags;
13352 }
13353 else
13354 aFlags[i] = "";
13355 }
13356 return S_OK;
13357#else
13358 ReturnComNotImplemented();
13359#endif
13360}
13361
13362HRESULT SessionMachine::pushGuestProperty(const com::Utf8Str &aName,
13363 const com::Utf8Str &aValue,
13364 LONG64 aTimestamp,
13365 const com::Utf8Str &aFlags)
13366{
13367 LogFlowThisFunc(("\n"));
13368
13369#ifdef VBOX_WITH_GUEST_PROPS
13370 using namespace guestProp;
13371
13372 try
13373 {
13374 /*
13375 * Convert input up front.
13376 */
13377 uint32_t fFlags = NILFLAG;
13378 if (aFlags.length())
13379 {
13380 int vrc = validateFlags(aFlags.c_str(), &fFlags);
13381 AssertRCReturn(vrc, E_INVALIDARG);
13382 }
13383
13384 /*
13385 * Now grab the object lock, validate the state and do the update.
13386 */
13387
13388 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
13389
13390 switch (mData->mMachineState)
13391 {
13392 case MachineState_Paused:
13393 case MachineState_Running:
13394 case MachineState_Teleporting:
13395 case MachineState_TeleportingPausedVM:
13396 case MachineState_OnlineSnapshotting:
13397 case MachineState_LiveSnapshotting:
13398 case MachineState_DeletingSnapshotOnline:
13399 case MachineState_DeletingSnapshotPaused:
13400 case MachineState_Saving:
13401 case MachineState_Stopping:
13402 break;
13403
13404 default:
13405 AssertMsgFailedReturn(("%s\n", Global::stringifyMachineState(mData->mMachineState)),
13406 VBOX_E_INVALID_VM_STATE);
13407 }
13408
13409 i_setModified(IsModified_MachineData);
13410 mHWData.backup();
13411
13412 bool fDelete = !aValue.length();
13413 HWData::GuestPropertyMap::iterator it = mHWData->mGuestProperties.find(aName);
13414 if (it != mHWData->mGuestProperties.end())
13415 {
13416 if (!fDelete)
13417 {
13418 it->second.strValue = aValue;
13419 it->second.mTimestamp = aTimestamp;
13420 it->second.mFlags = fFlags;
13421 }
13422 else
13423 mHWData->mGuestProperties.erase(it);
13424
13425 mData->mGuestPropertiesModified = TRUE;
13426 }
13427 else if (!fDelete)
13428 {
13429 HWData::GuestProperty prop;
13430 prop.strValue = aValue;
13431 prop.mTimestamp = aTimestamp;
13432 prop.mFlags = fFlags;
13433
13434 mHWData->mGuestProperties[aName] = prop;
13435 mData->mGuestPropertiesModified = TRUE;
13436 }
13437
13438 alock.release();
13439
13440 mParent->i_onGuestPropertyChange(mData->mUuid,
13441 Bstr(aName).raw(),
13442 Bstr(aValue).raw(),
13443 Bstr(aFlags).raw());
13444 }
13445 catch (...)
13446 {
13447 return VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
13448 }
13449 return S_OK;
13450#else
13451 ReturnComNotImplemented();
13452#endif
13453}
13454
13455
13456HRESULT SessionMachine::lockMedia()
13457{
13458 AutoMultiWriteLock2 alock(this->lockHandle(),
13459 &mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
13460
13461 AssertReturn( mData->mMachineState == MachineState_Starting
13462 || mData->mMachineState == MachineState_Restoring
13463 || mData->mMachineState == MachineState_TeleportingIn, E_FAIL);
13464
13465 clearError();
13466 alock.release();
13467 return i_lockMedia();
13468}
13469
13470HRESULT SessionMachine::unlockMedia()
13471{
13472 HRESULT hrc = i_unlockMedia();
13473 return hrc;
13474}
13475
13476HRESULT SessionMachine::ejectMedium(const ComPtr<IMediumAttachment> &aAttachment,
13477 ComPtr<IMediumAttachment> &aNewAttachment)
13478{
13479 // request the host lock first, since might be calling Host methods for getting host drives;
13480 // next, protect the media tree all the while we're in here, as well as our member variables
13481 AutoMultiWriteLock3 multiLock(mParent->i_host()->lockHandle(),
13482 this->lockHandle(),
13483 &mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
13484
13485 IMediumAttachment *iAttach = aAttachment;
13486 ComObjPtr<MediumAttachment> pAttach = static_cast<MediumAttachment *>(iAttach);
13487
13488 Bstr ctrlName;
13489 LONG lPort;
13490 LONG lDevice;
13491 bool fTempEject;
13492 {
13493 AutoReadLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
13494
13495 /* Need to query the details first, as the IMediumAttachment reference
13496 * might be to the original settings, which we are going to change. */
13497 ctrlName = pAttach->i_getControllerName();
13498 lPort = pAttach->i_getPort();
13499 lDevice = pAttach->i_getDevice();
13500 fTempEject = pAttach->i_getTempEject();
13501 }
13502
13503 if (!fTempEject)
13504 {
13505 /* Remember previously mounted medium. The medium before taking the
13506 * backup is not necessarily the same thing. */
13507 ComObjPtr<Medium> oldmedium;
13508 oldmedium = pAttach->i_getMedium();
13509
13510 i_setModified(IsModified_Storage);
13511 mMediaData.backup();
13512
13513 // The backup operation makes the pAttach reference point to the
13514 // old settings. Re-get the correct reference.
13515 pAttach = i_findAttachment(mMediaData->mAttachments,
13516 ctrlName.raw(),
13517 lPort,
13518 lDevice);
13519
13520 {
13521 AutoCaller autoAttachCaller(this);
13522 if (FAILED(autoAttachCaller.rc())) return autoAttachCaller.rc();
13523
13524 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
13525 if (!oldmedium.isNull())
13526 oldmedium->i_removeBackReference(mData->mUuid);
13527
13528 pAttach->i_updateMedium(NULL);
13529 pAttach->i_updateEjected();
13530 }
13531
13532 i_setModified(IsModified_Storage);
13533 }
13534 else
13535 {
13536 {
13537 AutoWriteLock attLock(pAttach COMMA_LOCKVAL_SRC_POS);
13538 pAttach->i_updateEjected();
13539 }
13540 }
13541
13542 pAttach.queryInterfaceTo(aNewAttachment.asOutParam());
13543
13544 return S_OK;
13545}
13546
13547// public methods only for internal purposes
13548/////////////////////////////////////////////////////////////////////////////
13549
13550#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
13551/**
13552 * Called from the client watcher thread to check for expected or unexpected
13553 * death of the client process that has a direct session to this machine.
13554 *
13555 * On Win32 and on OS/2, this method is called only when we've got the
13556 * mutex (i.e. the client has either died or terminated normally) so it always
13557 * returns @c true (the client is terminated, the session machine is
13558 * uninitialized).
13559 *
13560 * On other platforms, the method returns @c true if the client process has
13561 * terminated normally or abnormally and the session machine was uninitialized,
13562 * and @c false if the client process is still alive.
13563 *
13564 * @note Locks this object for writing.
13565 */
13566bool SessionMachine::i_checkForDeath()
13567{
13568 Uninit::Reason reason;
13569 bool terminated = false;
13570
13571 /* Enclose autoCaller with a block because calling uninit() from under it
13572 * will deadlock. */
13573 {
13574 AutoCaller autoCaller(this);
13575 if (!autoCaller.isOk())
13576 {
13577 /* return true if not ready, to cause the client watcher to exclude
13578 * the corresponding session from watching */
13579 LogFlowThisFunc(("Already uninitialized!\n"));
13580 return true;
13581 }
13582
13583 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
13584
13585 /* Determine the reason of death: if the session state is Closing here,
13586 * everything is fine. Otherwise it means that the client did not call
13587 * OnSessionEnd() before it released the IPC semaphore. This may happen
13588 * either because the client process has abnormally terminated, or
13589 * because it simply forgot to call ISession::Close() before exiting. We
13590 * threat the latter also as an abnormal termination (see
13591 * Session::uninit() for details). */
13592 reason = mData->mSession.mState == SessionState_Unlocking ?
13593 Uninit::Normal :
13594 Uninit::Abnormal;
13595
13596 if (mClientToken)
13597 terminated = mClientToken->release();
13598 } /* AutoCaller block */
13599
13600 if (terminated)
13601 uninit(reason);
13602
13603 return terminated;
13604}
13605
13606void SessionMachine::i_getTokenId(Utf8Str &strTokenId)
13607{
13608 LogFlowThisFunc(("\n"));
13609
13610 strTokenId.setNull();
13611
13612 AutoCaller autoCaller(this);
13613 AssertComRCReturnVoid(autoCaller.rc());
13614
13615 Assert(mClientToken);
13616 if (mClientToken)
13617 mClientToken->getId(strTokenId);
13618}
13619#else /* VBOX_WITH_GENERIC_SESSION_WATCHER */
13620IToken *SessionMachine::i_getToken()
13621{
13622 LogFlowThisFunc(("\n"));
13623
13624 AutoCaller autoCaller(this);
13625 AssertComRCReturn(autoCaller.rc(), NULL);
13626
13627 Assert(mClientToken);
13628 if (mClientToken)
13629 return mClientToken->getToken();
13630 else
13631 return NULL;
13632}
13633#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
13634
13635Machine::ClientToken *SessionMachine::i_getClientToken()
13636{
13637 LogFlowThisFunc(("\n"));
13638
13639 AutoCaller autoCaller(this);
13640 AssertComRCReturn(autoCaller.rc(), NULL);
13641
13642 return mClientToken;
13643}
13644
13645
13646/**
13647 * @note Locks this object for reading.
13648 */
13649HRESULT SessionMachine::i_onNetworkAdapterChange(INetworkAdapter *networkAdapter, BOOL changeAdapter)
13650{
13651 LogFlowThisFunc(("\n"));
13652
13653 AutoCaller autoCaller(this);
13654 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13655
13656 ComPtr<IInternalSessionControl> directControl;
13657 {
13658 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13659 if (mData->mSession.mLockType == LockType_VM)
13660 directControl = mData->mSession.mDirectControl;
13661 }
13662
13663 /* ignore notifications sent after #OnSessionEnd() is called */
13664 if (!directControl)
13665 return S_OK;
13666
13667 return directControl->OnNetworkAdapterChange(networkAdapter, changeAdapter);
13668}
13669
13670/**
13671 * @note Locks this object for reading.
13672 */
13673HRESULT SessionMachine::i_onNATRedirectRuleChange(ULONG ulSlot, BOOL aNatRuleRemove, IN_BSTR aRuleName,
13674 NATProtocol_T aProto, IN_BSTR aHostIp, LONG aHostPort,
13675 IN_BSTR aGuestIp, LONG aGuestPort)
13676{
13677 LogFlowThisFunc(("\n"));
13678
13679 AutoCaller autoCaller(this);
13680 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13681
13682 ComPtr<IInternalSessionControl> directControl;
13683 {
13684 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13685 if (mData->mSession.mLockType == LockType_VM)
13686 directControl = mData->mSession.mDirectControl;
13687 }
13688
13689 /* ignore notifications sent after #OnSessionEnd() is called */
13690 if (!directControl)
13691 return S_OK;
13692 /*
13693 * instead acting like callback we ask IVirtualBox deliver corresponding event
13694 */
13695
13696 mParent->i_onNatRedirectChange(i_getId(), ulSlot, RT_BOOL(aNatRuleRemove), aRuleName, aProto, aHostIp,
13697 (uint16_t)aHostPort, aGuestIp, (uint16_t)aGuestPort);
13698 return S_OK;
13699}
13700
13701/**
13702 * @note Locks this object for reading.
13703 */
13704HRESULT SessionMachine::i_onSerialPortChange(ISerialPort *serialPort)
13705{
13706 LogFlowThisFunc(("\n"));
13707
13708 AutoCaller autoCaller(this);
13709 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13710
13711 ComPtr<IInternalSessionControl> directControl;
13712 {
13713 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13714 if (mData->mSession.mLockType == LockType_VM)
13715 directControl = mData->mSession.mDirectControl;
13716 }
13717
13718 /* ignore notifications sent after #OnSessionEnd() is called */
13719 if (!directControl)
13720 return S_OK;
13721
13722 return directControl->OnSerialPortChange(serialPort);
13723}
13724
13725/**
13726 * @note Locks this object for reading.
13727 */
13728HRESULT SessionMachine::i_onParallelPortChange(IParallelPort *parallelPort)
13729{
13730 LogFlowThisFunc(("\n"));
13731
13732 AutoCaller autoCaller(this);
13733 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13734
13735 ComPtr<IInternalSessionControl> directControl;
13736 {
13737 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13738 if (mData->mSession.mLockType == LockType_VM)
13739 directControl = mData->mSession.mDirectControl;
13740 }
13741
13742 /* ignore notifications sent after #OnSessionEnd() is called */
13743 if (!directControl)
13744 return S_OK;
13745
13746 return directControl->OnParallelPortChange(parallelPort);
13747}
13748
13749/**
13750 * @note Locks this object for reading.
13751 */
13752HRESULT SessionMachine::i_onStorageControllerChange()
13753{
13754 LogFlowThisFunc(("\n"));
13755
13756 AutoCaller autoCaller(this);
13757 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13758
13759 ComPtr<IInternalSessionControl> directControl;
13760 {
13761 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13762 if (mData->mSession.mLockType == LockType_VM)
13763 directControl = mData->mSession.mDirectControl;
13764 }
13765
13766 /* ignore notifications sent after #OnSessionEnd() is called */
13767 if (!directControl)
13768 return S_OK;
13769
13770 return directControl->OnStorageControllerChange();
13771}
13772
13773/**
13774 * @note Locks this object for reading.
13775 */
13776HRESULT SessionMachine::i_onMediumChange(IMediumAttachment *aAttachment, BOOL aForce)
13777{
13778 LogFlowThisFunc(("\n"));
13779
13780 AutoCaller autoCaller(this);
13781 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13782
13783 ComPtr<IInternalSessionControl> directControl;
13784 {
13785 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13786 if (mData->mSession.mLockType == LockType_VM)
13787 directControl = mData->mSession.mDirectControl;
13788 }
13789
13790 /* ignore notifications sent after #OnSessionEnd() is called */
13791 if (!directControl)
13792 return S_OK;
13793
13794 return directControl->OnMediumChange(aAttachment, aForce);
13795}
13796
13797/**
13798 * @note Locks this object for reading.
13799 */
13800HRESULT SessionMachine::i_onCPUChange(ULONG aCPU, BOOL aRemove)
13801{
13802 LogFlowThisFunc(("\n"));
13803
13804 AutoCaller autoCaller(this);
13805 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13806
13807 ComPtr<IInternalSessionControl> directControl;
13808 {
13809 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13810 if (mData->mSession.mLockType == LockType_VM)
13811 directControl = mData->mSession.mDirectControl;
13812 }
13813
13814 /* ignore notifications sent after #OnSessionEnd() is called */
13815 if (!directControl)
13816 return S_OK;
13817
13818 return directControl->OnCPUChange(aCPU, aRemove);
13819}
13820
13821HRESULT SessionMachine::i_onCPUExecutionCapChange(ULONG aExecutionCap)
13822{
13823 LogFlowThisFunc(("\n"));
13824
13825 AutoCaller autoCaller(this);
13826 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13827
13828 ComPtr<IInternalSessionControl> directControl;
13829 {
13830 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13831 if (mData->mSession.mLockType == LockType_VM)
13832 directControl = mData->mSession.mDirectControl;
13833 }
13834
13835 /* ignore notifications sent after #OnSessionEnd() is called */
13836 if (!directControl)
13837 return S_OK;
13838
13839 return directControl->OnCPUExecutionCapChange(aExecutionCap);
13840}
13841
13842/**
13843 * @note Locks this object for reading.
13844 */
13845HRESULT SessionMachine::i_onVRDEServerChange(BOOL aRestart)
13846{
13847 LogFlowThisFunc(("\n"));
13848
13849 AutoCaller autoCaller(this);
13850 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13851
13852 ComPtr<IInternalSessionControl> directControl;
13853 {
13854 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13855 if (mData->mSession.mLockType == LockType_VM)
13856 directControl = mData->mSession.mDirectControl;
13857 }
13858
13859 /* ignore notifications sent after #OnSessionEnd() is called */
13860 if (!directControl)
13861 return S_OK;
13862
13863 return directControl->OnVRDEServerChange(aRestart);
13864}
13865
13866/**
13867 * @note Locks this object for reading.
13868 */
13869HRESULT SessionMachine::i_onVideoCaptureChange()
13870{
13871 LogFlowThisFunc(("\n"));
13872
13873 AutoCaller autoCaller(this);
13874 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13875
13876 ComPtr<IInternalSessionControl> directControl;
13877 {
13878 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13879 if (mData->mSession.mLockType == LockType_VM)
13880 directControl = mData->mSession.mDirectControl;
13881 }
13882
13883 /* ignore notifications sent after #OnSessionEnd() is called */
13884 if (!directControl)
13885 return S_OK;
13886
13887 return directControl->OnVideoCaptureChange();
13888}
13889
13890/**
13891 * @note Locks this object for reading.
13892 */
13893HRESULT SessionMachine::i_onUSBControllerChange()
13894{
13895 LogFlowThisFunc(("\n"));
13896
13897 AutoCaller autoCaller(this);
13898 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13899
13900 ComPtr<IInternalSessionControl> directControl;
13901 {
13902 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13903 if (mData->mSession.mLockType == LockType_VM)
13904 directControl = mData->mSession.mDirectControl;
13905 }
13906
13907 /* ignore notifications sent after #OnSessionEnd() is called */
13908 if (!directControl)
13909 return S_OK;
13910
13911 return directControl->OnUSBControllerChange();
13912}
13913
13914/**
13915 * @note Locks this object for reading.
13916 */
13917HRESULT SessionMachine::i_onSharedFolderChange()
13918{
13919 LogFlowThisFunc(("\n"));
13920
13921 AutoCaller autoCaller(this);
13922 AssertComRCReturnRC(autoCaller.rc());
13923
13924 ComPtr<IInternalSessionControl> directControl;
13925 {
13926 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13927 if (mData->mSession.mLockType == LockType_VM)
13928 directControl = mData->mSession.mDirectControl;
13929 }
13930
13931 /* ignore notifications sent after #OnSessionEnd() is called */
13932 if (!directControl)
13933 return S_OK;
13934
13935 return directControl->OnSharedFolderChange(FALSE /* aGlobal */);
13936}
13937
13938/**
13939 * @note Locks this object for reading.
13940 */
13941HRESULT SessionMachine::i_onClipboardModeChange(ClipboardMode_T aClipboardMode)
13942{
13943 LogFlowThisFunc(("\n"));
13944
13945 AutoCaller autoCaller(this);
13946 AssertComRCReturnRC(autoCaller.rc());
13947
13948 ComPtr<IInternalSessionControl> directControl;
13949 {
13950 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13951 if (mData->mSession.mLockType == LockType_VM)
13952 directControl = mData->mSession.mDirectControl;
13953 }
13954
13955 /* ignore notifications sent after #OnSessionEnd() is called */
13956 if (!directControl)
13957 return S_OK;
13958
13959 return directControl->OnClipboardModeChange(aClipboardMode);
13960}
13961
13962/**
13963 * @note Locks this object for reading.
13964 */
13965HRESULT SessionMachine::i_onDnDModeChange(DnDMode_T aDnDMode)
13966{
13967 LogFlowThisFunc(("\n"));
13968
13969 AutoCaller autoCaller(this);
13970 AssertComRCReturnRC(autoCaller.rc());
13971
13972 ComPtr<IInternalSessionControl> directControl;
13973 {
13974 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13975 if (mData->mSession.mLockType == LockType_VM)
13976 directControl = mData->mSession.mDirectControl;
13977 }
13978
13979 /* ignore notifications sent after #OnSessionEnd() is called */
13980 if (!directControl)
13981 return S_OK;
13982
13983 return directControl->OnDnDModeChange(aDnDMode);
13984}
13985
13986/**
13987 * @note Locks this object for reading.
13988 */
13989HRESULT SessionMachine::i_onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup)
13990{
13991 LogFlowThisFunc(("\n"));
13992
13993 AutoCaller autoCaller(this);
13994 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
13995
13996 ComPtr<IInternalSessionControl> directControl;
13997 {
13998 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
13999 if (mData->mSession.mLockType == LockType_VM)
14000 directControl = mData->mSession.mDirectControl;
14001 }
14002
14003 /* ignore notifications sent after #OnSessionEnd() is called */
14004 if (!directControl)
14005 return S_OK;
14006
14007 return directControl->OnBandwidthGroupChange(aBandwidthGroup);
14008}
14009
14010/**
14011 * @note Locks this object for reading.
14012 */
14013HRESULT SessionMachine::i_onStorageDeviceChange(IMediumAttachment *aAttachment, BOOL aRemove, BOOL aSilent)
14014{
14015 LogFlowThisFunc(("\n"));
14016
14017 AutoCaller autoCaller(this);
14018 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
14019
14020 ComPtr<IInternalSessionControl> directControl;
14021 {
14022 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
14023 if (mData->mSession.mLockType == LockType_VM)
14024 directControl = mData->mSession.mDirectControl;
14025 }
14026
14027 /* ignore notifications sent after #OnSessionEnd() is called */
14028 if (!directControl)
14029 return S_OK;
14030
14031 return directControl->OnStorageDeviceChange(aAttachment, aRemove, aSilent);
14032}
14033
14034/**
14035 * Returns @c true if this machine's USB controller reports it has a matching
14036 * filter for the given USB device and @c false otherwise.
14037 *
14038 * @note locks this object for reading.
14039 */
14040bool SessionMachine::i_hasMatchingUSBFilter(const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs)
14041{
14042 AutoCaller autoCaller(this);
14043 /* silently return if not ready -- this method may be called after the
14044 * direct machine session has been called */
14045 if (!autoCaller.isOk())
14046 return false;
14047
14048#ifdef VBOX_WITH_USB
14049 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
14050
14051 switch (mData->mMachineState)
14052 {
14053 case MachineState_Starting:
14054 case MachineState_Restoring:
14055 case MachineState_TeleportingIn:
14056 case MachineState_Paused:
14057 case MachineState_Running:
14058 /** @todo Live Migration: snapshoting & teleporting. Need to fend things of
14059 * elsewhere... */
14060 alock.release();
14061 return mUSBDeviceFilters->i_hasMatchingFilter(aDevice, aMaskedIfs);
14062 default: break;
14063 }
14064#else
14065 NOREF(aDevice);
14066 NOREF(aMaskedIfs);
14067#endif
14068 return false;
14069}
14070
14071/**
14072 * @note The calls shall hold no locks. Will temporarily lock this object for reading.
14073 */
14074HRESULT SessionMachine::i_onUSBDeviceAttach(IUSBDevice *aDevice,
14075 IVirtualBoxErrorInfo *aError,
14076 ULONG aMaskedIfs,
14077 const com::Utf8Str &aCaptureFilename)
14078{
14079 LogFlowThisFunc(("\n"));
14080
14081 AutoCaller autoCaller(this);
14082
14083 /* This notification may happen after the machine object has been
14084 * uninitialized (the session was closed), so don't assert. */
14085 if (FAILED(autoCaller.rc())) return autoCaller.rc();
14086
14087 ComPtr<IInternalSessionControl> directControl;
14088 {
14089 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
14090 if (mData->mSession.mLockType == LockType_VM)
14091 directControl = mData->mSession.mDirectControl;
14092 }
14093
14094 /* fail on notifications sent after #OnSessionEnd() is called, it is
14095 * expected by the caller */
14096 if (!directControl)
14097 return E_FAIL;
14098
14099 /* No locks should be held at this point. */
14100 AssertMsg(RTLockValidatorWriteLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorWriteLockGetCount(RTThreadSelf())));
14101 AssertMsg(RTLockValidatorReadLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorReadLockGetCount(RTThreadSelf())));
14102
14103 return directControl->OnUSBDeviceAttach(aDevice, aError, aMaskedIfs, Bstr(aCaptureFilename).raw());
14104}
14105
14106/**
14107 * @note The calls shall hold no locks. Will temporarily lock this object for reading.
14108 */
14109HRESULT SessionMachine::i_onUSBDeviceDetach(IN_BSTR aId,
14110 IVirtualBoxErrorInfo *aError)
14111{
14112 LogFlowThisFunc(("\n"));
14113
14114 AutoCaller autoCaller(this);
14115
14116 /* This notification may happen after the machine object has been
14117 * uninitialized (the session was closed), so don't assert. */
14118 if (FAILED(autoCaller.rc())) return autoCaller.rc();
14119
14120 ComPtr<IInternalSessionControl> directControl;
14121 {
14122 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
14123 if (mData->mSession.mLockType == LockType_VM)
14124 directControl = mData->mSession.mDirectControl;
14125 }
14126
14127 /* fail on notifications sent after #OnSessionEnd() is called, it is
14128 * expected by the caller */
14129 if (!directControl)
14130 return E_FAIL;
14131
14132 /* No locks should be held at this point. */
14133 AssertMsg(RTLockValidatorWriteLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorWriteLockGetCount(RTThreadSelf())));
14134 AssertMsg(RTLockValidatorReadLockGetCount(RTThreadSelf()) == 0, ("%d\n", RTLockValidatorReadLockGetCount(RTThreadSelf())));
14135
14136 return directControl->OnUSBDeviceDetach(aId, aError);
14137}
14138
14139// protected methods
14140/////////////////////////////////////////////////////////////////////////////
14141
14142/**
14143 * Deletes the given file if it is no longer in use by either the current machine state
14144 * (if the machine is "saved") or any of the machine's snapshots.
14145 *
14146 * Note: This checks mSSData->strStateFilePath, which is shared by the Machine and SessionMachine
14147 * but is different for each SnapshotMachine. When calling this, the order of calling this
14148 * function on the one hand and changing that variable OR the snapshots tree on the other hand
14149 * is therefore critical. I know, it's all rather messy.
14150 *
14151 * @param strStateFile
14152 * @param pSnapshotToIgnore Passed to Snapshot::sharesSavedStateFile(); this snapshot is ignored in
14153 * the test for whether the saved state file is in use.
14154 */
14155void SessionMachine::i_releaseSavedStateFile(const Utf8Str &strStateFile,
14156 Snapshot *pSnapshotToIgnore)
14157{
14158 // it is safe to delete this saved state file if it is not currently in use by the machine ...
14159 if ( (strStateFile.isNotEmpty())
14160 && (strStateFile != mSSData->strStateFilePath) // session machine's saved state
14161 )
14162 // ... and it must also not be shared with other snapshots
14163 if ( !mData->mFirstSnapshot
14164 || !mData->mFirstSnapshot->i_sharesSavedStateFile(strStateFile, pSnapshotToIgnore)
14165 // this checks the SnapshotMachine's state file paths
14166 )
14167 RTFileDelete(strStateFile.c_str());
14168}
14169
14170/**
14171 * Locks the attached media.
14172 *
14173 * All attached hard disks are locked for writing and DVD/floppy are locked for
14174 * reading. Parents of attached hard disks (if any) are locked for reading.
14175 *
14176 * This method also performs accessibility check of all media it locks: if some
14177 * media is inaccessible, the method will return a failure and a bunch of
14178 * extended error info objects per each inaccessible medium.
14179 *
14180 * Note that this method is atomic: if it returns a success, all media are
14181 * locked as described above; on failure no media is locked at all (all
14182 * succeeded individual locks will be undone).
14183 *
14184 * The caller is responsible for doing the necessary state sanity checks.
14185 *
14186 * The locks made by this method must be undone by calling #unlockMedia() when
14187 * no more needed.
14188 */
14189HRESULT SessionMachine::i_lockMedia()
14190{
14191 AutoCaller autoCaller(this);
14192 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
14193
14194 AutoMultiWriteLock2 alock(this->lockHandle(),
14195 &mParent->i_getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
14196
14197 /* bail out if trying to lock things with already set up locking */
14198 AssertReturn(mData->mSession.mLockedMedia.IsEmpty(), E_FAIL);
14199
14200 MultiResult mrc(S_OK);
14201
14202 /* Collect locking information for all medium objects attached to the VM. */
14203 for (MediaData::AttachmentList::const_iterator it = mMediaData->mAttachments.begin();
14204 it != mMediaData->mAttachments.end();
14205 ++it)
14206 {
14207 MediumAttachment* pAtt = *it;
14208 DeviceType_T devType = pAtt->i_getType();
14209 Medium *pMedium = pAtt->i_getMedium();
14210
14211 MediumLockList *pMediumLockList(new MediumLockList());
14212 // There can be attachments without a medium (floppy/dvd), and thus
14213 // it's impossible to create a medium lock list. It still makes sense
14214 // to have the empty medium lock list in the map in case a medium is
14215 // attached later.
14216 if (pMedium != NULL)
14217 {
14218 MediumType_T mediumType = pMedium->i_getType();
14219 bool fIsReadOnlyLock = mediumType == MediumType_Readonly
14220 || mediumType == MediumType_Shareable;
14221 bool fIsVitalImage = (devType == DeviceType_HardDisk);
14222
14223 alock.release();
14224 mrc = pMedium->i_createMediumLockList(fIsVitalImage /* fFailIfInaccessible */,
14225 !fIsReadOnlyLock /* fMediumLockWrite */,
14226 false /* fMediumLockWriteAll */,
14227 NULL,
14228 *pMediumLockList);
14229 alock.acquire();
14230 if (FAILED(mrc))
14231 {
14232 delete pMediumLockList;
14233 mData->mSession.mLockedMedia.Clear();
14234 break;
14235 }
14236 }
14237
14238 HRESULT rc = mData->mSession.mLockedMedia.Insert(pAtt, pMediumLockList);
14239 if (FAILED(rc))
14240 {
14241 mData->mSession.mLockedMedia.Clear();
14242 mrc = setError(rc,
14243 tr("Collecting locking information for all attached media failed"));
14244 break;
14245 }
14246 }
14247
14248 if (SUCCEEDED(mrc))
14249 {
14250 /* Now lock all media. If this fails, nothing is locked. */
14251 alock.release();
14252 HRESULT rc = mData->mSession.mLockedMedia.Lock();
14253 alock.acquire();
14254 if (FAILED(rc))
14255 {
14256 mrc = setError(rc,
14257 tr("Locking of attached media failed. A possible reason is that one of the media is attached to a running VM"));
14258 }
14259 }
14260
14261 return mrc;
14262}
14263
14264/**
14265 * Undoes the locks made by by #lockMedia().
14266 */
14267HRESULT SessionMachine::i_unlockMedia()
14268{
14269 AutoCaller autoCaller(this);
14270 AssertComRCReturn(autoCaller.rc(),autoCaller.rc());
14271
14272 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
14273
14274 /* we may be holding important error info on the current thread;
14275 * preserve it */
14276 ErrorInfoKeeper eik;
14277
14278 HRESULT rc = mData->mSession.mLockedMedia.Clear();
14279 AssertComRC(rc);
14280 return rc;
14281}
14282
14283/**
14284 * Helper to change the machine state (reimplementation).
14285 *
14286 * @note Locks this object for writing.
14287 * @note This method must not call i_saveSettings or SaveSettings, otherwise
14288 * it can cause crashes in random places due to unexpectedly committing
14289 * the current settings. The caller is responsible for that. The call
14290 * to saveStateSettings is fine, because this method does not commit.
14291 */
14292HRESULT SessionMachine::i_setMachineState(MachineState_T aMachineState)
14293{
14294 LogFlowThisFuncEnter();
14295 LogFlowThisFunc(("aMachineState=%s\n", Global::stringifyMachineState(aMachineState) ));
14296
14297 AutoCaller autoCaller(this);
14298 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
14299
14300 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
14301
14302 MachineState_T oldMachineState = mData->mMachineState;
14303
14304 AssertMsgReturn(oldMachineState != aMachineState,
14305 ("oldMachineState=%s, aMachineState=%s\n",
14306 Global::stringifyMachineState(oldMachineState), Global::stringifyMachineState(aMachineState)),
14307 E_FAIL);
14308
14309 HRESULT rc = S_OK;
14310
14311 int stsFlags = 0;
14312 bool deleteSavedState = false;
14313
14314 /* detect some state transitions */
14315
14316 if ( ( oldMachineState == MachineState_Saved
14317 && aMachineState == MachineState_Restoring)
14318 || ( ( oldMachineState == MachineState_PoweredOff
14319 || oldMachineState == MachineState_Teleported
14320 || oldMachineState == MachineState_Aborted
14321 )
14322 && ( aMachineState == MachineState_TeleportingIn
14323 || aMachineState == MachineState_Starting
14324 )
14325 )
14326 )
14327 {
14328 /* The EMT thread is about to start */
14329
14330 /* Nothing to do here for now... */
14331
14332 /// @todo NEWMEDIA don't let mDVDDrive and other children
14333 /// change anything when in the Starting/Restoring state
14334 }
14335 else if ( ( oldMachineState == MachineState_Running
14336 || oldMachineState == MachineState_Paused
14337 || oldMachineState == MachineState_Teleporting
14338 || oldMachineState == MachineState_OnlineSnapshotting
14339 || oldMachineState == MachineState_LiveSnapshotting
14340 || oldMachineState == MachineState_Stuck
14341 || oldMachineState == MachineState_Starting
14342 || oldMachineState == MachineState_Stopping
14343 || oldMachineState == MachineState_Saving
14344 || oldMachineState == MachineState_Restoring
14345 || oldMachineState == MachineState_TeleportingPausedVM
14346 || oldMachineState == MachineState_TeleportingIn
14347 )
14348 && ( aMachineState == MachineState_PoweredOff
14349 || aMachineState == MachineState_Saved
14350 || aMachineState == MachineState_Teleported
14351 || aMachineState == MachineState_Aborted
14352 )
14353 )
14354 {
14355 /* The EMT thread has just stopped, unlock attached media. Note that as
14356 * opposed to locking that is done from Console, we do unlocking here
14357 * because the VM process may have aborted before having a chance to
14358 * properly unlock all media it locked. */
14359
14360 unlockMedia();
14361 }
14362
14363 if (oldMachineState == MachineState_Restoring)
14364 {
14365 if (aMachineState != MachineState_Saved)
14366 {
14367 /*
14368 * delete the saved state file once the machine has finished
14369 * restoring from it (note that Console sets the state from
14370 * Restoring to Saved if the VM couldn't restore successfully,
14371 * to give the user an ability to fix an error and retry --
14372 * we keep the saved state file in this case)
14373 */
14374 deleteSavedState = true;
14375 }
14376 }
14377 else if ( oldMachineState == MachineState_Saved
14378 && ( aMachineState == MachineState_PoweredOff
14379 || aMachineState == MachineState_Aborted
14380 || aMachineState == MachineState_Teleported
14381 )
14382 )
14383 {
14384 /*
14385 * delete the saved state after SessionMachine::ForgetSavedState() is called
14386 * or if the VM process (owning a direct VM session) crashed while the
14387 * VM was Saved
14388 */
14389
14390 /// @todo (dmik)
14391 // Not sure that deleting the saved state file just because of the
14392 // client death before it attempted to restore the VM is a good
14393 // thing. But when it crashes we need to go to the Aborted state
14394 // which cannot have the saved state file associated... The only
14395 // way to fix this is to make the Aborted condition not a VM state
14396 // but a bool flag: i.e., when a crash occurs, set it to true and
14397 // change the state to PoweredOff or Saved depending on the
14398 // saved state presence.
14399
14400 deleteSavedState = true;
14401 mData->mCurrentStateModified = TRUE;
14402 stsFlags |= SaveSTS_CurStateModified;
14403 }
14404
14405 if ( aMachineState == MachineState_Starting
14406 || aMachineState == MachineState_Restoring
14407 || aMachineState == MachineState_TeleportingIn
14408 )
14409 {
14410 /* set the current state modified flag to indicate that the current
14411 * state is no more identical to the state in the
14412 * current snapshot */
14413 if (!mData->mCurrentSnapshot.isNull())
14414 {
14415 mData->mCurrentStateModified = TRUE;
14416 stsFlags |= SaveSTS_CurStateModified;
14417 }
14418 }
14419
14420 if (deleteSavedState)
14421 {
14422 if (mRemoveSavedState)
14423 {
14424 Assert(!mSSData->strStateFilePath.isEmpty());
14425
14426 // it is safe to delete the saved state file if ...
14427 if ( !mData->mFirstSnapshot // ... we have no snapshots or
14428 || !mData->mFirstSnapshot->i_sharesSavedStateFile(mSSData->strStateFilePath, NULL /* pSnapshotToIgnore */)
14429 // ... none of the snapshots share the saved state file
14430 )
14431 RTFileDelete(mSSData->strStateFilePath.c_str());
14432 }
14433
14434 mSSData->strStateFilePath.setNull();
14435 stsFlags |= SaveSTS_StateFilePath;
14436 }
14437
14438 /* redirect to the underlying peer machine */
14439 mPeer->i_setMachineState(aMachineState);
14440
14441 if ( oldMachineState != MachineState_RestoringSnapshot
14442 && ( aMachineState == MachineState_PoweredOff
14443 || aMachineState == MachineState_Teleported
14444 || aMachineState == MachineState_Aborted
14445 || aMachineState == MachineState_Saved))
14446 {
14447 /* the machine has stopped execution
14448 * (or the saved state file was adopted) */
14449 stsFlags |= SaveSTS_StateTimeStamp;
14450 }
14451
14452 if ( ( oldMachineState == MachineState_PoweredOff
14453 || oldMachineState == MachineState_Aborted
14454 || oldMachineState == MachineState_Teleported
14455 )
14456 && aMachineState == MachineState_Saved)
14457 {
14458 /* the saved state file was adopted */
14459 Assert(!mSSData->strStateFilePath.isEmpty());
14460 stsFlags |= SaveSTS_StateFilePath;
14461 }
14462
14463#ifdef VBOX_WITH_GUEST_PROPS
14464 if ( aMachineState == MachineState_PoweredOff
14465 || aMachineState == MachineState_Aborted
14466 || aMachineState == MachineState_Teleported)
14467 {
14468 /* Make sure any transient guest properties get removed from the
14469 * property store on shutdown. */
14470 BOOL fNeedsSaving = mData->mGuestPropertiesModified;
14471
14472 /* remove it from the settings representation */
14473 settings::GuestPropertiesList &llGuestProperties = mData->pMachineConfigFile->hardwareMachine.llGuestProperties;
14474 for (settings::GuestPropertiesList::iterator it = llGuestProperties.begin();
14475 it != llGuestProperties.end();
14476 /*nothing*/)
14477 {
14478 const settings::GuestProperty &prop = *it;
14479 if ( prop.strFlags.contains("TRANSRESET", Utf8Str::CaseInsensitive)
14480 || prop.strFlags.contains("TRANSIENT", Utf8Str::CaseInsensitive))
14481 {
14482 it = llGuestProperties.erase(it);
14483 fNeedsSaving = true;
14484 }
14485 else
14486 {
14487 ++it;
14488 }
14489 }
14490
14491 /* Additionally remove it from the HWData representation. Required to
14492 * keep everything in sync, as this is what the API keeps using. */
14493 HWData::GuestPropertyMap &llHWGuestProperties = mHWData->mGuestProperties;
14494 for (HWData::GuestPropertyMap::iterator it = llHWGuestProperties.begin();
14495 it != llHWGuestProperties.end();
14496 /*nothing*/)
14497 {
14498 uint32_t fFlags = it->second.mFlags;
14499 if ( fFlags & guestProp::TRANSIENT
14500 || fFlags & guestProp::TRANSRESET)
14501 {
14502 /* iterator where we need to continue after the erase call
14503 * (C++03 is a fact still, and it doesn't return the iterator
14504 * which would allow continuing) */
14505 HWData::GuestPropertyMap::iterator it2 = it;
14506 ++it2;
14507 llHWGuestProperties.erase(it);
14508 it = it2;
14509 fNeedsSaving = true;
14510 }
14511 else
14512 {
14513 ++it;
14514 }
14515 }
14516
14517 if (fNeedsSaving)
14518 {
14519 mData->mCurrentStateModified = TRUE;
14520 stsFlags |= SaveSTS_CurStateModified;
14521 }
14522 }
14523#endif /* VBOX_WITH_GUEST_PROPS */
14524
14525 rc = i_saveStateSettings(stsFlags);
14526
14527 if ( ( oldMachineState != MachineState_PoweredOff
14528 && oldMachineState != MachineState_Aborted
14529 && oldMachineState != MachineState_Teleported
14530 )
14531 && ( aMachineState == MachineState_PoweredOff
14532 || aMachineState == MachineState_Aborted
14533 || aMachineState == MachineState_Teleported
14534 )
14535 )
14536 {
14537 /* we've been shut down for any reason */
14538 /* no special action so far */
14539 }
14540
14541 LogFlowThisFunc(("rc=%Rhrc [%s]\n", rc, Global::stringifyMachineState(mData->mMachineState) ));
14542 LogFlowThisFuncLeave();
14543 return rc;
14544}
14545
14546/**
14547 * Sends the current machine state value to the VM process.
14548 *
14549 * @note Locks this object for reading, then calls a client process.
14550 */
14551HRESULT SessionMachine::i_updateMachineStateOnClient()
14552{
14553 AutoCaller autoCaller(this);
14554 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
14555
14556 ComPtr<IInternalSessionControl> directControl;
14557 {
14558 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
14559 AssertReturn(!!mData, E_FAIL);
14560 if (mData->mSession.mLockType == LockType_VM)
14561 directControl = mData->mSession.mDirectControl;
14562
14563 /* directControl may be already set to NULL here in #OnSessionEnd()
14564 * called too early by the direct session process while there is still
14565 * some operation (like deleting the snapshot) in progress. The client
14566 * process in this case is waiting inside Session::close() for the
14567 * "end session" process object to complete, while #uninit() called by
14568 * #checkForDeath() on the Watcher thread is waiting for the pending
14569 * operation to complete. For now, we accept this inconsistent behavior
14570 * and simply do nothing here. */
14571
14572 if (mData->mSession.mState == SessionState_Unlocking)
14573 return S_OK;
14574 }
14575
14576 /* ignore notifications sent after #OnSessionEnd() is called */
14577 if (!directControl)
14578 return S_OK;
14579
14580 return directControl->UpdateMachineState(mData->mMachineState);
14581}
14582
14583
14584/**
14585 * Static Machine method that can get passed to RTThreadCreate to
14586 * have a thread started for a Task. See Machine::Task.
14587 */
14588/* static */ DECLCALLBACK(int) Machine::taskHandler(RTTHREAD /* thread */, void *pvUser)
14589{
14590 AssertReturn(pvUser, VERR_INVALID_POINTER);
14591
14592 Task *pTask = static_cast<Task *>(pvUser);
14593 pTask->handler();
14594 /** @todo r=klaus it would be safer to update the progress object here,
14595 * as it avoids possible races due to scoping issues/tricks in the handler */
14596 // it's our responsibility to delete the task
14597 delete pTask;
14598
14599 return 0;
14600}
14601
14602/*static*/
14603HRESULT Machine::i_setErrorStatic(HRESULT aResultCode, const char *pcszMsg, ...)
14604{
14605 va_list args;
14606 va_start(args, pcszMsg);
14607 HRESULT rc = setErrorInternal(aResultCode,
14608 getStaticClassIID(),
14609 getStaticComponentName(),
14610 Utf8Str(pcszMsg, args),
14611 false /* aWarning */,
14612 true /* aLogIt */);
14613 va_end(args);
14614 return rc;
14615}
14616
14617
14618HRESULT Machine::updateState(MachineState_T aState)
14619{
14620 NOREF(aState);
14621 ReturnComNotImplemented();
14622}
14623
14624HRESULT Machine::beginPowerUp(const ComPtr<IProgress> &aProgress)
14625{
14626 NOREF(aProgress);
14627 ReturnComNotImplemented();
14628}
14629
14630HRESULT Machine::endPowerUp(LONG aResult)
14631{
14632 NOREF(aResult);
14633 ReturnComNotImplemented();
14634}
14635
14636HRESULT Machine::beginPoweringDown(ComPtr<IProgress> &aProgress)
14637{
14638 NOREF(aProgress);
14639 ReturnComNotImplemented();
14640}
14641
14642HRESULT Machine::endPoweringDown(LONG aResult,
14643 const com::Utf8Str &aErrMsg)
14644{
14645 NOREF(aResult);
14646 NOREF(aErrMsg);
14647 ReturnComNotImplemented();
14648}
14649
14650HRESULT Machine::runUSBDeviceFilters(const ComPtr<IUSBDevice> &aDevice,
14651 BOOL *aMatched,
14652 ULONG *aMaskedInterfaces)
14653{
14654 NOREF(aDevice);
14655 NOREF(aMatched);
14656 NOREF(aMaskedInterfaces);
14657 ReturnComNotImplemented();
14658
14659}
14660
14661HRESULT Machine::captureUSBDevice(const com::Guid &aId, const com::Utf8Str &aCaptureFilename)
14662{
14663 NOREF(aId); NOREF(aCaptureFilename);
14664 ReturnComNotImplemented();
14665}
14666
14667HRESULT Machine::detachUSBDevice(const com::Guid &aId,
14668 BOOL aDone)
14669{
14670 NOREF(aId);
14671 NOREF(aDone);
14672 ReturnComNotImplemented();
14673}
14674
14675HRESULT Machine::autoCaptureUSBDevices()
14676{
14677 ReturnComNotImplemented();
14678}
14679
14680HRESULT Machine::detachAllUSBDevices(BOOL aDone)
14681{
14682 NOREF(aDone);
14683 ReturnComNotImplemented();
14684}
14685
14686HRESULT Machine::onSessionEnd(const ComPtr<ISession> &aSession,
14687 ComPtr<IProgress> &aProgress)
14688{
14689 NOREF(aSession);
14690 NOREF(aProgress);
14691 ReturnComNotImplemented();
14692}
14693
14694HRESULT Machine::finishOnlineMergeMedium()
14695{
14696 ReturnComNotImplemented();
14697}
14698
14699HRESULT Machine::pullGuestProperties(std::vector<com::Utf8Str> &aNames,
14700 std::vector<com::Utf8Str> &aValues,
14701 std::vector<LONG64> &aTimestamps,
14702 std::vector<com::Utf8Str> &aFlags)
14703{
14704 NOREF(aNames);
14705 NOREF(aValues);
14706 NOREF(aTimestamps);
14707 NOREF(aFlags);
14708 ReturnComNotImplemented();
14709}
14710
14711HRESULT Machine::pushGuestProperty(const com::Utf8Str &aName,
14712 const com::Utf8Str &aValue,
14713 LONG64 aTimestamp,
14714 const com::Utf8Str &aFlags)
14715{
14716 NOREF(aName);
14717 NOREF(aValue);
14718 NOREF(aTimestamp);
14719 NOREF(aFlags);
14720 ReturnComNotImplemented();
14721}
14722
14723HRESULT Machine::lockMedia()
14724{
14725 ReturnComNotImplemented();
14726}
14727
14728HRESULT Machine::unlockMedia()
14729{
14730 ReturnComNotImplemented();
14731}
14732
14733HRESULT Machine::ejectMedium(const ComPtr<IMediumAttachment> &aAttachment,
14734 ComPtr<IMediumAttachment> &aNewAttachment)
14735{
14736 NOREF(aAttachment);
14737 NOREF(aNewAttachment);
14738 ReturnComNotImplemented();
14739}
14740
14741HRESULT Machine::reportVmStatistics(ULONG aValidStats,
14742 ULONG aCpuUser,
14743 ULONG aCpuKernel,
14744 ULONG aCpuIdle,
14745 ULONG aMemTotal,
14746 ULONG aMemFree,
14747 ULONG aMemBalloon,
14748 ULONG aMemShared,
14749 ULONG aMemCache,
14750 ULONG aPagedTotal,
14751 ULONG aMemAllocTotal,
14752 ULONG aMemFreeTotal,
14753 ULONG aMemBalloonTotal,
14754 ULONG aMemSharedTotal,
14755 ULONG aVmNetRx,
14756 ULONG aVmNetTx)
14757{
14758 NOREF(aValidStats);
14759 NOREF(aCpuUser);
14760 NOREF(aCpuKernel);
14761 NOREF(aCpuIdle);
14762 NOREF(aMemTotal);
14763 NOREF(aMemFree);
14764 NOREF(aMemBalloon);
14765 NOREF(aMemShared);
14766 NOREF(aMemCache);
14767 NOREF(aPagedTotal);
14768 NOREF(aMemAllocTotal);
14769 NOREF(aMemFreeTotal);
14770 NOREF(aMemBalloonTotal);
14771 NOREF(aMemSharedTotal);
14772 NOREF(aVmNetRx);
14773 NOREF(aVmNetTx);
14774 ReturnComNotImplemented();
14775}
14776
14777HRESULT Machine::applyDefaults(const com::Utf8Str &aFlags)
14778{
14779 NOREF(aFlags);
14780 ReturnComNotImplemented();
14781}
14782
14783/* This isn't handled entirely by the wrapper generator yet. */
14784#ifdef VBOX_WITH_XPCOM
14785NS_DECL_CLASSINFO(SessionMachine)
14786NS_IMPL_THREADSAFE_ISUPPORTS2_CI(SessionMachine, IMachine, IInternalMachineControl)
14787
14788NS_DECL_CLASSINFO(SnapshotMachine)
14789NS_IMPL_THREADSAFE_ISUPPORTS1_CI(SnapshotMachine, IMachine)
14790#endif
Note: See TracBrowser for help on using the repository browser.

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