ConsoleImpl.h@ 46284

Last change on this file since 46284 was 45675, checked in by vboxsync, 12 years ago
Main/Console: OSX fix
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 37.2 KB

Line
1	/* $Id: ConsoleImpl.h 45675 2013-04-23 09:13:50Z 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, BOOL aSilent);
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 SafeVMPtr. 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 SafeVMPtr and SafeVMPtrQuiet.
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::SafeVMPtr ptrVM(mParent);
422	* if (!ptrVM.isOk())
423	* return ptrVM.rc();
424	* ...
425	* VMR3ReqCall(ptrVM.rawUVM(), ...
426	* ...
427	* printf("%p\n", ptrVM.rawUVM());
428	* </code>
429	*
430	* @note Temporarily locks the argument for writing.
431	*
432	* @sa SafeVMPtrQuiet, AutoVMCaller
433	*/
434	typedef SafeVMPtrBase<false> SafeVMPtr;
435
436	/**
437	* A deviation of SafeVMPtr that doesn't set the error info on failure.
438	* Intended for pieces of code that don't need to return the VM access
439	* failure to the caller. The usage pattern is:
440	* <code>
441	* Console::SafeVMPtrQuiet pVM(mParent);
442	* if (pVM.rc())
443	* VMR3ReqCall(pVM, ...
444	* return S_OK;
445	* </code>
446	*
447	* @note Temporarily locks the argument for writing.
448	*
449	* @sa SafeVMPtr, AutoVMCaller
450	*/
451	typedef SafeVMPtrBase<true> SafeVMPtrQuiet;
452
453	class SharedFolderData
454	{
455	public:
456	SharedFolderData()
457	{ }
458
459	SharedFolderData(const Utf8Str &aHostPath,
460	bool aWritable,
461	bool aAutoMount)
462	: m_strHostPath(aHostPath),
463	m_fWritable(aWritable),
464	m_fAutoMount(aAutoMount)
465	{ }
466
467	// copy constructor
468	SharedFolderData(const SharedFolderData& aThat)
469	: m_strHostPath(aThat.m_strHostPath),
470	m_fWritable(aThat.m_fWritable),
471	m_fAutoMount(aThat.m_fAutoMount)
472	{ }
473
474	Utf8Str m_strHostPath;
475	bool m_fWritable;
476	bool m_fAutoMount;
477	};
478
479	typedef std::map<Utf8Str, ComObjPtr<SharedFolder> > SharedFolderMap;
480	typedef std::map<Utf8Str, SharedFolderData> SharedFolderDataMap;
481	typedef std::map<Utf8Str, ComPtr<IMediumAttachment> > MediumAttachmentMap;
482
483	private:
484
485	typedef std::list <ComObjPtr<OUSBDevice> > USBDeviceList;
486	typedef std::list <ComObjPtr<RemoteUSBDevice> > RemoteUSBDeviceList;
487
488	HRESULT addVMCaller(bool aQuiet = false, bool aAllowNullVM = false);
489	void releaseVMCaller();
490	HRESULT safeVMPtrRetainer(PUVM *a_ppUVM, bool aQuiet);
491	void safeVMPtrReleaser(PUVM *a_ppUVM);
492
493	HRESULT consoleInitReleaseLog(const ComPtr<IMachine> aMachine);
494
495	HRESULT powerUp(IProgress **aProgress, bool aPaused);
496	HRESULT powerDown(IProgress *aProgress = NULL);
497
498	/* Note: FreeBSD needs this whether netflt is used or not. */
499	#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) \|\| defined(RT_OS_FREEBSD))
500	HRESULT attachToTapInterface(INetworkAdapter *networkAdapter);
501	HRESULT detachFromTapInterface(INetworkAdapter *networkAdapter);
502	#endif
503	HRESULT powerDownHostInterfaces();
504
505	HRESULT setMachineState(MachineState_T aMachineState, bool aUpdateServer = true);
506	HRESULT setMachineStateLocally(MachineState_T aMachineState)
507	{
508	return setMachineState(aMachineState, false /* aUpdateServer */);
509	}
510
511	HRESULT findSharedFolder(const Utf8Str &strName,
512	ComObjPtr<SharedFolder> &aSharedFolder,
513	bool aSetError = false);
514
515	HRESULT fetchSharedFolders(BOOL aGlobal);
516	bool findOtherSharedFolder(const Utf8Str &straName,
517	SharedFolderDataMap::const_iterator &aIt);
518
519	HRESULT createSharedFolder(const Utf8Str &strName, const SharedFolderData &aData);
520	HRESULT removeSharedFolder(const Utf8Str &strName);
521
522	static DECLCALLBACK(int) configConstructor(PUVM pUVM, PVM pVM, void *pvConsole);
523	int configConstructorInner(PUVM pUVM, PVM pVM, AutoWriteLock *pAlock);
524	int configCfgmOverlay(PCFGMNODE pRoot, IVirtualBox pVirtualBox, IMachine pMachine);
525	int configDumpAPISettingsTweaks(IVirtualBox pVirtualBox, IMachine pMachine);
526
527	int configGraphicsController(PCFGMNODE pDevices, const char *pcszDevice,
528	BusAssignmentManager *pBusMgr,
529	const ComPtr<IMachine> &pMachine,
530	const ComPtr<IBIOSSettings> &biosSettings,
531	bool fHMEnabled);
532	int configMediumAttachment(PCFGMNODE pCtlInst,
533	const char *pcszDevice,
534	unsigned uInstance,
535	StorageBus_T enmBus,
536	bool fUseHostIOCache,
537	bool fBuiltinIoCache,
538	bool fSetupMerge,
539	unsigned uMergeSource,
540	unsigned uMergeTarget,
541	IMediumAttachment *pMediumAtt,
542	MachineState_T aMachineState,
543	HRESULT *phrc,
544	bool fAttachDetach,
545	bool fForceUnmount,
546	bool fHotplug,
547	PUVM pUVM,
548	DeviceType_T *paLedDevType);
549	int configMedium(PCFGMNODE pLunL0,
550	bool fPassthrough,
551	DeviceType_T enmType,
552	bool fUseHostIOCache,
553	bool fBuiltinIoCache,
554	bool fSetupMerge,
555	unsigned uMergeSource,
556	unsigned uMergeTarget,
557	const char *pcszBwGroup,
558	bool fDiscard,
559	IMedium *pMedium,
560	MachineState_T aMachineState,
561	HRESULT *phrc);
562	static DECLCALLBACK(int) reconfigureMediumAttachment(Console *pConsole,
563	PUVM pUVM,
564	const char *pcszDevice,
565	unsigned uInstance,
566	StorageBus_T enmBus,
567	bool fUseHostIOCache,
568	bool fBuiltinIoCache,
569	bool fSetupMerge,
570	unsigned uMergeSource,
571	unsigned uMergeTarget,
572	IMediumAttachment *aMediumAtt,
573	MachineState_T aMachineState,
574	HRESULT *phrc);
575	static DECLCALLBACK(int) changeRemovableMedium(Console *pThis,
576	PUVM pUVM,
577	const char *pcszDevice,
578	unsigned uInstance,
579	StorageBus_T enmBus,
580	bool fUseHostIOCache,
581	IMediumAttachment *aMediumAtt,
582	bool fForce);
583
584	HRESULT attachRawPCIDevices(PUVM pUVM, BusAssignmentManager *BusMgr, PCFGMNODE pDevices);
585	void attachStatusDriver(PCFGMNODE pCtlInst, PPDMLED *papLeds,
586	uint64_t uFirst, uint64_t uLast,
587	Console::MediumAttachmentMap *pmapMediumAttachments,
588	const char *pcszDevice, unsigned uInstance);
589
590	int configNetwork(const char *pszDevice, unsigned uInstance, unsigned uLun,
591	INetworkAdapter *aNetworkAdapter, PCFGMNODE pCfg,
592	PCFGMNODE pLunL0, PCFGMNODE pInst,
593	bool fAttachDetach, bool fIgnoreConnectFailure);
594
595	static DECLCALLBACK(int) configGuestProperties(void *pvConsole, PUVM pUVM);
596	static DECLCALLBACK(int) configGuestControl(void *pvConsole);
597	static DECLCALLBACK(void) vmstateChangeCallback(PUVM pUVM, VMSTATE enmState, VMSTATE enmOldState, void *pvUser);
598	static DECLCALLBACK(int) unplugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);
599	static DECLCALLBACK(int) plugCpu(Console *pThis, PUVM pUVM, VMCPUID idCpu);
600	HRESULT doMediumChange(IMediumAttachment *aMediumAttachment, bool fForce, PUVM pUVM);
601	HRESULT doCPURemove(ULONG aCpu, PUVM pUVM);
602	HRESULT doCPUAdd(ULONG aCpu, PUVM pUVM);
603
604	HRESULT doNetworkAdapterChange(PUVM pUVM, const char *pszDevice, unsigned uInstance,
605	unsigned uLun, INetworkAdapter *aNetworkAdapter);
606	static DECLCALLBACK(int) changeNetworkAttachment(Console pThis, PUVM pUVM, const char pszDevice,
607	unsigned uInstance, unsigned uLun,
608	INetworkAdapter *aNetworkAdapter);
609
610	void changeClipboardMode(ClipboardMode_T aClipboardMode);
611	void changeDragAndDropMode(DragAndDropMode_T aDragAndDropMode);
612
613	#ifdef VBOX_WITH_USB
614	HRESULT attachUSBDevice(IUSBDevice *aHostDevice, ULONG aMaskedIfs);
615	HRESULT detachUSBDevice(const ComObjPtr<OUSBDevice> &aHostDevice);
616
617	static DECLCALLBACK(int) usbAttachCallback(Console that, PUVM pUVM, IUSBDevice aHostDevice, PCRTUUID aUuid,
618	bool aRemote, const char aAddress, void pvRemoteBackend, USHORT aPortVersion, ULONG aMaskedIfs);
619	static DECLCALLBACK(int) usbDetachCallback(Console *that, PUVM pUVM, PCRTUUID aUuid);
620	#endif
621
622	static DECLCALLBACK(int) attachStorageDevice(Console *pThis,
623	PUVM pUVM,
624	const char *pcszDevice,
625	unsigned uInstance,
626	StorageBus_T enmBus,
627	bool fUseHostIOCache,
628	IMediumAttachment *aMediumAtt,
629	bool fSilent);
630	static DECLCALLBACK(int) detachStorageDevice(Console *pThis,
631	PUVM pUVM,
632	const char *pcszDevice,
633	unsigned uInstance,
634	StorageBus_T enmBus,
635	IMediumAttachment *aMediumAtt,
636	bool fSilent);
637	HRESULT doStorageDeviceAttach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent);
638	HRESULT doStorageDeviceDetach(IMediumAttachment *aMediumAttachment, PUVM pUVM, bool fSilent);
639
640	static DECLCALLBACK(int) fntTakeSnapshotWorker(RTTHREAD Thread, void *pvUser);
641
642	static DECLCALLBACK(int) stateProgressCallback(PUVM pUVM, unsigned uPercent, void *pvUser);
643
644	static DECLCALLBACK(void) genericVMSetErrorCallback(PUVM pUVM, void *pvUser, int rc, RT_SRC_POS_DECL,
645	const char *pszErrorFmt, va_list va);
646
647	void setVMRuntimeErrorCallbackF(uint32_t fFatal, const char pszErrorId, const char pszFormat, ...);
648	static DECLCALLBACK(void) setVMRuntimeErrorCallback(PUVM pUVM, void *pvUser, uint32_t fFatal,
649	const char pszErrorId, const char pszFormat, va_list va);
650
651	HRESULT captureUSBDevices(PUVM pUVM);
652	void detachAllUSBDevices(bool aDone);
653
654	static DECLCALLBACK(int) powerUpThread(RTTHREAD Thread, void *pvUser);
655	static DECLCALLBACK(int) saveStateThread(RTTHREAD Thread, void *pvUser);
656	static DECLCALLBACK(int) powerDownThread(RTTHREAD Thread, void *pvUser);
657
658	static DECLCALLBACK(int) vmm2User_SaveState(PCVMM2USERMETHODS pThis, PUVM pUVM);
659	static DECLCALLBACK(void) vmm2User_NotifyEmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);
660	static DECLCALLBACK(void) vmm2User_NotifyEmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu);
661	static DECLCALLBACK(void) vmm2User_NotifyPdmtInit(PCVMM2USERMETHODS pThis, PUVM pUVM);
662	static DECLCALLBACK(void) vmm2User_NotifyPdmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM);
663
664	static DECLCALLBACK(void ) drvStatus_QueryInterface(PPDMIBASE pInterface, const char pszIID);
665	static DECLCALLBACK(void) drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN);
666	static DECLCALLBACK(int) drvStatus_MediumEjected(PPDMIMEDIANOTIFY pInterface, unsigned iLUN);
667	static DECLCALLBACK(void) drvStatus_Destruct(PPDMDRVINS pDrvIns);
668	static DECLCALLBACK(int) drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags);
669
670	int mcAudioRefs;
671	volatile uint32_t mcVRDPClients;
672	uint32_t mu32SingleRDPClientId; /* The id of a connected client in the single connection mode. */
673	volatile bool mcGuestCredentialsProvided;
674
675	static const char *sSSMConsoleUnit;
676	static uint32_t sSSMConsoleVer;
677
678	HRESULT loadDataFromSavedState();
679	int loadStateFileExecInternal(PSSMHANDLE pSSM, uint32_t u32Version);
680
681	static DECLCALLBACK(void) saveStateFileExec(PSSMHANDLE pSSM, void *pvUser);
682	static DECLCALLBACK(int) loadStateFileExec(PSSMHANDLE pSSM, void *pvUser, uint32_t uVersion, uint32_t uPass);
683
684	#ifdef VBOX_WITH_GUEST_PROPS
685	static DECLCALLBACK(int) doGuestPropNotification(void pvExtension, uint32_t, void pvParms, uint32_t cbParms);
686	HRESULT doEnumerateGuestProperties(CBSTR aPatterns,
687	ComSafeArrayOut(BSTR, aNames),
688	ComSafeArrayOut(BSTR, aValues),
689	ComSafeArrayOut(LONG64, aTimestamps),
690	ComSafeArrayOut(BSTR, aFlags));
691
692	void guestPropertiesHandleVMReset(void);
693	bool guestPropertiesVRDPEnabled(void);
694	void guestPropertiesVRDPUpdateLogon(uint32_t u32ClientId, const char pszUser, const char pszDomain);
695	void guestPropertiesVRDPUpdateActiveClient(uint32_t u32ClientId);
696	void guestPropertiesVRDPUpdateClientAttach(uint32_t u32ClientId, bool fAttached);
697	void guestPropertiesVRDPUpdateNameChange(uint32_t u32ClientId, const char *pszName);
698	void guestPropertiesVRDPUpdateIPAddrChange(uint32_t u32ClientId, const char *pszIPAddr);
699	void guestPropertiesVRDPUpdateLocationChange(uint32_t u32ClientId, const char *pszLocation);
700	void guestPropertiesVRDPUpdateOtherInfoChange(uint32_t u32ClientId, const char *pszOtherInfo);
701	void guestPropertiesVRDPUpdateDisconnect(uint32_t u32ClientId);
702	#endif
703
704	/** @name Teleporter support
705	* @{ */
706	static DECLCALLBACK(int) teleporterSrcThreadWrapper(RTTHREAD hThread, void *pvUser);
707	HRESULT teleporterSrc(TeleporterStateSrc *pState);
708	HRESULT teleporterSrcReadACK(TeleporterStateSrc pState, const char pszWhich, const char *pszNAckMsg = NULL);
709	HRESULT teleporterSrcSubmitCommand(TeleporterStateSrc pState, const char pszCommand, bool fWaitForAck = true);
710	HRESULT teleporterTrg(PUVM pUVM, IMachine pMachine, Utf8Str pErrorMsg, bool fStartPaused,
711	Progress pProgress, bool pfPowerOffOnFailure);
712	static DECLCALLBACK(int) teleporterTrgServeConnection(RTSOCKET Sock, void *pvUser);
713	/** @} */
714
715	bool mSavedStateDataLoaded : 1;
716
717	const ComPtr<IMachine> mMachine;
718	const ComPtr<IInternalMachineControl> mControl;
719
720	const ComPtr<IVRDEServer> mVRDEServer;
721
722	ConsoleVRDPServer * const mConsoleVRDPServer;
723
724	const ComObjPtr<Guest> mGuest;
725	const ComObjPtr<Keyboard> mKeyboard;
726	const ComObjPtr<Mouse> mMouse;
727	const ComObjPtr<Display> mDisplay;
728	const ComObjPtr<MachineDebugger> mDebugger;
729	const ComObjPtr<VRDEServerInfo> mVRDEServerInfo;
730	/** This can safely be used without holding any locks.
731	* An AutoCaller suffices to prevent it being destroy while in use and
732	* internally there is a lock providing the necessary serialization. */
733	const ComObjPtr<EventSource> mEventSource;
734	#ifdef VBOX_WITH_EXTPACK
735	const ComObjPtr<ExtPackManager> mptrExtPackManager;
736	#endif
737
738	USBDeviceList mUSBDevices;
739	RemoteUSBDeviceList mRemoteUSBDevices;
740
741	SharedFolderDataMap m_mapGlobalSharedFolders;
742	SharedFolderDataMap m_mapMachineSharedFolders;
743	SharedFolderMap m_mapSharedFolders; // the console instances
744
745	/** The user mode VM handle. */
746	PUVM mpUVM;
747	/** Holds the number of "readonly" mpUVM callers (users). */
748	uint32_t mVMCallers;
749	/** Semaphore posted when the number of mpUVM callers drops to zero. */
750	RTSEMEVENT mVMZeroCallersSem;
751	/** true when Console has entered the mpUVM destruction phase. */
752	bool mVMDestroying : 1;
753	/** true when power down is initiated by vmstateChangeCallback (EMT). */
754	bool mVMPoweredOff : 1;
755	/** true when vmstateChangeCallback shouldn't initiate a power down. */
756	bool mVMIsAlreadyPoweringOff : 1;
757	/** true if we already showed the snapshot folder size warning. */
758	bool mfSnapshotFolderSizeWarningShown : 1;
759	/** true if we already showed the snapshot folder ext4/xfs bug warning. */
760	bool mfSnapshotFolderExt4WarningShown : 1;
761	/** true if we already listed the disk type of the snapshot folder. */
762	bool mfSnapshotFolderDiskTypeShown : 1;
763
764	/** Pointer to the VMM -> User (that's us) callbacks. */
765	struct MYVMM2USERMETHODS : public VMM2USERMETHODS
766	{
767	Console *pConsole;
768	} *mpVmm2UserMethods;
769
770	/** The current network attachment type in the VM.
771	* This doesn't have to match the network attachment type maintained in the
772	* NetworkAdapter. This is needed to change the network attachment
773	* dynamically.
774	*/
775	typedef std::vector<NetworkAttachmentType_T> NetworkAttachmentTypeVector;
776	NetworkAttachmentTypeVector meAttachmentType;
777
778	VMMDev * m_pVMMDev;
779	AudioSniffer * const mAudioSniffer;
780	Nvram * const mNvram;
781	#ifdef VBOX_WITH_USB_VIDEO
782	EmWebcam * const mEmWebcam;
783	#endif
784	#ifdef VBOX_WITH_USB_CARDREADER
785	UsbCardReader * const mUsbCardReader;
786	#endif
787	BusAssignmentManager* mBusMgr;
788
789	enum
790	{
791	iLedFloppy = 0,
792	cLedFloppy = 2,
793	iLedIde = iLedFloppy + cLedFloppy,
794	cLedIde = 4,
795	iLedSata = iLedIde + cLedIde,
796	cLedSata = 30,
797	iLedScsi = iLedSata + cLedSata,
798	cLedScsi = 16,
799	iLedSas = iLedScsi + cLedScsi,
800	cLedSas = 8,
801	cLedStorage = cLedFloppy + cLedIde + cLedSata + cLedScsi + cLedSas
802	};
803	DeviceType_T maStorageDevType[cLedStorage];
804	PPDMLED mapStorageLeds[cLedStorage];
805	PPDMLED mapNetworkLeds[36]; /*< @todo adapt this to the maximum network card count /
806	PPDMLED mapSharedFolderLed;
807	PPDMLED mapUSBLed[2];
808
809	MediumAttachmentMap mapMediumAttachments;
810
811	/* Note: FreeBSD needs this whether netflt is used or not. */
812	#if ((defined(RT_OS_LINUX) && !defined(VBOX_WITH_NETFLT)) \|\| defined(RT_OS_FREEBSD))
813	Utf8Str maTAPDeviceName[8];
814	RTFILE maTapFD[8];
815	#endif
816
817	bool mVMStateChangeCallbackDisabled;
818
819	bool mfUseHostClipboard;
820
821	/** Local machine state value. */
822	MachineState_T mMachineState;
823
824	/** Pointer to the progress object of a live cancelable task.
825	*
826	* This is currently only used by Console::Teleport(), but is intended to later
827	* be used by the live snapshot code path as well. Actions like
828	* Console::PowerDown, which automatically cancels out the running snapshot /
829	* teleportation operation, will cancel the teleportation / live snapshot
830	* operation before starting. */
831	ComObjPtr<Progress> mptrCancelableProgress;
832
833	/* The purpose of caching of some events is probably in order to
834	automatically fire them at new event listeners. However, there is no
835	(longer?) any code making use of this... */
836	#ifdef CONSOLE_WITH_EVENT_CACHE
837	struct
838	{
839	/** OnMousePointerShapeChange() cache */
840	struct
841	{
842	bool valid;
843	bool visible;
844	bool alpha;
845	uint32_t xHot;
846	uint32_t yHot;
847	uint32_t width;
848	uint32_t height;
849	com::SafeArray<BYTE> shape;
850	} mpsc;
851
852	/** OnMouseCapabilityChange() cache */
853	struct
854	{
855	bool valid;
856	BOOL supportsAbsolute;
857	BOOL supportsRelative;
858	BOOL needsHostCursor;
859	} mcc;
860
861	/** OnKeyboardLedsChange() cache */
862	struct
863	{
864	bool valid;
865	bool numLock;
866	bool capsLock;
867	bool scrollLock;
868	} klc;
869
870	void clear()
871	{
872	RT_ZERO(mcc);
873	RT_ZERO(klc);
874
875	/* We cannot RT_ZERO mpsc because of shape's vtable. */
876	mpsc.shape.setNull();
877	mpsc.valid = mpsc.visible = mpsc.alpha = false;
878	mpsc.xHot = mpsc.yHot = mpsc.width = mpsc.height = 0;
879	}
880	} mCallbackData;
881	#endif
882	ComPtr<IEventListener> mVmListener;
883
884	friend struct VMTask;
885	};
886
887	#endif // !____H_CONSOLEIMPL
888	/* 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@ 46284

Download in other formats: