VirtualBox

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

最後變更 在這個檔案從35036是 35009,由 vboxsync 提交於 14 年 前

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

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