ConsoleImpl.h@ 44421

Last change on this file since 44421 was 44421, checked in by vboxsync, 12 years ago
mpVM -> mpUVM in comments and such.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.7 KB

Line
1	/* $Id: ConsoleImpl.h 44421 2013-01-28 12:42:07Z vboxsync $ */
2	/** @file
3	* VBox Console COM Class definition
4	*/
5
6	/*
7	* Copyright (C) 2005-2013 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
25	class Guest;
26	class Keyboard;
27	class Mouse;
28	class Display;
29	class MachineDebugger;
30	class TeleporterStateSrc;
31	class OUSBDevice;
32	class RemoteUSBDevice;
33	class SharedFolder;
34	class VRDEServerInfo;
35	class AudioSniffer;
36	class Nvram;
37	#ifdef VBOX_WITH_USB_VIDEO
38	class EmWebcam;
39	#endif
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
52	#include <VBox/RemoteDesktop/VRDE.h>
53	#include <VBox/vmm/pdmdrv.h>
54	#ifdef VBOX_WITH_GUEST_PROPS
55	# include <VBox/HostServices/GuestPropertySvc.h> /* For the property notification callback */
56	#endif
57
58	#ifdef RT_OS_WINDOWS
59	# include "../src-server/win/VBoxComEvents.h"
60	#endif
61
62	struct VUSBIRHCONFIG;
63	typedef struct VUSBIRHCONFIG *PVUSBIRHCONFIG;
64
65	#include <list>
66	#include <vector>
67
68	// defines
69	///////////////////////////////////////////////////////////////////////////////
70
71	/**
72	* Checks the availability of the underlying VM device driver corresponding
73	* to the COM interface (IKeyboard, IMouse, IDisplay, etc.). When the driver is
74	* not available (NULL), sets error info and returns returns E_ACCESSDENIED.
75	* The translatable error message is defined in null context.
76	*
77	* Intended to used only within Console children (i.e. Keyboard, Mouse,
78	* Display, etc.).
79	*
80	* @param drv driver pointer to check (compare it with NULL)
81	*/
82	#define CHECK_CONSOLE_DRV(drv) \
83	do { \
84	if (!(drv)) \
85	return setError(E_ACCESSDENIED, tr("The console is not powered up")); \
86	} while (0)
87
88	// Console
89	///////////////////////////////////////////////////////////////////////////////
90
91	/** IConsole implementation class */
92	class ATL_NO_VTABLE Console :
93	public VirtualBoxBase,
94	VBOX_SCRIPTABLE_IMPL(IConsole)
95	{
96	Q_OBJECT
97
98	public:
99
100	VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(Console, IConsole)
101
102	DECLARE_NOT_AGGREGATABLE(Console)
103
104	DECLARE_PROTECT_FINAL_CONSTRUCT()
105
106	BEGIN_COM_MAP(Console)
107	VBOX_DEFAULT_INTERFACE_ENTRIES(IConsole)
108	END_COM_MAP()
109
110	Console();
111	~Console();
112
113	HRESULT FinalConstruct();
114	void FinalRelease();
115
116	// public initializers/uninitializers for internal purposes only
117	HRESULT init(IMachine aMachine, IInternalMachineControl aControl, LockType_T aLockType);
118	void uninit();
119
120	// IConsole properties
121	STDMETHOD(COMGETTER(Machine))(IMachine **aMachine);
122	STDMETHOD(COMGETTER(State))(MachineState_T *aMachineState);
123	STDMETHOD(COMGETTER(Guest))(IGuest **aGuest);
124	STDMETHOD(COMGETTER(Keyboard))(IKeyboard **aKeyboard);
125	STDMETHOD(COMGETTER(Mouse))(IMouse **aMouse);
126	STDMETHOD(COMGETTER(Display))(IDisplay **aDisplay);
127	STDMETHOD(COMGETTER(Debugger))(IMachineDebugger **aDebugger);
128	STDMETHOD(COMGETTER(USBDevices))(ComSafeArrayOut(IUSBDevice *, aUSBDevices));
129	STDMETHOD(COMGETTER(RemoteUSBDevices))(ComSafeArrayOut(IHostUSBDevice *, aRemoteUSBDevices));
130	STDMETHOD(COMGETTER(VRDEServerInfo))(IVRDEServerInfo **aVRDEServerInfo);
131	STDMETHOD(COMGETTER(SharedFolders))(ComSafeArrayOut(ISharedFolder *, aSharedFolders));
132	STDMETHOD(COMGETTER(EventSource)) (IEventSource ** aEventSource);
133	STDMETHOD(COMGETTER(AttachedPCIDevices))(ComSafeArrayOut(IPCIDeviceAttachment *, aAttachments));
134	STDMETHOD(COMGETTER(UseHostClipboard))(BOOL *aUseHostClipboard);
135	STDMETHOD(COMSETTER(UseHostClipboard))(BOOL aUseHostClipboard);
136
137	// IConsole methods
138	STDMETHOD(PowerUp)(IProgress **aProgress);
139	STDMETHOD(PowerUpPaused)(IProgress **aProgress);
140	STDMETHOD(PowerDown)(IProgress **aProgress);
141	STDMETHOD(Reset)();
142	STDMETHOD(Pause)();
143	STDMETHOD(Resume)();
144	STDMETHOD(PowerButton)();
145	STDMETHOD(SleepButton)();
146	STDMETHOD(GetPowerButtonHandled)(BOOL *aHandled);
147	STDMETHOD(GetGuestEnteredACPIMode)(BOOL *aEntered);
148	STDMETHOD(SaveState)(IProgress **aProgress);
149	STDMETHOD(AdoptSavedState)(IN_BSTR aSavedStateFile);
150	STDMETHOD(DiscardSavedState)(BOOL aRemoveFile);
151	STDMETHOD(GetDeviceActivity)(DeviceType_T aDeviceType,
152	DeviceActivity_T *aDeviceActivity);
153	STDMETHOD(AttachUSBDevice)(IN_BSTR aId);
154	STDMETHOD(DetachUSBDevice)(IN_BSTR aId, IUSBDevice **aDevice);
155	STDMETHOD(FindUSBDeviceByAddress)(IN_BSTR aAddress, IUSBDevice **aDevice);
156	STDMETHOD(FindUSBDeviceById)(IN_BSTR aId, IUSBDevice **aDevice);
157	STDMETHOD(CreateSharedFolder)(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);
158	STDMETHOD(RemoveSharedFolder)(IN_BSTR aName);
159	STDMETHOD(TakeSnapshot)(IN_BSTR aName, IN_BSTR aDescription,
160	IProgress **aProgress);
161	STDMETHOD(DeleteSnapshot)(IN_BSTR aId, IProgress **aProgress);
162	STDMETHOD(DeleteSnapshotAndAllChildren)(IN_BSTR aId, IProgress **aProgress);
163	STDMETHOD(DeleteSnapshotRange)(IN_BSTR aStartId, IN_BSTR aEndId, IProgress **aProgress);
164	STDMETHOD(RestoreSnapshot)(ISnapshot aSnapshot, IProgress *aProgress);
165	STDMETHOD(Teleport)(IN_BSTR aHostname, ULONG aPort, IN_BSTR aPassword, ULONG aMaxDowntime, IProgress **aProgress);
166
167	// public methods for internal purposes only
168
169	/*
170	* Note: the following methods do not increase refcount. intended to be
171	* called only by the VM execution thread.
172	*/
173
174	Guest *getGuest() const { return mGuest; }
175	Keyboard *getKeyboard() const { return mKeyboard; }
176	Mouse *getMouse() const { return mMouse; }
177	Display *getDisplay() const { return mDisplay; }
178	MachineDebugger *getMachineDebugger() const { return mDebugger; }
179	AudioSniffer *getAudioSniffer() const { return mAudioSniffer; }
180
181	const ComPtr<IMachine> &machine() const { return mMachine; }
182
183	bool useHostClipboard() { return mfUseHostClipboard; }
184
185	/** Method is called only from ConsoleVRDPServer */
186	IVRDEServer *getVRDEServer() const { return mVRDEServer; }
187
188	ConsoleVRDPServer *consoleVRDPServer() const { return mConsoleVRDPServer; }
189
190	HRESULT updateMachineState(MachineState_T aMachineState);
191
192	// events from IInternalSessionControl
193	HRESULT onNetworkAdapterChange(INetworkAdapter *aNetworkAdapter, BOOL changeAdapter);
194	HRESULT onSerialPortChange(ISerialPort *aSerialPort);
195	HRESULT onParallelPortChange(IParallelPort *aParallelPort);
196	HRESULT onStorageControllerChange();
197	HRESULT onMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce);
198	HRESULT onCPUChange(ULONG aCPU, BOOL aRemove);
199	HRESULT onCPUExecutionCapChange(ULONG aExecutionCap);
200	HRESULT onClipboardModeChange(ClipboardMode_T aClipboardMode);
201	HRESULT onDragAndDropModeChange(DragAndDropMode_T aDragAndDropMode);
202	HRESULT onVRDEServerChange(BOOL aRestart);
203	HRESULT onUSBControllerChange();
204	HRESULT onSharedFolderChange(BOOL aGlobal);
205	HRESULT onUSBDeviceAttach(IUSBDevice aDevice, IVirtualBoxErrorInfo aError, ULONG aMaskedIfs);
206	HRESULT onUSBDeviceDetach(IN_BSTR aId, IVirtualBoxErrorInfo *aError);
207	HRESULT onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);
208	HRESULT onStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove);
209	HRESULT getGuestProperty(IN_BSTR aKey, BSTR aValue, LONG64 aTimestamp, BSTR *aFlags);
210	HRESULT setGuestProperty(IN_BSTR aKey, IN_BSTR aValue, IN_BSTR aFlags);
211	HRESULT enumerateGuestProperties(IN_BSTR aPatterns,
212	ComSafeArrayOut(BSTR, aNames),
213	ComSafeArrayOut(BSTR, aValues),
214	ComSafeArrayOut(LONG64, aTimestamps),
215	ComSafeArrayOut(BSTR, aFlags));
216	HRESULT onlineMergeMedium(IMediumAttachment *aMediumAttachment,
217	ULONG aSourceIdx, ULONG aTargetIdx,
218	IMedium aSource, IMedium aTarget,
219	BOOL aMergeForward, IMedium *aParentForTarget,
220	ComSafeArrayIn(IMedium *, aChildrenToReparent),
221	IProgress *aProgress);
222	VMMDev *getVMMDev() { return m_pVMMDev; }
223	AudioSniffer *getAudioSniffer() { return mAudioSniffer; }
224	#ifdef VBOX_WITH_EXTPACK
225	ExtPackManager *getExtPackManager();
226	#endif
227	EventSource *getEventSource() { return mEventSource; }
228	#ifdef VBOX_WITH_USB_CARDREADER
229	UsbCardReader *getUsbCardReader() { return mUsbCardReader; }
230	#endif
231	#ifdef VBOX_WITH_USB_VIDEO
232	EmWebcam *getEmWebcam() { return mEmWebcam; }
233	#endif
234
235	int VRDPClientLogon(uint32_t u32ClientId, const char pszUser, const char pszPassword, const char *pszDomain);
236	void VRDPClientStatusChange(uint32_t u32ClientId, const char *pszStatus);
237	void VRDPClientConnect(uint32_t u32ClientId);
238	void VRDPClientDisconnect(uint32_t u32ClientId, uint32_t fu32Intercepted);
239	void VRDPInterceptAudio(uint32_t u32ClientId);
240	void VRDPInterceptUSB(uint32_t u32ClientId, void **ppvIntercept);
241	void VRDPInterceptClipboard(uint32_t u32ClientId);
242
243	void processRemoteUSBDevices(uint32_t u32ClientId, VRDEUSBDEVICEDESC *pDevList, uint32_t cbDevList, bool fDescExt);
244	void reportVmStatistics(ULONG aValidStats, ULONG aCpuUser,
245	ULONG aCpuKernel, ULONG aCpuIdle,
246	ULONG aMemTotal, ULONG aMemFree,
247	ULONG aMemBalloon, ULONG aMemShared,
248	ULONG aMemCache, ULONG aPageTotal,
249	ULONG aAllocVMM, ULONG aFreeVMM,
250	ULONG aBalloonedVMM, ULONG aSharedVMM,
251	ULONG aVmNetRx, ULONG aVmNetTx)
252	{
253	mControl->ReportVmStatistics(aValidStats, aCpuUser, aCpuKernel, aCpuIdle,
254	aMemTotal, aMemFree, aMemBalloon, aMemShared,
255	aMemCache, aPageTotal, aAllocVMM, aFreeVMM,
256	aBalloonedVMM, aSharedVMM, aVmNetRx, aVmNetTx);
257	}
258	void enableVMMStatistics(BOOL aEnable);
259
260	// callback callers (partly; for some events console callbacks are notified
261	// directly from IInternalSessionControl event handlers declared above)
262	void onMousePointerShapeChange(bool fVisible, bool fAlpha,
263	uint32_t xHot, uint32_t yHot,
264	uint32_t width, uint32_t height,
265	ComSafeArrayIn(uint8_t, aShape));
266	void onMouseCapabilityChange(BOOL supportsAbsolute, BOOL supportsRelative, BOOL needsHostCursor);
267	void onStateChange(MachineState_T aMachineState);
268	void onAdditionsStateChange();
269	void onAdditionsOutdated();
270	void onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock);
271	void onUSBDeviceStateChange(IUSBDevice *aDevice, bool aAttached,
272	IVirtualBoxErrorInfo *aError);
273	void onRuntimeError(BOOL aFatal, IN_BSTR aErrorID, IN_BSTR aMessage);
274	HRESULT onShowWindow(BOOL aCheck, BOOL aCanShow, LONG64 aWinId);
275	void onVRDEServerInfoChange();
276
277	static const PDMDRVREG DrvStatusReg;
278
279	static HRESULT setErrorStatic(HRESULT aResultCode, const char *pcsz, ...);
280	HRESULT setInvalidMachineStateError();
281
282	static const char *convertControllerTypeToDev(StorageControllerType_T enmCtrlType);
283	static HRESULT convertBusPortDeviceToLun(StorageBus_T enmBus, LONG port, LONG device, unsigned &uLun);
284	// Called from event listener
285	HRESULT onNATRedirectRuleChange(ULONG ulInstance, BOOL aNatRuleRemove,
286	NATProtocol_T aProto, IN_BSTR aHostIp, LONG aHostPort, IN_BSTR aGuestIp, LONG aGuestPort);
287
288	private:
289
290	/**
291	* Base template for AutoVMCaller and SaveVMPtr. Template arguments
292	* have the same meaning as arguments of Console::addVMCaller().
293	*/
294	template <bool taQuiet = false, bool taAllowNullVM = false>
295	class AutoVMCallerBase
296	{
297	public:
298	AutoVMCallerBase(Console *aThat) : mThat(aThat), mRC(S_OK)
299	{
300	Assert(aThat);
301	mRC = aThat->addVMCaller(taQuiet, taAllowNullVM);
302	}
303	~AutoVMCallerBase()
304	{
305	if (SUCCEEDED(mRC))
306	mThat->releaseVMCaller();
307	}
308	/** Decreases the number of callers before the instance is destroyed. */
309	void releaseCaller()
310	{
311	AssertReturnVoid(SUCCEEDED(mRC));
312	mThat->releaseVMCaller();
313	mRC = E_FAIL;
314	}
315	/** Restores the number of callers after by #release(). #rc() must be
316	* rechecked to ensure the operation succeeded. */
317	void addYY()
318	{
319	AssertReturnVoid(!SUCCEEDED(mRC));
320	mRC = mThat->addVMCaller(taQuiet, taAllowNullVM);
321	}
322	/** Returns the result of Console::addVMCaller() */
323	HRESULT rc() const { return mRC; }
324	/** Shortcut to SUCCEEDED(rc()) */
325	bool isOk() const { return SUCCEEDED(mRC); }
326	protected:
327	Console *mThat;
328	HRESULT mRC;
329	private:
330	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(AutoVMCallerBase)
331	};
332
333	#if 0
334	/**
335	* Helper class that protects sections of code using the mpUVM pointer by
336	* automatically calling addVMCaller() on construction and
337	* releaseVMCaller() on destruction. Intended for Console methods dealing
338	* with mpUVM. The usage pattern is:
339	* <code>
340	* AutoVMCaller autoVMCaller(this);
341	* if (FAILED(autoVMCaller.rc())) return autoVMCaller.rc();
342	* ...
343	* VMR3ReqCall (mpUVM, ...
344	* </code>
345	*
346	* @note Temporarily locks the argument for writing.
347	*
348	* @sa SafeVMPtr, SafeVMPtrQuiet
349	* @obsolete Use SafeVMPtr
350	*/
351	typedef AutoVMCallerBase<false, false> AutoVMCaller;
352	#endif
353
354	/**
355	* Same as AutoVMCaller but doesn't set extended error info on failure.
356	*
357	* @note Temporarily locks the argument for writing.
358	* @obsolete Use SafeVMPtrQuiet
359	*/
360	typedef AutoVMCallerBase<true, false> AutoVMCallerQuiet;
361
362	/**
363	* Same as AutoVMCaller but allows a null VM pointer (to trigger an error
364	* instead of assertion).
365	*
366	* @note Temporarily locks the argument for writing.
367	* @obsolete Use SafeVMPtr
368	*/
369	typedef AutoVMCallerBase<false, true> AutoVMCallerWeak;
370
371	/**
372	* Same as AutoVMCaller but doesn't set extended error info on failure
373	* and allows a null VM pointer (to trigger an error instead of
374	* assertion).
375	*
376	* @note Temporarily locks the argument for writing.
377	* @obsolete Use SafeVMPtrQuiet
378	*/
379	typedef AutoVMCallerBase<true, true> AutoVMCallerQuietWeak;
380
381	/**
382	* Base template for SaveVMPtr and SaveVMPtrQuiet.
383	*/
384	template<bool taQuiet = false>
385	class SafeVMPtrBase : public AutoVMCallerBase<taQuiet, true>
386	{
387	typedef AutoVMCallerBase<taQuiet, true> Base;
388	public:
389	SafeVMPtrBase(Console *aThat) : Base(aThat), mpUVM(NULL)
390	{
391	if (SUCCEEDED(Base::mRC))
392	Base::mRC = aThat->safeVMPtrRetainer(&mpUVM, taQuiet);
393	}
394	~SafeVMPtrBase()
395	{
396	if (SUCCEEDED(Base::mRC))
397	release();
398	}
399	/** Direct PUVM access. */
400	PUVM rawUVM() const { return mpUVM; }
401	/** Release the handles. */
402	void release()
403	{
404	AssertReturnVoid(SUCCEEDED(Base::mRC));
405	Base::mThat->safeVMPtrReleaser(&mpUVM);
406	Base::releaseCaller();
407	}
408
409	private:
410	PUVM mpUVM;
411	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(SafeVMPtrBase)
412	};
413
414	public:
415
416	/**
417	* Helper class that safely manages the Console::mpUVM pointer
418	* by calling addVMCaller() on construction and releaseVMCaller() on
419	* destruction. Intended for Console children. The usage pattern is:
420	* <code>
421	* Console::SaveVMPtr pVM(mParent);
422	* if (FAILED(pVM.rc())) return pVM.rc();
423	* ...
424	* VMR3ReqCall(pVM, ...
425	* ...
426	* printf("%p\n", pVM.raw());
427	* </code>
428	*
429	* @note Temporarily locks the argument for writing.
430	*
431	* @sa SafeVMPtrQuiet, AutoVMCaller
432	*/
433	typedef SafeVMPtrBase<false> SafeVMPtr;
434
435	/**
436	* A deviation of SaveVMPtr that doesn't set the error info on failure.
437	* Intended for pieces of code that don't need to return the VM access
438	* failure to the caller. The usage pattern is:
439	* <code>
440	* Console::SaveVMPtrQuiet pVM(mParent);
441	* if (pVM.rc())
442	* VMR3ReqCall(pVM, ...
443	* return S_OK;
444	* </code>
445	*
446	* @note Temporarily locks the argument for writing.
447	*
448	* @sa SafeVMPtr, AutoVMCaller
449	*/
450	typedef SafeVMPtrBase<true> SafeVMPtrQuiet;
451
452	class SharedFolderData
453	{
454	public:
455	SharedFolderData()
456	{ }
457
458	SharedFolderData(const Utf8Str &aHostPath,
459	bool aWritable,
460	bool aAutoMount)
461	: m_strHostPath(aHostPath),
462	m_fWritable(aWritable),
463	m_fAutoMount(aAutoMount)
464	{ }
465
466	// copy constructor
467	SharedFolderData(const SharedFolderData& aThat)
468	: m_strHostPath(aThat.m_strHostPath),
469	m_fWritable(aThat.m_fWritable),
470	m_fAutoMount(aThat.m_fAutoMount)
471	{ }
472
473	Utf8Str m_strHostPath;
474	bool m_fWritable;
475	bool m_fAutoMount;
476	};
477
478	typedef std::map<Utf8Str, ComObjPtr<SharedFolder> > SharedFolderMap;
479	typedef std::map<Utf8Str, SharedFolderData> SharedFolderDataMap;
480	typedef std::map<Utf8Str, ComPtr<IMediumAttachment> > MediumAttachmentMap;
481
482	private:
483
484	typedef std::list <ComObjPtr<OUSBDevice> > USBDeviceList;
485	typedef std::list <ComObjPtr<RemoteUSBDevice> > RemoteUSBDeviceList;
486
487	HRESULT addVMCaller(bool aQuiet = false, bool aAllowNullVM = false);
488	void releaseVMCaller();
489	HRESULT safeVMPtrRetainer(PUVM *a_ppUVM, bool aQuiet);
490	void safeVMPtrReleaser(PUVM *a_ppUVM);
491
492	HRESULT consoleInitReleaseLog(const ComPtr<IMachine> aMachine);
493
494	HRESULT powerUp(IProgress **aProgress, bool aPaused);
495	HRESULT powerDown(IProgress *aProgress = NULL);
496
497	/* Note: FreeBSD needs this whether netflt is used or not. */
498	#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) \|\| defined(RT_OS_FREEBSD))
499	HRESULT attachToTapInterface(INetworkAdapter *networkAdapter);
500	HRESULT detachFromTapInterface(INetworkAdapter *networkAdapter);
501	#endif
502	HRESULT powerDownHostInterfaces();
503
504	HRESULT setMachineState(MachineState_T aMachineState, bool aUpdateServer = true);
505	HRESULT setMachineStateLocally(MachineState_T aMachineState)
506	{
507	return setMachineState(aMachineState, false /* aUpdateServer */);
508	}
509
510	HRESULT findSharedFolder(const Utf8Str &strName,
511	ComObjPtr<SharedFolder> &aSharedFolder,
512	bool aSetError = false);
513
514	HRESULT fetchSharedFolders(BOOL aGlobal);
515	bool findOtherSharedFolder(const Utf8Str &straName,
516	SharedFolderDataMap::const_iterator &aIt);
517
518	HRESULT createSharedFolder(const Utf8Str &strName, const SharedFolderData &aData);
519	HRESULT removeSharedFolder(const Utf8Str &strName);
520
521	static DECLCALLBACK(int) configConstructor(PUVM pUVM, PVM pVM, void *pvConsole);
522	int configConstructorInner(PUVM pUVM, PVM pVM, AutoWriteLock *pAlock);
523	int configCfgmOverlay(PCFGMNODE pRoot, IVirtualBox pVirtualBox, IMachine pMachine);
524	int configDumpAPISettingsTweaks(IVirtualBox pVirtualBox, IMachine pMachine);
525
526	int configMediumAttachment(PCFGMNODE pCtlInst,
527	const char *pcszDevice,
528	unsigned uInstance,
529	StorageBus_T enmBus,
530	bool fUseHostIOCache,
531	bool fBuiltinIoCache,
532	bool fSetupMerge,
533	unsigned uMergeSource,
534	unsigned uMergeTarget,
535	IMediumAttachment *pMediumAtt,
536	MachineState_T aMachineState,
537	HRESULT *phrc,
538	bool fAttachDetach,
539	bool fForceUnmount,
540	bool fHotplug,
541	PUVM pUVM,
542	DeviceType_T *paLedDevType);
543	int configMedium(PCFGMNODE pLunL0,
544	bool fPassthrough,
545	DeviceType_T enmType,
546	bool fUseHostIOCache,
547	bool fBuiltinIoCache,
548	bool fSetupMerge,
549	unsigned uMergeSource,
550	unsigned uMergeTarget,
551	const char *pcszBwGroup,
552	bool fDiscard,
553	IMedium *pMedium,
554	MachineState_T aMachineState,
555	HRESULT *phrc);
556	static DECLCALLBACK(int) reconfigureMediumAttachment(Console *pConsole,
557	PUVM pUVM,
558	const char *pcszDevice,
559	unsigned uInstance,
560	StorageBus_T enmBus,
561	bool fUseHostIOCache,
562	bool fBuiltinIoCache,
563	bool fSetupMerge,
564	unsigned uMergeSource,
565	unsigned uMergeTarget,
566	IMediumAttachment *aMediumAtt,
567	MachineState_T aMachineState,
568	HRESULT *phrc);
569	static DECLCALLBACK(int) changeRemovableMedium(Console *pThis,
570	PUVM pUVM,
571	const char *pcszDevice,
572	unsigned uInstance,
573	StorageBus_T enmBus,
574	bool fUseHostIOCache,
575	IMediumAttachment *aMediumAtt,
576	bool fForce);
577
578	HRESULT attachRawPCIDevices(PUVM pUVM, BusAssignmentManager *BusMgr, PCFGMNODE pDevices);
579	void attachStatusDriver(PCFGMNODE pCtlInst, PPDMLED *papLeds,
580	uint64_t uFirst, uint64_t uLast,
581	Console::MediumAttachmentMap *pmapMediumAttachments,
582	const char *pcszDevice, unsigned uInstance);
583
584	int configNetwork(const char *pszDevice, unsigned uInstance, unsigned uLun,
585	INetworkAdapter *aNetworkAdapter, PCFGMNODE pCfg,
586	PCFGMNODE pLunL0, PCFGMNODE pInst,
587	bool fAttachDetach, bool fIgnoreConnectFailure);
588
589	static DECLCALLBACK(int) configGuestProperties(void *pvConsole, PUVM pUVM);
590	static DECLCALLBACK(int) configGuestControl(void *pvConsole);
591	static DECLCALLBACK(void) vmstateChangeCallback(PUVM pUVM, VMSTATE enmState, VMSTATE enmOldState, void *pvUser);
592	static DECLCALLBACK(int) unplugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);
593	static DECLCALLBACK(int) plugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);
594	HRESULT doMediumChange(IMediumAttachment *aMediumAttachment, bool fForce, PUVM pUVM);
595	HRESULT doCPURemove(ULONG aCpu, PUVM pUVM);
596	HRESULT doCPUAdd(ULONG aCpu, PUVM pUVM);
597
598	HRESULT doNetworkAdapterChange(PUVM pUVM, const char *pszDevice, unsigned uInstance,
599	unsigned uLun, INetworkAdapter *aNetworkAdapter);
600	static DECLCALLBACK(int) changeNetworkAttachment(Console pThis, PUVM pUVM, const char pszDevice,
601	unsigned uInstance, unsigned uLun,
602	INetworkAdapter *aNetworkAdapter);
603
604	void changeClipboardMode(ClipboardMode_T aClipboardMode);
605	void changeDragAndDropMode(DragAndDropMode_T aDragAndDropMode);
606
607	#ifdef VBOX_WITH_USB
608	HRESULT attachUSBDevice(IUSBDevice *aHostDevice, ULONG aMaskedIfs);
609	HRESULT detachUSBDevice(const ComObjPtr<OUSBDevice> &aHostDevice);
610
611	static DECLCALLBACK(int) usbAttachCallback(Console that, PUVM pUVM, IUSBDevice aHostDevice, PCRTUUID aUuid,
612	bool aRemote, const char aAddress, void pvRemoteBackend, USHORT aPortVersion, ULONG aMaskedIfs);
613	static DECLCALLBACK(int) usbDetachCallback(Console *that, PUVM pUVM, PCRTUUID aUuid);
614	#endif
615
616	static DECLCALLBACK(int) attachStorageDevice(Console *pThis,
617	PUVM pUVM,
618	const char *pcszDevice,
619	unsigned uInstance,
620	StorageBus_T enmBus,
621	bool fUseHostIOCache,
622	IMediumAttachment *aMediumAtt);
623	static DECLCALLBACK(int) detachStorageDevice(Console *pThis,
624	PUVM pUVM,
625	const char *pcszDevice,
626	unsigned uInstance,
627	StorageBus_T enmBus,
628	IMediumAttachment *aMediumAtt);
629	HRESULT doStorageDeviceAttach(IMediumAttachment *aMediumAttachment, PUVM pUVM);
630	HRESULT doStorageDeviceDetach(IMediumAttachment *aMediumAttachment, PUVM pUVM);
631
632	static DECLCALLBACK(int) fntTakeSnapshotWorker(RTTHREAD Thread, void *pvUser);
633
634	static DECLCALLBACK(int) stateProgressCallback(PUVM pUVM, unsigned uPercent, void *pvUser);
635
636	static DECLCALLBACK(void) genericVMSetErrorCallback(PUVM pUVM, void *pvUser, int rc, RT_SRC_POS_DECL,
637	const char *pszErrorFmt, va_list va);
638
639	void setVMRuntimeErrorCallbackF(uint32_t fFatal, const char pszErrorId, const char pszFormat, ...);
640	static DECLCALLBACK(void) setVMRuntimeErrorCallback(PUVM pUVM, void *pvUser, uint32_t fFatal,
641	const char pszErrorId, const char pszFormat, va_list va);
642
643	HRESULT captureUSBDevices(PUVM pUVM);
644	void detachAllUSBDevices(bool aDone);
645
646	static DECLCALLBACK(int) powerUpThread(RTTHREAD Thread, void *pvUser);
647	static DECLCALLBACK(int) saveStateThread(RTTHREAD Thread, void *pvUser);
648	static DECLCALLBACK(int) powerDownThread(RTTHREAD Thread, void *pvUser);
649
650	static DECLCALLBACK(int) vmm2User_SaveState(PCVMM2USERMETHODS pThis, PUVM pUVM);
651	static DECLCALLBACK(void) vmm2User_NotifyEmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);
652	static DECLCALLBACK(void) vmm2User_NotifyEmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);
653	static DECLCALLBACK(void) vmm2User_NotifyPdmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM);
654	static DECLCALLBACK(void) vmm2User_NotifyPdmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM);
655
656	static DECLCALLBACK(void ) drvStatus_QueryInterface(PPDMIBASE pInterface, const char pszIID);
657	static DECLCALLBACK(void) drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN);
658	static DECLCALLBACK(int) drvStatus_MediumEjected(PPDMIMEDIANOTIFY pInterface, unsigned iLUN);
659	static DECLCALLBACK(void) drvStatus_Destruct(PPDMDRVINS pDrvIns);
660	static DECLCALLBACK(int) drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags);
661
662	int mcAudioRefs;
663	volatile uint32_t mcVRDPClients;
664	uint32_t mu32SingleRDPClientId; /* The id of a connected client in the single connection mode. */
665	volatile bool mcGuestCredentialsProvided;
666
667	static const char *sSSMConsoleUnit;
668	static uint32_t sSSMConsoleVer;
669
670	HRESULT loadDataFromSavedState();
671	int loadStateFileExecInternal(PSSMHANDLE pSSM, uint32_t u32Version);
672
673	static DECLCALLBACK(void) saveStateFileExec(PSSMHANDLE pSSM, void *pvUser);
674	static DECLCALLBACK(int) loadStateFileExec(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass);
675
676	#ifdef VBOX_WITH_GUEST_PROPS
677	static DECLCALLBACK(int) doGuestPropNotification(void pvExtension, uint32_t, void pvParms, uint32_t cbParms);
678	HRESULT doEnumerateGuestProperties(CBSTR aPatterns,
679	ComSafeArrayOut(BSTR, aNames),
680	ComSafeArrayOut(BSTR, aValues),
681	ComSafeArrayOut(LONG64, aTimestamps),
682	ComSafeArrayOut(BSTR, aFlags));
683
684	void guestPropertiesHandleVMReset(void);
685	bool guestPropertiesVRDPEnabled(void);
686	void guestPropertiesVRDPUpdateLogon(uint32_t u32ClientId, const char pszUser, const char pszDomain);
687	void guestPropertiesVRDPUpdateActiveClient(uint32_t u32ClientId);
688	void guestPropertiesVRDPUpdateClientAttach(uint32_t u32ClientId, bool fAttached);
689	void guestPropertiesVRDPUpdateNameChange(uint32_t u32ClientId, const char *pszName);
690	void guestPropertiesVRDPUpdateIPAddrChange(uint32_t u32ClientId, const char *pszIPAddr);
691	void guestPropertiesVRDPUpdateLocationChange(uint32_t u32ClientId, const char *pszLocation);
692	void guestPropertiesVRDPUpdateOtherInfoChange(uint32_t u32ClientId, const char *pszOtherInfo);
693	void guestPropertiesVRDPUpdateDisconnect(uint32_t u32ClientId);
694	#endif
695
696	/** @name Teleporter support
697	* @{ */
698	static DECLCALLBACK(int) teleporterSrcThreadWrapper(RTTHREAD hThread, void *pvUser);
699	HRESULT teleporterSrc(TeleporterStateSrc *pState);
700	HRESULT teleporterSrcReadACK(TeleporterStateSrc pState, const char pszWhich, const char *pszNAckMsg = NULL);
701	HRESULT teleporterSrcSubmitCommand(TeleporterStateSrc pState, const char pszCommand, bool fWaitForAck = true);
702	HRESULT teleporterTrg(PUVM pUVM, IMachine pMachine, Utf8Str pErrorMsg, bool fStartPaused,
703	Progress pProgress, bool pfPowerOffOnFailure);
704	static DECLCALLBACK(int) teleporterTrgServeConnection(RTSOCKET Sock, void *pvUser);
705	/** @} */
706
707	bool mSavedStateDataLoaded : 1;
708
709	const ComPtr<IMachine> mMachine;
710	const ComPtr<IInternalMachineControl> mControl;
711
712	const ComPtr<IVRDEServer> mVRDEServer;
713
714	ConsoleVRDPServer * const mConsoleVRDPServer;
715
716	const ComObjPtr<Guest> mGuest;
717	const ComObjPtr<Keyboard> mKeyboard;
718	const ComObjPtr<Mouse> mMouse;
719	const ComObjPtr<Display> mDisplay;
720	const ComObjPtr<MachineDebugger> mDebugger;
721	const ComObjPtr<VRDEServerInfo> mVRDEServerInfo;
722	/** This can safely be used without holding any locks.
723	* An AutoCaller suffices to prevent it being destroy while in use and
724	* internally there is a lock providing the necessary serialization. */
725	const ComObjPtr<EventSource> mEventSource;
726	#ifdef VBOX_WITH_EXTPACK
727	const ComObjPtr<ExtPackManager> mptrExtPackManager;
728	#endif
729
730	USBDeviceList mUSBDevices;
731	RemoteUSBDeviceList mRemoteUSBDevices;
732
733	SharedFolderDataMap m_mapGlobalSharedFolders;
734	SharedFolderDataMap m_mapMachineSharedFolders;
735	SharedFolderMap m_mapSharedFolders; // the console instances
736
737	/** The user mode VM handle. */
738	PUVM mpUVM;
739	/** Holds the number of "readonly" mpUVM callers (users). */
740	uint32_t mVMCallers;
741	/** Semaphore posted when the number of mpUVM callers drops to zero. */
742	RTSEMEVENT mVMZeroCallersSem;
743	/** true when Console has entered the mpUVM destruction phase. */
744	bool mVMDestroying : 1;
745	/** true when power down is initiated by vmstateChangeCallback (EMT). */
746	bool mVMPoweredOff : 1;
747	/** true when vmstateChangeCallback shouldn't initiate a power down. */
748	bool mVMIsAlreadyPoweringOff : 1;
749	/** true if we already showed the snapshot folder size warning. */
750	bool mfSnapshotFolderSizeWarningShown : 1;
751	/** true if we already showed the snapshot folder ext4/xfs bug warning. */
752	bool mfSnapshotFolderExt4WarningShown : 1;
753	/** true if we already listed the disk type of the snapshot folder. */
754	bool mfSnapshotFolderDiskTypeShown : 1;
755
756	/** Pointer to the VMM -> User (that's us) callbacks. */
757	struct MYVMM2USERMETHODS : public VMM2USERMETHODS
758	{
759	Console *pConsole;
760	} *mpVmm2UserMethods;
761
762	/** The current network attachment type in the VM.
763	* This doesn't have to match the network attachment type maintained in the
764	* NetworkAdapter. This is needed to change the network attachment
765	* dynamically.
766	*/
767	typedef std::vector<NetworkAttachmentType_T> NetworkAttachmentTypeVector;
768	NetworkAttachmentTypeVector meAttachmentType;
769
770	VMMDev * m_pVMMDev;
771	AudioSniffer * const mAudioSniffer;
772	Nvram * const mNvram;
773	#ifdef VBOX_WITH_USB_VIDEO
774	EmWebcam * const mEmWebcam;
775	#endif
776	#ifdef VBOX_WITH_USB_CARDREADER
777	UsbCardReader * const mUsbCardReader;
778	#endif
779	BusAssignmentManager* mBusMgr;
780
781	enum
782	{
783	iLedFloppy = 0,
784	cLedFloppy = 2,
785	iLedIde = iLedFloppy + cLedFloppy,
786	cLedIde = 4,
787	iLedSata = iLedIde + cLedIde,
788	cLedSata = 30,
789	iLedScsi = iLedSata + cLedSata,
790	cLedScsi = 16,
791	iLedSas = iLedScsi + cLedScsi,
792	cLedSas = 8,
793	cLedStorage = cLedFloppy + cLedIde + cLedSata + cLedScsi + cLedSas
794	};
795	DeviceType_T maStorageDevType[cLedStorage];
796	PPDMLED mapStorageLeds[cLedStorage];
797	PPDMLED mapNetworkLeds[36]; /*< @todo adapt this to the maximum network card count /
798	PPDMLED mapSharedFolderLed;
799	PPDMLED mapUSBLed[2];
800
801	MediumAttachmentMap mapMediumAttachments;
802
803	/* Note: FreeBSD needs this whether netflt is used or not. */
804	#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) \|\| defined(RT_OS_FREEBSD))
805	Utf8Str maTAPDeviceName[8];
806	RTFILE maTapFD[8];
807	#endif
808
809	bool mVMStateChangeCallbackDisabled;
810
811	bool mfUseHostClipboard;
812
813	/** Local machine state value. */
814	MachineState_T mMachineState;
815
816	/** Pointer to the progress object of a live cancelable task.
817	*
818	* This is currently only used by Console::Teleport(), but is intended to later
819	* be used by the live snapshot code path as well. Actions like
820	* Console::PowerDown, which automatically cancels out the running snapshot /
821	* teleportation operation, will cancel the teleportation / live snapshot
822	* operation before starting. */
823	ComObjPtr<Progress> mptrCancelableProgress;
824
825	/* The purpose of caching of some events is probably in order to
826	automatically fire them at new event listeners. However, there is no
827	(longer?) any code making use of this... */
828	#ifdef CONSOLE_WITH_EVENT_CACHE
829	struct
830	{
831	/** OnMousePointerShapeChange() cache */
832	struct
833	{
834	bool valid;
835	bool visible;
836	bool alpha;
837	uint32_t xHot;
838	uint32_t yHot;
839	uint32_t width;
840	uint32_t height;
841	com::SafeArray<BYTE> shape;
842	} mpsc;
843
844	/** OnMouseCapabilityChange() cache */
845	struct
846	{
847	bool valid;
848	BOOL supportsAbsolute;
849	BOOL supportsRelative;
850	BOOL needsHostCursor;
851	} mcc;
852
853	/** OnKeyboardLedsChange() cache */
854	struct
855	{
856	bool valid;
857	bool numLock;
858	bool capsLock;
859	bool scrollLock;
860	} klc;
861
862	void clear()
863	{
864	RT_ZERO(mcc);
865	RT_ZERO(klc);
866
867	/* We cannot RT_ZERO mpsc because of shape's vtable. */
868	mpsc.shape.setNull();
869	mpsc.valid = mpsc.visible = mpsc.alpha = false;
870	mpsc.xHot = mpsc.yHot = mpsc.width = mpsc.height = 0;
871	}
872	} mCallbackData;
873	#endif
874	ComPtr<IEventListener> mVmListener;
875
876	friend struct VMTask;
877	};
878
879	#endif // !____H_CONSOLEIMPL
880	/* 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@ 44421

Download in other formats: