VirtualBox

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

Last change on this file since 35967 was 35903, checked in by vboxsync, 14 years ago

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