ConsoleImpl.h@ 61644

Last change on this file since 61644 was 61610, checked in by vboxsync, 9 years ago
Main: properly inform the user if the VRDE server cannot be started at runtime
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 42.4 KB

Line
1	/* $Id: ConsoleImpl.h 61610 2016-06-09 10:22:42Z vboxsync $ */
2	/** @file
3	* VBox Console COM Class definition
4	*/
5
6	/*
7	* Copyright (C) 2005-2016 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#ifndef ____H_CONSOLEIMPL
19	#define ____H_CONSOLEIMPL
20
21	#include "VirtualBoxBase.h"
22	#include "VBox/com/array.h"
23	#include "EventImpl.h"
24	#include "SecretKeyStore.h"
25	#include "ConsoleWrap.h"
26
27	class Guest;
28	class Keyboard;
29	class Mouse;
30	class Display;
31	class MachineDebugger;
32	class TeleporterStateSrc;
33	class OUSBDevice;
34	class RemoteUSBDevice;
35	class SharedFolder;
36	class VRDEServerInfo;
37	class EmulatedUSB;
38	class AudioVRDE;
39	class Nvram;
40	#ifdef VBOX_WITH_USB_CARDREADER
41	class UsbCardReader;
42	#endif
43	class ConsoleVRDPServer;
44	class VMMDev;
45	class Progress;
46	class BusAssignmentManager;
47	COM_STRUCT_OR_CLASS(IEventListener);
48	#ifdef VBOX_WITH_EXTPACK
49	class ExtPackManager;
50	#endif
51	class VMMDevMouseInterface;
52	class DisplayMouseInterface;
53
54	#include <iprt/uuid.h>
55	#include <iprt/memsafer.h>
56	#include <VBox/RemoteDesktop/VRDE.h>
57	#include <VBox/vmm/pdmdrv.h>
58	#ifdef VBOX_WITH_GUEST_PROPS
59	# include <VBox/HostServices/GuestPropertySvc.h> /* For the property notification callback */
60	#endif
61
62	#ifdef RT_OS_WINDOWS
63	# include "../src-server/win/VBoxComEvents.h"
64	#endif
65
66	struct VUSBIRHCONFIG;
67	typedef struct VUSBIRHCONFIG *PVUSBIRHCONFIG;
68
69	#include <list>
70	#include <vector>
71
72	// defines
73	///////////////////////////////////////////////////////////////////////////////
74
75	/**
76	* Checks the availability of the underlying VM device driver corresponding
77	* to the COM interface (IKeyboard, IMouse, IDisplay, etc.). When the driver is
78	* not available (NULL), sets error info and returns returns E_ACCESSDENIED.
79	* The translatable error message is defined in null context.
80	*
81	* Intended to used only within Console children (i.e. Keyboard, Mouse,
82	* Display, etc.).
83	*
84	* @param drv driver pointer to check (compare it with NULL)
85	*/
86	#define CHECK_CONSOLE_DRV(drv) \
87	do { \
88	if (!(drv)) \
89	return setError(E_ACCESSDENIED, tr("The console is not powered up")); \
90	} while (0)
91
92	// Console
93	///////////////////////////////////////////////////////////////////////////////
94
95	class ConsoleMouseInterface
96	{
97	public:
98	virtual VMMDevMouseInterface *i_getVMMDevMouseInterface(){return NULL;}
99	virtual DisplayMouseInterface *i_getDisplayMouseInterface(){return NULL;}
100	virtual void i_onMouseCapabilityChange(BOOL supportsAbsolute,
101	BOOL supportsRelative,
102	BOOL supportsMT,
103	BOOL needsHostCursor){NOREF(supportsAbsolute); NOREF(supportsRelative); NOREF(supportsMT); NOREF(needsHostCursor);}
104	};
105
106	/** IConsole implementation class */
107	class ATL_NO_VTABLE Console :
108	public ConsoleWrap,
109	public ConsoleMouseInterface
110	{
111
112	public:
113
114	DECLARE_EMPTY_CTOR_DTOR(Console)
115
116	HRESULT FinalConstruct();
117	void FinalRelease();
118
119	// public initializers/uninitializers for internal purposes only
120	HRESULT init(IMachine aMachine, IInternalMachineControl aControl, LockType_T aLockType);
121	void uninit();
122
123
124	// public methods for internal purposes only
125
126	/*
127	* Note: the following methods do not increase refcount. intended to be
128	* called only by the VM execution thread.
129	*/
130
131	Guest *i_getGuest() const { return mGuest; }
132	Keyboard *i_getKeyboard() const { return mKeyboard; }
133	Mouse *i_getMouse() const { return mMouse; }
134	Display *i_getDisplay() const { return mDisplay; }
135	MachineDebugger *i_getMachineDebugger() const { return mDebugger; }
136	AudioVRDE *i_getAudioVRDE() const { return mAudioVRDE; }
137
138	const ComPtr<IMachine> &i_machine() const { return mMachine; }
139	const Bstr &i_getId() const { return mstrUuid; }
140
141	bool i_useHostClipboard() { return mfUseHostClipboard; }
142
143	/** Method is called only from ConsoleVRDPServer */
144	IVRDEServer *i_getVRDEServer() const { return mVRDEServer; }
145
146	ConsoleVRDPServer *i_consoleVRDPServer() const { return mConsoleVRDPServer; }
147
148	HRESULT i_updateMachineState(MachineState_T aMachineState);
149	HRESULT i_getNominalState(MachineState_T &aNominalState);
150
151	// events from IInternalSessionControl
152	HRESULT i_onNetworkAdapterChange(INetworkAdapter *aNetworkAdapter, BOOL changeAdapter);
153	HRESULT i_onSerialPortChange(ISerialPort *aSerialPort);
154	HRESULT i_onParallelPortChange(IParallelPort *aParallelPort);
155	HRESULT i_onStorageControllerChange();
156	HRESULT i_onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);
157	HRESULT i_onCPUChange(ULONG aCPU, BOOL aRemove);
158	HRESULT i_onCPUExecutionCapChange(ULONG aExecutionCap);
159	HRESULT i_onClipboardModeChange(ClipboardMode_T aClipboardMode);
160	HRESULT i_onDnDModeChange(DnDMode_T aDnDMode);
161	HRESULT i_onVRDEServerChange(BOOL aRestart);
162	HRESULT i_onVideoCaptureChange();
163	HRESULT i_onUSBControllerChange();
164	HRESULT i_onSharedFolderChange(BOOL aGlobal);
165	HRESULT i_onUSBDeviceAttach(IUSBDevice aDevice, IVirtualBoxErrorInfo aError, ULONG aMaskedIfs,
166	const Utf8Str &aCaptureFilename);
167	HRESULT i_onUSBDeviceDetach(IN_BSTR aId, IVirtualBoxErrorInfo *aError);
168	HRESULT i_onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);
169	HRESULT i_onStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove, BOOL aSilent);
170	HRESULT i_onExtraDataChange(IN_BSTR aMachineId, IN_BSTR aKey, IN_BSTR aVal);
171
172	HRESULT i_getGuestProperty(const Utf8Str &aName, Utf8Str aValue, LONG64 aTimestamp, Utf8Str *aFlags);
173	HRESULT i_setGuestProperty(const Utf8Str &aName, const Utf8Str &aValue, const Utf8Str &aFlags);
174	HRESULT i_deleteGuestProperty(const Utf8Str &aName);
175	HRESULT i_enumerateGuestProperties(const Utf8Str &aPatterns,
176	std::vector<Utf8Str> &aNames,
177	std::vector<Utf8Str> &aValues,
178	std::vector<LONG64> &aTimestamps,
179	std::vector<Utf8Str> &aFlags);
180	HRESULT i_onlineMergeMedium(IMediumAttachment *aMediumAttachment,
181	ULONG aSourceIdx, ULONG aTargetIdx,
182	IProgress *aProgress);
183	HRESULT i_reconfigureMediumAttachments(const std::vector<ComPtr<IMediumAttachment> > &aAttachments);
184	int i_hgcmLoadService(const char pszServiceLibrary, const char pszServiceName);
185	VMMDev *i_getVMMDev() { return m_pVMMDev; }
186	AudioVRDE *i_getAudioVRDE() { return mAudioVRDE; }
187
188	#ifdef VBOX_WITH_EXTPACK
189	ExtPackManager *i_getExtPackManager();
190	#endif
191	EventSource *i_getEventSource() { return mEventSource; }
192	#ifdef VBOX_WITH_USB_CARDREADER
193	UsbCardReader *i_getUsbCardReader() { return mUsbCardReader; }
194	#endif
195
196	int i_VRDPClientLogon(uint32_t u32ClientId, const char pszUser, const char pszPassword, const char *pszDomain);
197	void i_VRDPClientStatusChange(uint32_t u32ClientId, const char *pszStatus);
198	void i_VRDPClientConnect(uint32_t u32ClientId);
199	void i_VRDPClientDisconnect(uint32_t u32ClientId, uint32_t fu32Intercepted);
200	void i_VRDPInterceptAudio(uint32_t u32ClientId);
201	void i_VRDPInterceptUSB(uint32_t u32ClientId, void **ppvIntercept);
202	void i_VRDPInterceptClipboard(uint32_t u32ClientId);
203
204	void i_processRemoteUSBDevices(uint32_t u32ClientId, VRDEUSBDEVICEDESC *pDevList, uint32_t cbDevList, bool fDescExt);
205	void i_reportVmStatistics(ULONG aValidStats, ULONG aCpuUser,
206	ULONG aCpuKernel, ULONG aCpuIdle,
207	ULONG aMemTotal, ULONG aMemFree,
208	ULONG aMemBalloon, ULONG aMemShared,
209	ULONG aMemCache, ULONG aPageTotal,
210	ULONG aAllocVMM, ULONG aFreeVMM,
211	ULONG aBalloonedVMM, ULONG aSharedVMM,
212	ULONG aVmNetRx, ULONG aVmNetTx)
213	{
214	mControl->ReportVmStatistics(aValidStats, aCpuUser, aCpuKernel, aCpuIdle,
215	aMemTotal, aMemFree, aMemBalloon, aMemShared,
216	aMemCache, aPageTotal, aAllocVMM, aFreeVMM,
217	aBalloonedVMM, aSharedVMM, aVmNetRx, aVmNetTx);
218	}
219	void i_enableVMMStatistics(BOOL aEnable);
220
221	HRESULT i_pause(Reason_T aReason);
222	HRESULT i_resume(Reason_T aReason, AutoWriteLock &alock);
223	HRESULT i_saveState(Reason_T aReason, const ComPtr<IProgress> &aProgress, const Utf8Str &aStateFilePath, bool fPauseVM, bool &fLeftPaused);
224	HRESULT i_cancelSaveState();
225
226	// callback callers (partly; for some events console callbacks are notified
227	// directly from IInternalSessionControl event handlers declared above)
228	void i_onMousePointerShapeChange(bool fVisible, bool fAlpha,
229	uint32_t xHot, uint32_t yHot,
230	uint32_t width, uint32_t height,
231	const uint8_t *pu8Shape,
232	uint32_t cbShape);
233	void i_onMouseCapabilityChange(BOOL supportsAbsolute, BOOL supportsRelative,
234	BOOL supportsMT, BOOL needsHostCursor);
235	void i_onStateChange(MachineState_T aMachineState);
236	void i_onAdditionsStateChange();
237	void i_onAdditionsOutdated();
238	void i_onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock);
239	void i_onUSBDeviceStateChange(IUSBDevice *aDevice, bool aAttached,
240	IVirtualBoxErrorInfo *aError);
241	void i_onRuntimeError(BOOL aFatal, IN_BSTR aErrorID, IN_BSTR aMessage);
242	HRESULT i_onShowWindow(BOOL aCheck, BOOL aCanShow, LONG64 aWinId);
243	void i_onVRDEServerInfoChange();
244	HRESULT i_sendACPIMonitorHotPlugEvent();
245
246	static const PDMDRVREG DrvStatusReg;
247
248	static HRESULT i_setErrorStatic(HRESULT aResultCode, const char *pcsz, ...);
249	HRESULT i_setInvalidMachineStateError();
250
251	static const char *i_convertControllerTypeToDev(StorageControllerType_T enmCtrlType);
252	static HRESULT i_convertBusPortDeviceToLun(StorageBus_T enmBus, LONG port, LONG device, unsigned &uLun);
253	// Called from event listener
254	HRESULT i_onNATRedirectRuleChange(ULONG ulInstance, BOOL aNatRuleRemove,
255	NATProtocol_T aProto, IN_BSTR aHostIp, LONG aHostPort, IN_BSTR aGuestIp, LONG aGuestPort);
256	HRESULT i_onNATDnsChanged();
257
258	// Mouse interface
259	VMMDevMouseInterface *i_getVMMDevMouseInterface();
260	DisplayMouseInterface *i_getDisplayMouseInterface();
261
262	EmulatedUSB *i_getEmulatedUSB(void) { return mEmulatedUSB; }
263
264	/**
265	* Sets the disk encryption keys.
266	*
267	* @returns COM status code.
268	* @þaram strCfg The config for the disks.
269	*
270	* @note: One line in the config string contains all required data for one disk.
271	* The format for one disk is some sort of comma separated value using
272	* key=value pairs.
273	* There are two keys defined at the moment:
274	* - uuid: The uuid of the base image the key is for (with or without)
275	* the curly braces.
276	* - dek: The data encryption key in base64 encoding
277	*/
278	HRESULT i_setDiskEncryptionKeys(const Utf8Str &strCfg);
279
280	private:
281
282	// wraped IConsole properties
283	HRESULT getMachine(ComPtr<IMachine> &aMachine);
284	HRESULT getState(MachineState_T *aState);
285	HRESULT getGuest(ComPtr<IGuest> &aGuest);
286	HRESULT getKeyboard(ComPtr<IKeyboard> &aKeyboard);
287	HRESULT getMouse(ComPtr<IMouse> &aMouse);
288	HRESULT getDisplay(ComPtr<IDisplay> &aDisplay);
289	HRESULT getDebugger(ComPtr<IMachineDebugger> &aDebugger);
290	HRESULT getUSBDevices(std::vector<ComPtr<IUSBDevice> > &aUSBDevices);
291	HRESULT getRemoteUSBDevices(std::vector<ComPtr<IHostUSBDevice> > &aRemoteUSBDevices);
292	HRESULT getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders);
293	HRESULT getVRDEServerInfo(ComPtr<IVRDEServerInfo> &aVRDEServerInfo);
294	HRESULT getEventSource(ComPtr<IEventSource> &aEventSource);
295	HRESULT getAttachedPCIDevices(std::vector<ComPtr<IPCIDeviceAttachment> > &aAttachedPCIDevices);
296	HRESULT getUseHostClipboard(BOOL *aUseHostClipboard);
297	HRESULT setUseHostClipboard(BOOL aUseHostClipboard);
298	HRESULT getEmulatedUSB(ComPtr<IEmulatedUSB> &aEmulatedUSB);
299
300	// wraped IConsole methods
301	HRESULT powerUp(ComPtr<IProgress> &aProgress);
302	HRESULT powerUpPaused(ComPtr<IProgress> &aProgress);
303	HRESULT powerDown(ComPtr<IProgress> &aProgress);
304	HRESULT reset();
305	HRESULT pause();
306	HRESULT resume();
307	HRESULT powerButton();
308	HRESULT sleepButton();
309	HRESULT getPowerButtonHandled(BOOL *aHandled);
310	HRESULT getGuestEnteredACPIMode(BOOL *aEntered);
311	HRESULT getDeviceActivity(const std::vector<DeviceType_T> &aType,
312	std::vector<DeviceActivity_T> &aActivity);
313	HRESULT attachUSBDevice(const com::Guid &aId, const com::Utf8Str &aCaptureFilename);
314	HRESULT detachUSBDevice(const com::Guid &aId,
315	ComPtr<IUSBDevice> &aDevice);
316	HRESULT findUSBDeviceByAddress(const com::Utf8Str &aName,
317	ComPtr<IUSBDevice> &aDevice);
318	HRESULT findUSBDeviceById(const com::Guid &aId,
319	ComPtr<IUSBDevice> &aDevice);
320	HRESULT createSharedFolder(const com::Utf8Str &aName,
321	const com::Utf8Str &aHostPath,
322	BOOL aWritable,
323	BOOL aAutomount);
324	HRESULT removeSharedFolder(const com::Utf8Str &aName);
325	HRESULT teleport(const com::Utf8Str &aHostname,
326	ULONG aTcpport,
327	const com::Utf8Str &aPassword,
328	ULONG aMaxDowntime,
329	ComPtr<IProgress> &aProgress);
330	HRESULT addDiskEncryptionPassword(const com::Utf8Str &aId, const com::Utf8Str &aPassword,
331	BOOL aClearOnSuspend);
332	HRESULT addDiskEncryptionPasswords(const std::vector<com::Utf8Str> &aIds, const std::vector<com::Utf8Str> &aPasswords,
333	BOOL aClearOnSuspend);
334	HRESULT removeDiskEncryptionPassword(const com::Utf8Str &aId);
335	HRESULT clearAllDiskEncryptionPasswords();
336
337	void notifyNatDnsChange(PUVM pUVM, const char *pszDevice, ULONG ulInstanceMax);
338	Utf8Str VRDPServerErrorToMsg(int vrc);
339
340	/**
341	* Base template for AutoVMCaller and SafeVMPtr. Template arguments
342	* have the same meaning as arguments of Console::addVMCaller().
343	*/
344	template <bool taQuiet = false, bool taAllowNullVM = false>
345	class AutoVMCallerBase
346	{
347	public:
348	AutoVMCallerBase(Console *aThat) : mThat(aThat), mRC(E_FAIL)
349	{
350	Assert(aThat);
351	mRC = aThat->i_addVMCaller(taQuiet, taAllowNullVM);
352	}
353	~AutoVMCallerBase()
354	{
355	doRelease();
356	}
357	/** Decreases the number of callers before the instance is destroyed. */
358	void releaseCaller()
359	{
360	Assert(SUCCEEDED(mRC));
361	doRelease();
362	}
363	/** Restores the number of callers after by #release(). #rc() must be
364	* rechecked to ensure the operation succeeded. */
365	void addYY()
366	{
367	AssertReturnVoid(!SUCCEEDED(mRC));
368	mRC = mThat->i_addVMCaller(taQuiet, taAllowNullVM);
369	}
370	/** Returns the result of Console::addVMCaller() */
371	HRESULT rc() const { return mRC; }
372	/** Shortcut to SUCCEEDED(rc()) */
373	bool isOk() const { return SUCCEEDED(mRC); }
374	protected:
375	Console *mThat;
376	void doRelease()
377	{
378	if (SUCCEEDED(mRC))
379	{
380	mThat->i_releaseVMCaller();
381	mRC = E_FAIL;
382	}
383	}
384	private:
385	HRESULT mRC; /* Whether the caller was added. */
386	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(AutoVMCallerBase)
387	};
388
389	#if 0
390	/**
391	* Helper class that protects sections of code using the mpUVM pointer by
392	* automatically calling addVMCaller() on construction and
393	* releaseVMCaller() on destruction. Intended for Console methods dealing
394	* with mpUVM. The usage pattern is:
395	* <code>
396	* AutoVMCaller autoVMCaller(this);
397	* if (FAILED(autoVMCaller.rc())) return autoVMCaller.rc();
398	* ...
399	* VMR3ReqCall (mpUVM, ...
400	* </code>
401	*
402	* @note Temporarily locks the argument for writing.
403	*
404	* @sa SafeVMPtr, SafeVMPtrQuiet
405	* @obsolete Use SafeVMPtr
406	*/
407	typedef AutoVMCallerBase<false, false> AutoVMCaller;
408	#endif
409
410	/**
411	* Same as AutoVMCaller but doesn't set extended error info on failure.
412	*
413	* @note Temporarily locks the argument for writing.
414	* @obsolete Use SafeVMPtrQuiet
415	*/
416	typedef AutoVMCallerBase<true, false> AutoVMCallerQuiet;
417
418	/**
419	* Same as AutoVMCaller but allows a null VM pointer (to trigger an error
420	* instead of assertion).
421	*
422	* @note Temporarily locks the argument for writing.
423	* @obsolete Use SafeVMPtr
424	*/
425	typedef AutoVMCallerBase<false, true> AutoVMCallerWeak;
426
427	/**
428	* Same as AutoVMCaller but doesn't set extended error info on failure
429	* and allows a null VM pointer (to trigger an error instead of
430	* assertion).
431	*
432	* @note Temporarily locks the argument for writing.
433	* @obsolete Use SafeVMPtrQuiet
434	*/
435	typedef AutoVMCallerBase<true, true> AutoVMCallerQuietWeak;
436
437	/**
438	* Base template for SafeVMPtr and SafeVMPtrQuiet.
439	*/
440	template<bool taQuiet = false>
441	class SafeVMPtrBase : public AutoVMCallerBase<taQuiet, true>
442	{
443	typedef AutoVMCallerBase<taQuiet, true> Base;
444	public:
445	SafeVMPtrBase(Console *aThat) : Base(aThat), mRC(E_FAIL), mpUVM(NULL)
446	{
447	if (Base::isOk())
448	mRC = aThat->i_safeVMPtrRetainer(&mpUVM, taQuiet);
449	}
450	~SafeVMPtrBase()
451	{
452	doRelease();
453	}
454	/** Direct PUVM access. */
455	PUVM rawUVM() const { return mpUVM; }
456	/** Release the handles. */
457	void release()
458	{
459	Assert(SUCCEEDED(mRC));
460	doRelease();
461	}
462
463	/** The combined result of Console::addVMCaller() and Console::safeVMPtrRetainer */
464	HRESULT rc() const { return Base::isOk()? mRC: Base::rc(); }
465	/** Shortcut to SUCCEEDED(rc()) */
466	bool isOk() const { return SUCCEEDED(mRC) && Base::isOk(); }
467
468	private:
469	void doRelease()
470	{
471	if (SUCCEEDED(mRC))
472	{
473	Base::mThat->i_safeVMPtrReleaser(&mpUVM);
474	mRC = E_FAIL;
475	}
476	Base::doRelease();
477	}
478	HRESULT mRC; /* Whether the VM ptr was retained. */
479	PUVM mpUVM;
480	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(SafeVMPtrBase)
481	};
482
483	public:
484
485	/*
486	* Helper class that safely manages the Console::mpUVM pointer
487	* by calling addVMCaller() on construction and releaseVMCaller() on
488	* destruction. Intended for Console children. The usage pattern is:
489	* <code>
490	* Console::SafeVMPtr ptrVM(mParent);
491	* if (!ptrVM.isOk())
492	* return ptrVM.rc();
493	* ...
494	* VMR3ReqCall(ptrVM.rawUVM(), ...
495	* ...
496	* printf("%p\n", ptrVM.rawUVM());
497	* </code>
498	*
499	* @note Temporarily locks the argument for writing.
500	*
501	* @sa SafeVMPtrQuiet, AutoVMCaller
502	*/
503	typedef SafeVMPtrBase<false> SafeVMPtr;
504
505	/**
506	* A deviation of SafeVMPtr that doesn't set the error info on failure.
507	* Intended for pieces of code that don't need to return the VM access
508	* failure to the caller. The usage pattern is:
509	* <code>
510	* Console::SafeVMPtrQuiet pVM(mParent);
511	* if (pVM.rc())
512	* VMR3ReqCall(pVM, ...
513	* return S_OK;
514	* </code>
515	*
516	* @note Temporarily locks the argument for writing.
517	*
518	* @sa SafeVMPtr, AutoVMCaller
519	*/
520	typedef SafeVMPtrBase<true> SafeVMPtrQuiet;
521
522	class SharedFolderData
523	{
524	public:
525	SharedFolderData()
526	{ }
527
528	SharedFolderData(const Utf8Str &aHostPath,
529	bool aWritable,
530	bool aAutoMount)
531	: m_strHostPath(aHostPath),
532	m_fWritable(aWritable),
533	m_fAutoMount(aAutoMount)
534	{ }
535
536	// copy constructor
537	SharedFolderData(const SharedFolderData& aThat)
538	: m_strHostPath(aThat.m_strHostPath),
539	m_fWritable(aThat.m_fWritable),
540	m_fAutoMount(aThat.m_fAutoMount)
541	{ }
542
543	Utf8Str m_strHostPath;
544	bool m_fWritable;
545	bool m_fAutoMount;
546	};
547
548	/**
549	* Class for managing emulated USB MSDs.
550	*/
551	class USBStorageDevice
552	{
553	public:
554	USBStorageDevice()
555	{ }
556	/** The UUID associated with the USB device. */
557	RTUUID mUuid;
558	/** Port of the storage device. */
559	LONG iPort;
560	};
561
562	typedef std::map<Utf8Str, ComObjPtr<SharedFolder> > SharedFolderMap;
563	typedef std::map<Utf8Str, SharedFolderData> SharedFolderDataMap;
564	typedef std::map<Utf8Str, ComPtr<IMediumAttachment> > MediumAttachmentMap;
565	typedef std::list <USBStorageDevice> USBStorageDeviceList;
566
567	static DECLCALLBACK(int) i_powerUpThread(RTTHREAD Thread, void *pvUser);
568	static DECLCALLBACK(int) i_powerDownThread(RTTHREAD Thread, void *pvUser);
569
570	private:
571
572	typedef std::list <ComObjPtr<OUSBDevice> > USBDeviceList;
573	typedef std::list <ComObjPtr<RemoteUSBDevice> > RemoteUSBDeviceList;
574
575	HRESULT i_addVMCaller(bool aQuiet = false, bool aAllowNullVM = false);
576	void i_releaseVMCaller();
577	HRESULT i_safeVMPtrRetainer(PUVM *a_ppUVM, bool aQuiet);
578	void i_safeVMPtrReleaser(PUVM *a_ppUVM);
579
580	HRESULT i_consoleInitReleaseLog(const ComPtr<IMachine> aMachine);
581
582	HRESULT i_powerUp(IProgress **aProgress, bool aPaused);
583	HRESULT i_powerDown(IProgress *aProgress = NULL);
584
585	/* Note: FreeBSD needs this whether netflt is used or not. */
586	#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) \|\| defined(RT_OS_FREEBSD))
587	HRESULT i_attachToTapInterface(INetworkAdapter *networkAdapter);
588	HRESULT i_detachFromTapInterface(INetworkAdapter *networkAdapter);
589	#endif
590	HRESULT i_powerDownHostInterfaces();
591
592	HRESULT i_setMachineState(MachineState_T aMachineState, bool aUpdateServer = true);
593	HRESULT i_setMachineStateLocally(MachineState_T aMachineState)
594	{
595	return i_setMachineState(aMachineState, false /* aUpdateServer */);
596	}
597
598	HRESULT i_findSharedFolder(const Utf8Str &strName,
599	ComObjPtr<SharedFolder> &aSharedFolder,
600	bool aSetError = false);
601
602	HRESULT i_fetchSharedFolders(BOOL aGlobal);
603	bool i_findOtherSharedFolder(const Utf8Str &straName,
604	SharedFolderDataMap::const_iterator &aIt);
605
606	HRESULT i_createSharedFolder(const Utf8Str &strName, const SharedFolderData &aData);
607	HRESULT i_removeSharedFolder(const Utf8Str &strName);
608
609	HRESULT i_suspendBeforeConfigChange(PUVM pUVM, AutoWriteLock pAlock, bool pfResume);
610	void i_resumeAfterConfigChange(PUVM pUVM);
611
612	static DECLCALLBACK(int) i_configConstructor(PUVM pUVM, PVM pVM, void *pvConsole);
613	int i_configConstructorInner(PUVM pUVM, PVM pVM, AutoWriteLock *pAlock);
614	int i_configCfgmOverlay(PCFGMNODE pRoot, IVirtualBox pVirtualBox, IMachine pMachine);
615	int i_configDumpAPISettingsTweaks(IVirtualBox pVirtualBox, IMachine pMachine);
616
617	int i_configGraphicsController(PCFGMNODE pDevices,
618	const GraphicsControllerType_T graphicsController,
619	BusAssignmentManager *pBusMgr,
620	const ComPtr<IMachine> &ptrMachine,
621	const ComPtr<IBIOSSettings> &ptrBiosSettings,
622	bool fHMEnabled);
623	int i_configMediumAttachment(const char *pcszDevice,
624	unsigned uInstance,
625	StorageBus_T enmBus,
626	bool fUseHostIOCache,
627	bool fBuiltinIoCache,
628	bool fSetupMerge,
629	unsigned uMergeSource,
630	unsigned uMergeTarget,
631	IMediumAttachment *pMediumAtt,
632	MachineState_T aMachineState,
633	HRESULT *phrc,
634	bool fAttachDetach,
635	bool fForceUnmount,
636	bool fHotplug,
637	PUVM pUVM,
638	DeviceType_T *paLedDevType,
639	PCFGMNODE *ppLunL0);
640	int i_configMedium(PCFGMNODE pLunL0,
641	bool fPassthrough,
642	DeviceType_T enmType,
643	bool fUseHostIOCache,
644	bool fBuiltinIoCache,
645	bool fSetupMerge,
646	unsigned uMergeSource,
647	unsigned uMergeTarget,
648	const char *pcszBwGroup,
649	bool fDiscard,
650	IMedium *pMedium,
651	MachineState_T aMachineState,
652	HRESULT *phrc);
653	int i_configMediumProperties(PCFGMNODE pCur, IMedium pMedium, bool pfHostIP, bool *pfEncrypted);
654	static DECLCALLBACK(int) i_reconfigureMediumAttachment(Console *pThis,
655	PUVM pUVM,
656	const char *pcszDevice,
657	unsigned uInstance,
658	StorageBus_T enmBus,
659	bool fUseHostIOCache,
660	bool fBuiltinIoCache,
661	bool fSetupMerge,
662	unsigned uMergeSource,
663	unsigned uMergeTarget,
664	IMediumAttachment *aMediumAtt,
665	MachineState_T aMachineState,
666	HRESULT *phrc);
667	static DECLCALLBACK(int) i_changeRemovableMedium(Console *pThis,
668	PUVM pUVM,
669	const char *pcszDevice,
670	unsigned uInstance,
671	StorageBus_T enmBus,
672	bool fUseHostIOCache,
673	IMediumAttachment *aMediumAtt,
674	bool fForce);
675
676	HRESULT i_attachRawPCIDevices(PUVM pUVM, BusAssignmentManager *BusMgr, PCFGMNODE pDevices);
677	void i_attachStatusDriver(PCFGMNODE pCtlInst, PPDMLED *papLeds,
678	uint64_t uFirst, uint64_t uLast,
679	Console::MediumAttachmentMap *pmapMediumAttachments,
680	const char *pcszDevice, unsigned uInstance);
681
682	int i_configNetwork(const char *pszDevice, unsigned uInstance, unsigned uLun,
683	INetworkAdapter *aNetworkAdapter, PCFGMNODE pCfg,
684	PCFGMNODE pLunL0, PCFGMNODE pInst,
685	bool fAttachDetach, bool fIgnoreConnectFailure);
686
687	static DECLCALLBACK(int) i_configGuestProperties(void *pvConsole, PUVM pUVM);
688	static DECLCALLBACK(int) i_configGuestControl(void *pvConsole);
689	static DECLCALLBACK(void) i_vmstateChangeCallback(PUVM pUVM, VMSTATE enmState, VMSTATE enmOldState, void *pvUser);
690	static DECLCALLBACK(int) i_unplugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);
691	static DECLCALLBACK(int) i_plugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);
692	HRESULT i_doMediumChange(IMediumAttachment *aMediumAttachment, bool fForce, PUVM pUVM);
693	HRESULT i_doCPURemove(ULONG aCpu, PUVM pUVM);
694	HRESULT i_doCPUAdd(ULONG aCpu, PUVM pUVM);
695
696	HRESULT i_doNetworkAdapterChange(PUVM pUVM, const char *pszDevice, unsigned uInstance,
697	unsigned uLun, INetworkAdapter *aNetworkAdapter);
698	static DECLCALLBACK(int) i_changeNetworkAttachment(Console pThis, PUVM pUVM, const char pszDevice,
699	unsigned uInstance, unsigned uLun,
700	INetworkAdapter *aNetworkAdapter);
701
702	void i_changeClipboardMode(ClipboardMode_T aClipboardMode);
703	int i_changeDnDMode(DnDMode_T aDnDMode);
704
705	#ifdef VBOX_WITH_USB
706	HRESULT i_attachUSBDevice(IUSBDevice *aHostDevice, ULONG aMaskedIfs, const Utf8Str &aCaptureFilename);
707	HRESULT i_detachUSBDevice(const ComObjPtr<OUSBDevice> &aHostDevice);
708
709	static DECLCALLBACK(int) i_usbAttachCallback(Console that, PUVM pUVM, IUSBDevice aHostDevice, PCRTUUID aUuid,
710	const char aBackend, const char aAddress, void *pvRemoteBackend,
711	USHORT aPortVersion, ULONG aMaskedIfs, const char *pszCaptureFilename);
712	static DECLCALLBACK(int) i_usbDetachCallback(Console *that, PUVM pUVM, PCRTUUID aUuid);
713	#endif
714
715	static DECLCALLBACK(int) i_attachStorageDevice(Console *pThis,
716	PUVM pUVM,
717	const char *pcszDevice,
718	unsigned uInstance,
719	StorageBus_T enmBus,
720	bool fUseHostIOCache,
721	IMediumAttachment *aMediumAtt,
722	bool fSilent);
723	static DECLCALLBACK(int) i_detachStorageDevice(Console *pThis,
724	PUVM pUVM,
725	const char *pcszDevice,
726	unsigned uInstance,
727	StorageBus_T enmBus,
728	IMediumAttachment *aMediumAtt,
729	bool fSilent);
730	HRESULT i_doStorageDeviceAttach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent);
731	HRESULT i_doStorageDeviceDetach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent);
732
733	static DECLCALLBACK(int) i_stateProgressCallback(PUVM pUVM, unsigned uPercent, void *pvUser);
734
735	static DECLCALLBACK(void) i_genericVMSetErrorCallback(PUVM pUVM, void *pvUser, int rc, RT_SRC_POS_DECL,
736	const char *pszErrorFmt, va_list va);
737
738	void i_setVMRuntimeErrorCallbackF(uint32_t fFatal, const char pszErrorId, const char pszFormat, ...);
739	static DECLCALLBACK(void) i_setVMRuntimeErrorCallback(PUVM pUVM, void *pvUser, uint32_t fFatal,
740	const char pszErrorId, const char pszFormat, va_list va);
741
742	HRESULT i_captureUSBDevices(PUVM pUVM);
743	void i_detachAllUSBDevices(bool aDone);
744
745
746	static DECLCALLBACK(int) i_vmm2User_SaveState(PCVMM2USERMETHODS pThis, PUVM pUVM);
747	static DECLCALLBACK(void) i_vmm2User_NotifyEmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);
748	static DECLCALLBACK(void) i_vmm2User_NotifyEmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);
749	static DECLCALLBACK(void) i_vmm2User_NotifyPdmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM);
750	static DECLCALLBACK(void) i_vmm2User_NotifyPdmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM);
751	static DECLCALLBACK(void) i_vmm2User_NotifyResetTurnedIntoPowerOff(PCVMM2USERMETHODS pThis, PUVM pUVM);
752
753	static DECLCALLBACK(void ) i_drvStatus_QueryInterface(PPDMIBASE pInterface, const char pszIID);
754	static DECLCALLBACK(void) i_drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN);
755	static DECLCALLBACK(int) i_drvStatus_MediumEjected(PPDMIMEDIANOTIFY pInterface, unsigned iLUN);
756	static DECLCALLBACK(void) i_drvStatus_Destruct(PPDMDRVINS pDrvIns);
757	static DECLCALLBACK(int) i_drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags);
758
759	static DECLCALLBACK(int) i_pdmIfSecKey_KeyRetain(PPDMISECKEY pInterface, const char pszId, const uint8_t *ppbKey,
760	size_t *pcbKey);
761	static DECLCALLBACK(int) i_pdmIfSecKey_KeyRelease(PPDMISECKEY pInterface, const char *pszId);
762	static DECLCALLBACK(int) i_pdmIfSecKey_PasswordRetain(PPDMISECKEY pInterface, const char pszId, const char *ppszPassword);
763	static DECLCALLBACK(int) i_pdmIfSecKey_PasswordRelease(PPDMISECKEY pInterface, const char *pszId);
764
765	static DECLCALLBACK(int) i_pdmIfSecKeyHlp_KeyMissingNotify(PPDMISECKEYHLP pInterface);
766
767	int mcAudioRefs;
768	volatile uint32_t mcVRDPClients;
769	uint32_t mu32SingleRDPClientId; /* The id of a connected client in the single connection mode. */
770	volatile bool mcGuestCredentialsProvided;
771
772	static const char *sSSMConsoleUnit;
773	static uint32_t sSSMConsoleVer;
774
775	HRESULT i_loadDataFromSavedState();
776	int i_loadStateFileExecInternal(PSSMHANDLE pSSM, uint32_t u32Version);
777
778	static DECLCALLBACK(void) i_saveStateFileExec(PSSMHANDLE pSSM, void *pvUser);
779	static DECLCALLBACK(int) i_loadStateFileExec(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass);
780
781	#ifdef VBOX_WITH_GUEST_PROPS
782	static DECLCALLBACK(int) i_doGuestPropNotification(void pvExtension, uint32_t, void pvParms, uint32_t cbParms);
783	HRESULT i_doEnumerateGuestProperties(const Utf8Str &aPatterns,
784	std::vector<Utf8Str> &aNames,
785	std::vector<Utf8Str> &aValues,
786	std::vector<LONG64> &aTimestamps,
787	std::vector<Utf8Str> &aFlags);
788
789	void i_guestPropertiesHandleVMReset(void);
790	bool i_guestPropertiesVRDPEnabled(void);
791	void i_guestPropertiesVRDPUpdateLogon(uint32_t u32ClientId, const char pszUser, const char pszDomain);
792	void i_guestPropertiesVRDPUpdateActiveClient(uint32_t u32ClientId);
793	void i_guestPropertiesVRDPUpdateClientAttach(uint32_t u32ClientId, bool fAttached);
794	void i_guestPropertiesVRDPUpdateNameChange(uint32_t u32ClientId, const char *pszName);
795	void i_guestPropertiesVRDPUpdateIPAddrChange(uint32_t u32ClientId, const char *pszIPAddr);
796	void i_guestPropertiesVRDPUpdateLocationChange(uint32_t u32ClientId, const char *pszLocation);
797	void i_guestPropertiesVRDPUpdateOtherInfoChange(uint32_t u32ClientId, const char *pszOtherInfo);
798	void i_guestPropertiesVRDPUpdateDisconnect(uint32_t u32ClientId);
799	#endif
800
801	bool i_isResetTurnedIntoPowerOff(void);
802
803	/** @name Disk encryption support
804	* @{ */
805	HRESULT i_consoleParseDiskEncryption(const char psz, const char *ppszEnd);
806	HRESULT i_configureEncryptionForDisk(const Utf8Str &strId, unsigned *pcDisksConfigured);
807	HRESULT i_clearDiskEncryptionKeysOnAllAttachmentsWithKeyId(const Utf8Str &strId);
808	HRESULT i_initSecretKeyIfOnAllAttachments(void);
809	int i_consoleParseKeyValue(const char psz, const char *ppszEnd,
810	char ppszKey, char ppszVal);
811	void i_removeSecretKeysOnSuspend();
812	/** @} */
813
814	/** @name Teleporter support
815	* @{ */
816	static DECLCALLBACK(int) i_teleporterSrcThreadWrapper(RTTHREAD hThread, void *pvUser);
817	HRESULT i_teleporterSrc(TeleporterStateSrc *pState);
818	HRESULT i_teleporterSrcReadACK(TeleporterStateSrc pState, const char pszWhich, const char *pszNAckMsg = NULL);
819	HRESULT i_teleporterSrcSubmitCommand(TeleporterStateSrc pState, const char pszCommand, bool fWaitForAck = true);
820	HRESULT i_teleporterTrg(PUVM pUVM, IMachine pMachine, Utf8Str pErrorMsg, bool fStartPaused,
821	Progress pProgress, bool pfPowerOffOnFailure);
822	static DECLCALLBACK(int) i_teleporterTrgServeConnection(RTSOCKET Sock, void *pvUser);
823	/** @} */
824
825	bool mSavedStateDataLoaded : 1;
826
827	const ComPtr<IMachine> mMachine;
828	const ComPtr<IInternalMachineControl> mControl;
829
830	const ComPtr<IVRDEServer> mVRDEServer;
831
832	ConsoleVRDPServer * const mConsoleVRDPServer;
833	bool mfVRDEChangeInProcess;
834	bool mfVRDEChangePending;
835
836	const ComObjPtr<Guest> mGuest;
837	const ComObjPtr<Keyboard> mKeyboard;
838	const ComObjPtr<Mouse> mMouse;
839	const ComObjPtr<Display> mDisplay;
840	const ComObjPtr<MachineDebugger> mDebugger;
841	const ComObjPtr<VRDEServerInfo> mVRDEServerInfo;
842	/** This can safely be used without holding any locks.
843	* An AutoCaller suffices to prevent it being destroy while in use and
844	* internally there is a lock providing the necessary serialization. */
845	const ComObjPtr<EventSource> mEventSource;
846	#ifdef VBOX_WITH_EXTPACK
847	const ComObjPtr<ExtPackManager> mptrExtPackManager;
848	#endif
849	const ComObjPtr<EmulatedUSB> mEmulatedUSB;
850
851	USBDeviceList mUSBDevices;
852	RemoteUSBDeviceList mRemoteUSBDevices;
853
854	SharedFolderDataMap m_mapGlobalSharedFolders;
855	SharedFolderDataMap m_mapMachineSharedFolders;
856	SharedFolderMap m_mapSharedFolders; // the console instances
857
858	/** The user mode VM handle. */
859	PUVM mpUVM;
860	/** Holds the number of "readonly" mpUVM callers (users). */
861	uint32_t mVMCallers;
862	/** Semaphore posted when the number of mpUVM callers drops to zero. */
863	RTSEMEVENT mVMZeroCallersSem;
864	/** true when Console has entered the mpUVM destruction phase. */
865	bool mVMDestroying : 1;
866	/** true when power down is initiated by vmstateChangeCallback (EMT). */
867	bool mVMPoweredOff : 1;
868	/** true when vmstateChangeCallback shouldn't initiate a power down. */
869	bool mVMIsAlreadyPoweringOff : 1;
870	/** true if we already showed the snapshot folder size warning. */
871	bool mfSnapshotFolderSizeWarningShown : 1;
872	/** true if we already showed the snapshot folder ext4/xfs bug warning. */
873	bool mfSnapshotFolderExt4WarningShown : 1;
874	/** true if we already listed the disk type of the snapshot folder. */
875	bool mfSnapshotFolderDiskTypeShown : 1;
876	/** true if a USB controller is available (i.e. USB devices can be attached). */
877	bool mfVMHasUsbController : 1;
878	/** true if the VM power off was caused by reset. */
879	bool mfPowerOffCausedByReset : 1;
880
881	/** Pointer to the VMM -> User (that's us) callbacks. */
882	struct MYVMM2USERMETHODS : public VMM2USERMETHODS
883	{
884	Console *pConsole;
885	} *mpVmm2UserMethods;
886
887	/** The current network attachment type in the VM.
888	* This doesn't have to match the network attachment type maintained in the
889	* NetworkAdapter. This is needed to change the network attachment
890	* dynamically.
891	*/
892	typedef std::vector<NetworkAttachmentType_T> NetworkAttachmentTypeVector;
893	NetworkAttachmentTypeVector meAttachmentType;
894
895	VMMDev * m_pVMMDev;
896	AudioVRDE * const mAudioVRDE;
897	Nvram * const mNvram;
898	#ifdef VBOX_WITH_USB_CARDREADER
899	UsbCardReader * const mUsbCardReader;
900	#endif
901	BusAssignmentManager* mBusMgr;
902
903	enum
904	{
905	iLedFloppy = 0,
906	cLedFloppy = 2,
907	iLedIde = iLedFloppy + cLedFloppy,
908	cLedIde = 4,
909	iLedSata = iLedIde + cLedIde,
910	cLedSata = 30,
911	iLedScsi = iLedSata + cLedSata,
912	cLedScsi = 16,
913	iLedSas = iLedScsi + cLedScsi,
914	cLedSas = 8,
915	iLedUsb = iLedSas + cLedSas,
916	cLedUsb = 8,
917	iLedNvme = iLedUsb + cLedUsb,
918	cLedNvme = 30,
919	cLedStorage = cLedFloppy + cLedIde + cLedSata + cLedScsi + cLedSas + cLedUsb + cLedNvme
920	};
921	DeviceType_T maStorageDevType[cLedStorage];
922	PPDMLED mapStorageLeds[cLedStorage];
923	PPDMLED mapNetworkLeds[36]; /*< @todo adapt this to the maximum network card count /
924	PPDMLED mapSharedFolderLed;
925	PPDMLED mapUSBLed[2];
926	PPDMLED mapCrOglLed;
927
928	MediumAttachmentMap mapMediumAttachments;
929
930	/** List of attached USB storage devices. */
931	USBStorageDeviceList mUSBStorageDevices;
932
933	/** Store for secret keys. */
934	SecretKeyStore * const m_pKeyStore;
935	/** Number of disks configured for encryption. */
936	unsigned m_cDisksEncrypted;
937	/** Number of disks which have the key in the map. */
938	unsigned m_cDisksPwProvided;
939
940	/** Pointer to the key consumer -> provider (that's us) callbacks. */
941	struct MYPDMISECKEY : public PDMISECKEY
942	{
943	Console *pConsole;
944	} *mpIfSecKey;
945
946	/** Pointer to the key helpers -> provider (that's us) callbacks. */
947	struct MYPDMISECKEYHLP : public PDMISECKEYHLP
948	{
949	Console *pConsole;
950	} *mpIfSecKeyHlp;
951
952	/* Note: FreeBSD needs this whether netflt is used or not. */
953	#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) \|\| defined(RT_OS_FREEBSD))
954	Utf8Str maTAPDeviceName[8];
955	RTFILE maTapFD[8];
956	#endif
957
958	bool mVMStateChangeCallbackDisabled;
959
960	bool mfUseHostClipboard;
961
962	/** Local machine state value. */
963	MachineState_T mMachineState;
964
965	/** Machine uuid string. */
966	Bstr mstrUuid;
967
968	/** Pointer to the progress object of a live cancelable task.
969	*
970	* This is currently only used by Console::Teleport(), but is intended to later
971	* be used by the live snapshot code path as well. Actions like
972	* Console::PowerDown, which automatically cancels out the running snapshot /
973	* teleportation operation, will cancel the teleportation / live snapshot
974	* operation before starting. */
975	ComPtr<IProgress> mptrCancelableProgress;
976
977	ComPtr<IEventListener> mVmListener;
978
979	friend class VMTask;
980	friend class ConsoleVRDPServer;
981	};
982
983	#endif // !____H_CONSOLEIMPL
984	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

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

source: vbox/trunk/src/VBox/Main/include/ConsoleImpl.h@ 61644

Download in other formats: