ConsoleImpl.h@ 3110

Last change on this file since 3110 was 3034, checked in by vboxsync, 18 years ago
Main: Fixed async USB (added proper detection of device re-cycle on Win32; changed manual release sequence so that a detach is made in VMM first, the USB proxy is notified afterwards on success; some other small fixes).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 19.3 KB

Line
1	/** @file
2	*
3	* VBox Console COM Class definition
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 innotek GmbH
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 as published by the Free Software Foundation,
13	* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14	* distribution. VirtualBox OSE is distributed in the hope that it will
15	* be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* If you received this file as part of a commercial VirtualBox
18	* distribution, then only the terms of your commercial VirtualBox
19	* license agreement apply instead of the previous paragraph.
20	*/
21
22	#ifndef ____H_CONSOLEIMPL
23	#define ____H_CONSOLEIMPL
24
25	#include "VirtualBoxBase.h"
26	#include "ProgressImpl.h"
27
28	class Guest;
29	class Keyboard;
30	class Mouse;
31	class Display;
32	class MachineDebugger;
33	class OUSBDevice;
34	class RemoteUSBDevice;
35	class SharedFolder;
36	class RemoteDisplayInfo;
37	class AudioSniffer;
38	class ConsoleVRDPServer;
39	class VMMDev;
40
41	#include <VBox/vrdpapi.h>
42	#include <VBox/pdm.h>
43
44	struct VUSBIRHCONFIG;
45	typedef struct VUSBIRHCONFIG *PVUSBIRHCONFIG;
46
47	#include <list>
48
49	// defines
50	///////////////////////////////////////////////////////////////////////////////
51
52	/**
53	* Checks the availability of the underlying VM device driver corresponding
54	* to the COM interface (IKeyboard, IMouse, IDisplay, etc.). When the driver is
55	* not available (NULL), sets error info and returns returns E_ACCESSDENIED.
56	* The translatable error message is defined in null context.
57	*
58	* Intended to used only within Console children (i,e. Keyboard, Mouse,
59	* Display, etc.).
60	*
61	* @param drv driver pointer to check (compare it with NULL)
62	*/
63	#define CHECK_CONSOLE_DRV(drv) \
64	do { \
65	if (!(drv)) \
66	return setError (E_ACCESSDENIED, tr ("The console is not powered up")); \
67	} while (0)
68
69	/** @def VBOX_WITH_UNIXY_TAP_NETWORKING
70	* Unixy style TAP networking. This is defined in the Makefile since it's also
71	* used by NetworkAdapterImpl.h/cpp.
72	*/
73	#ifdef __DOXYGEN__
74	# define VBOX_WITH_UNIXY_TAP_NETWORKING
75	#endif
76
77	// Console
78	///////////////////////////////////////////////////////////////////////////////
79
80	/** IConsole implementation class */
81	class ATL_NO_VTABLE Console :
82	public VirtualBoxBaseWithChildrenNEXT,
83	public VirtualBoxSupportErrorInfoImpl <Console, IConsole>,
84	public VirtualBoxSupportTranslation <Console>,
85	public IConsole
86	{
87	Q_OBJECT
88
89	public:
90
91	DECLARE_NOT_AGGREGATABLE(Console)
92
93	DECLARE_PROTECT_FINAL_CONSTRUCT()
94
95	BEGIN_COM_MAP(Console)
96	COM_INTERFACE_ENTRY(ISupportErrorInfo)
97	COM_INTERFACE_ENTRY(IConsole)
98	END_COM_MAP()
99
100	NS_DECL_ISUPPORTS
101
102	Console();
103	~Console();
104
105	HRESULT FinalConstruct();
106	void FinalRelease();
107
108	// public initializers/uninitializers for internal purposes only
109	HRESULT init (IMachine aMachine, IInternalMachineControl aControl);
110	void uninit();
111
112	// IConsole properties
113	STDMETHOD(COMGETTER(Machine)) (IMachine **aMachine);
114	STDMETHOD(COMGETTER(State)) (MachineState_T *aMachineState);
115	STDMETHOD(COMGETTER(Guest)) (IGuest **aGuest);
116	STDMETHOD(COMGETTER(Keyboard)) (IKeyboard **aKeyboard);
117	STDMETHOD(COMGETTER(Mouse)) (IMouse **aMouse);
118	STDMETHOD(COMGETTER(Display)) (IDisplay **aDisplay);
119	STDMETHOD(COMGETTER(Debugger)) (IMachineDebugger **aDebugger);
120	STDMETHOD(COMGETTER(USBDevices)) (IUSBDeviceCollection **aUSBDevices);
121	STDMETHOD(COMGETTER(RemoteUSBDevices)) (IHostUSBDeviceCollection **aRemoteUSBDevices);
122	STDMETHOD(COMGETTER(RemoteDisplayInfo)) (IRemoteDisplayInfo **aRemoteDisplayInfo);
123	STDMETHOD(COMGETTER(SharedFolders)) (ISharedFolderCollection **aSharedFolders);
124
125	// IConsole methods
126	STDMETHOD(PowerUp) (IProgress **aProgress);
127	STDMETHOD(PowerDown)();
128	STDMETHOD(Reset)();
129	STDMETHOD(Pause)();
130	STDMETHOD(Resume)();
131	STDMETHOD(PowerButton)();
132	STDMETHOD(SaveState) (IProgress **aProgress);
133	STDMETHOD(DiscardSavedState)();
134	STDMETHOD(GetDeviceActivity) (DeviceType_T aDeviceType,
135	DeviceActivity_T *aDeviceActivity);
136	STDMETHOD(AttachUSBDevice) (INPTR GUIDPARAM aId);
137	STDMETHOD(DetachUSBDevice) (INPTR GUIDPARAM aId, IUSBDevice **aDevice);
138	STDMETHOD(CreateSharedFolder) (INPTR BSTR aName, INPTR BSTR aHostPath);
139	STDMETHOD(RemoveSharedFolder) (INPTR BSTR aName);
140	STDMETHOD(TakeSnapshot) (INPTR BSTR aName, INPTR BSTR aDescription,
141	IProgress **aProgress);
142	STDMETHOD(DiscardSnapshot) (INPTR GUIDPARAM aId, IProgress **aProgress);
143	STDMETHOD(DiscardCurrentState) (IProgress **aProgress);
144	STDMETHOD(DiscardCurrentSnapshotAndState) (IProgress **aProgress);
145	STDMETHOD(RegisterCallback) (IConsoleCallback *aCallback);
146	STDMETHOD(UnregisterCallback)(IConsoleCallback *aCallback);
147
148	// public methods for internal purposes only
149
150	/*
151	* Note: the following methods do not increase refcount. intended to be
152	* called only by the VM execution thread.
153	*/
154
155	Guest *getGuest() { return mGuest; }
156	Keyboard *getKeyboard() { return mKeyboard; }
157	Mouse *getMouse() { return mMouse; }
158	Display *getDisplay() { return mDisplay; }
159	MachineDebugger *getMachineDebugger() { return mDebugger; }
160
161	const ComPtr <IMachine> &machine() { return mMachine; }
162
163	/** Method is called only from ConsoleVRDPServer */
164	IVRDPServer *getVRDPServer() { return mVRDPServer; }
165
166	ConsoleVRDPServer *consoleVRDPServer() { return mConsoleVRDPServer; }
167
168	HRESULT updateMachineState (MachineState_T aMachineState);
169
170	// events from IInternalSessionControl
171	HRESULT onDVDDriveChange();
172	HRESULT onFloppyDriveChange();
173	HRESULT onNetworkAdapterChange(INetworkAdapter *networkAdapter);
174	HRESULT onVRDPServerChange();
175	HRESULT onUSBControllerChange();
176	HRESULT onUSBDeviceAttach (IUSBDevice aDevice, IVirtualBoxErrorInfo aError);
177	HRESULT onUSBDeviceDetach (INPTR GUIDPARAM aId, IVirtualBoxErrorInfo *aError);
178
179	VMMDev *getVMMDev() { return mVMMDev; }
180	AudioSniffer *getAudioSniffer () { return mAudioSniffer; }
181
182	static VRDPSERVERCALLBACK *getVrdpServerCallback () { return &sVrdpServerCallback; };
183
184	#ifdef VRDP_MC
185	void processRemoteUSBDevices (uint32_t u32ClientId, VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList);
186	#else
187	void processRemoteUSBDevices (VRDPUSBDEVICEDESC *pDevList, uint32_t cbDevList);
188	#endif /* VRDP_MC */
189
190	// callback callers
191	void onMousePointerShapeChange(bool fVisible, bool fAlpha,
192	uint32_t xHot, uint32_t yHot,
193	uint32_t width, uint32_t height,
194	void *pShape);
195	void onMouseCapabilityChange (BOOL supportsAbsolute, BOOL needsHostCursor);
196	void onStateChange (MachineState_T aMachineState);
197	void onAdditionsStateChange();
198	void onAdditionsOutdated();
199	void onKeyboardLedsChange (bool fNumLock, bool fCapsLock, bool fScrollLock);
200	void onUSBDeviceStateChange (IUSBDevice *aDevice, bool aAttached,
201	IVirtualBoxErrorInfo *aError);
202	void onRuntimeError (BOOL aFatal, INPTR BSTR aErrorID, INPTR BSTR aMessage);
203	HRESULT onShowWindow (BOOL aCheck, BOOL aCanShow, ULONG64 aWinId);
204
205	static const PDMDRVREG DrvStatusReg;
206
207	void reportAuthLibraryError (const char *filename, int rc)
208	{
209	setError (E_FAIL, tr("Could not load the external authentication library '%s' (%Vrc)"), filename, rc);
210	}
211
212	// for VirtualBoxSupportErrorInfoImpl
213	static const wchar_t *getComponentName() { return L"Console"; }
214
215	private:
216
217	/**
218	* Base template for AutoVMCaller and SaveVMPtr. Template arguments
219	* have the same meaning as arguments of Console::addVMCaller().
220	*/
221	template <bool taQuiet = false, bool taAllowNullVM = false>
222	class AutoVMCallerBase
223	{
224	public:
225	AutoVMCallerBase (Console *aThat) : mThat (aThat), mRC (S_OK)
226	{
227	Assert (aThat);
228	mRC = aThat->addVMCaller (taQuiet, taAllowNullVM);
229	}
230	~AutoVMCallerBase()
231	{
232	if (SUCCEEDED (mRC))
233	mThat->releaseVMCaller();
234	}
235	/** Decreases the number of callers before the instance is destroyed. */
236	void release()
237	{
238	AssertReturnVoid (SUCCEEDED (mRC));
239	mThat->releaseVMCaller();
240	mRC = E_FAIL;
241	}
242	/** Restores the number of callers after by #release(). #rc() must be
243	* rechecked to ensure the operation succeeded. */
244	void add()
245	{
246	AssertReturnVoid (!SUCCEEDED (mRC));
247	mRC = mThat->addVMCaller (taQuiet, taAllowNullVM);
248	}
249	/** Returns the result of Console::addVMCaller() */
250	HRESULT rc() const { return mRC; }
251	/** Shortcut to SUCCEEDED (rc()) */
252	bool isOk() const { return SUCCEEDED (mRC); }
253	protected:
254	Console *mThat;
255	HRESULT mRC;
256	private:
257	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (AutoVMCallerBase)
258	DECLARE_CLS_NEW_DELETE_NOOP (AutoVMCallerBase)
259	};
260
261	/**
262	* Helper class that protects sections of code using the mpVM pointer by
263	* automatically calling addVMCaller() on construction and
264	* releaseVMCaller() on destruction. Intended for Console methods dealing
265	* with mpVM. The usage pattern is:
266	* <code>
267	* AutoVMCaller autoVMCaller (this);
268	* CheckComRCReturnRC (autoVMCaller.rc());
269	* ...
270	* VMR3ReqCall (mpVM, ...
271	* </code>
272	*
273	* @sa SafeVMPtr, SafeVMPtrQuiet
274	*/
275	typedef AutoVMCallerBase <false, false> AutoVMCaller;
276
277	/**
278	* Base template for SaveVMPtr and SaveVMPtrQuiet.
279	*/
280	template <bool taQuiet = false>
281	class SafeVMPtrBase : public AutoVMCallerBase <taQuiet, true>
282	{
283	typedef AutoVMCallerBase <taQuiet, true> Base;
284	public:
285	SafeVMPtrBase (Console *aThat) : Base (aThat), mpVM (NULL)
286	{
287	if (SUCCEEDED (Base::mRC))
288	mpVM = aThat->mpVM;
289	}
290	/** Smart SaveVMPtr to PVM cast operator */
291	operator PVM() const { return mpVM; }
292	/** Direct PVM access for printf()-like functions */
293	PVM raw() const { return mpVM; }
294	private:
295	PVM mpVM;
296	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (SafeVMPtrBase)
297	DECLARE_CLS_NEW_DELETE_NOOP (SafeVMPtrBase)
298	};
299
300	public:
301
302	/**
303	* Helper class that safely manages the Console::mpVM pointer
304	* by calling addVMCaller() on construction and releaseVMCaller() on
305	* destruction. Intended for Console children. The usage pattern is:
306	* <code>
307	* Console::SaveVMPtr pVM (mParent);
308	* CheckComRCReturnRC (pVM.rc());
309	* ...
310	* VMR3ReqCall (pVM, ...
311	* ...
312	* printf ("%p\n", pVM.raw());
313	* </code>
314	*
315	* @sa SafeVMPtrQuiet, AutoVMCaller
316	*/
317	typedef SafeVMPtrBase <false> SafeVMPtr;
318
319	/**
320	* A deviation of SaveVMPtr that doesn't set the error info on failure.
321	* Intenede for pieces of code that don't need to return the VM access
322	* failure to the caller. The usage pattern is:
323	* <code>
324	* Console::SaveVMPtrQuiet pVM (mParent);
325	* if (pVM.rc())
326	* VMR3ReqCall (pVM, ...
327	* return S_OK;
328	* </code>
329	*
330	* @sa SafeVMPtr, AutoVMCaller
331	*/
332	typedef SafeVMPtrBase <true> SafeVMPtrQuiet;
333
334	private:
335
336	typedef std::list <ComObjPtr <OUSBDevice> > USBDeviceList;
337	typedef std::list <ComObjPtr <RemoteUSBDevice> > RemoteUSBDeviceList;
338	typedef std::list <ComObjPtr <SharedFolder> > SharedFolderList;
339
340	HRESULT addVMCaller (bool aQuiet = false, bool aAllowNullVM = false);
341	void releaseVMCaller();
342
343	HRESULT powerDown();
344
345	HRESULT callTapSetupApplication(bool isStatic, RTFILE tapFD, Bstr &tapDevice,
346	Bstr &tapSetupApplication);
347	HRESULT attachToHostInterface(INetworkAdapter *networkAdapter);
348	HRESULT detachFromHostInterface(INetworkAdapter *networkAdapter);
349	HRESULT powerDownHostInterfaces();
350
351	HRESULT setMachineState (MachineState_T aMachineState, bool aUpdateServer = true);
352	HRESULT setMachineStateLocally (MachineState_T aMachineState)
353	{
354	return setMachineState (aMachineState, false /* aUpdateServer */);
355	}
356
357	HRESULT findSharedFolder (const BSTR aName,
358	ComObjPtr <SharedFolder> &aSharedFolder,
359	bool aSetError = false);
360
361	static DECLCALLBACK(int) configConstructor(PVM pVM, void *pvConsole);
362	static DECLCALLBACK(void) vmstateChangeCallback(PVM aVM, VMSTATE aState,
363	VMSTATE aOldState, void *aUser);
364	HRESULT doDriveChange (const char *pszDevice, unsigned uInstance,
365	unsigned uLun, DriveState_T eState,
366	DriveState_T peState, const char pszPath,
367	bool fPassthrough);
368	static DECLCALLBACK(int) changeDrive (Console pThis, const char pszDevice,
369	unsigned uInstance, unsigned uLun,
370	DriveState_T eState, DriveState_T *peState,
371	const char *pszPath, bool fPassthrough);
372
373	HRESULT attachUSBDevice (IUSBDevice *aHostDevice, PVUSBIRHCONFIG aConfig);
374	HRESULT detachUSBDevice (USBDeviceList::iterator &aIt);
375
376	static DECLCALLBACK(int)
377	usbAttachCallback (Console that, IUSBDevice aHostDevice,
378	PVUSBIRHCONFIG aConfig, PCRTUUID aUuid, bool aRemote,
379	const char aAddress, void aRemoteBackend);
380	static DECLCALLBACK(int)
381	usbDetachCallback (Console that, USBDeviceList::iterator aIt,
382	PVUSBIRHCONFIG aConfig, PCRTUUID aUuid);
383
384	static DECLCALLBACK (int)
385	stateProgressCallback (PVM pVM, unsigned uPercent, void *pvUser);
386
387	static DECLCALLBACK(void)
388	setVMErrorCallback (PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL,
389	const char *pszFormat, va_list args);
390
391	static DECLCALLBACK(void)
392	setVMRuntimeErrorCallback (PVM pVM, void *pvUser, bool fFatal,
393	const char *pszErrorID,
394	const char *pszFormat, va_list args);
395
396	HRESULT captureUSBDevices (PVM pVM);
397	void releaseAllUSBDevices (void);
398
399	static DECLCALLBACK (int) powerUpThread (RTTHREAD Thread, void *pvUser);
400	static DECLCALLBACK (int) saveStateThread (RTTHREAD Thread, void *pvUser);
401	static DECLCALLBACK (int) powerDownThread (RTTHREAD Thread, void *pvUser);
402
403	static DECLCALLBACK(void *) drvStatus_QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface);
404	static DECLCALLBACK(void) drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN);
405	static DECLCALLBACK(void) drvStatus_Destruct(PPDMDRVINS pDrvIns);
406	static DECLCALLBACK(int) drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle);
407
408	#ifdef VRDP_MC
409	int mcAudioRefs;
410	volatile uint32_t mcVRDPClients;
411
412	static DECLCALLBACK(int) vrdp_ClientLogon (void pvUser, uint32_t u32ClientId, const char pszUser, const char pszPassword, const char pszDomain);
413	static DECLCALLBACK(void) vrdp_ClientConnect (void *pvUser, uint32_t u32ClientId);
414	static DECLCALLBACK(void) vrdp_ClientDisconnect (void *pvUser, uint32_t u32ClientId, uint32_t fu32Intercepted);
415	static DECLCALLBACK(void) vrdp_InterceptAudio (void *pvUser, uint32_t u32ClientId);
416	static DECLCALLBACK(void) vrdp_InterceptUSB (void pvUser, uint32_t u32ClientId, PFNVRDPUSBCALLBACK ppfn, void **ppv);
417	static DECLCALLBACK(void) vrdp_InterceptClipboard (void pvUser, uint32_t u32ClientId, PFNVRDPCLIPBOARDCALLBACK ppfn, void **ppv);
418	#else
419	static DECLCALLBACK(int) vrdp_ClientLogon (void pvUser, const char pszUser, const char pszPassword, const char pszDomain);
420	static DECLCALLBACK(void) vrdp_ClientConnect (void *pvUser, uint32_t fu32SupportedOrders);
421	static DECLCALLBACK(void) vrdp_ClientDisconnect (void *pvUser);
422	static DECLCALLBACK(void) vrdp_InterceptAudio (void *pvUser, bool keepHostAudio);
423	static DECLCALLBACK(void) vrdp_InterceptUSB (void pvUser, PFNVRDPUSBCALLBACK ppfn, void **ppv);
424	static DECLCALLBACK(void) vrdp_InterceptClipboard (void pvUser, PFNVRDPCLIPBOARDCALLBACK ppfn, void **ppv);
425	#endif /* VRDP_MC */
426
427	static VRDPSERVERCALLBACK sVrdpServerCallback;
428
429	static const char *sSSMConsoleUnit;
430	static uint32_t sSSMConsoleVer;
431
432	HRESULT loadDataFromSavedState();
433
434	static DECLCALLBACK(void) saveStateFileExec (PSSMHANDLE pSSM, void *pvUser);
435	static DECLCALLBACK(int) loadStateFileExec (PSSMHANDLE pSSM, void *pvUser, uint32_t u32Version);
436
437	bool mSavedStateDataLoaded : 1;
438
439	const ComPtr <IMachine> mMachine;
440	const ComPtr <IInternalMachineControl> mControl;
441
442	const ComPtr <IVRDPServer> mVRDPServer;
443	const ComPtr <IDVDDrive> mDVDDrive;
444	const ComPtr <IFloppyDrive> mFloppyDrive;
445
446	ConsoleVRDPServer * const mConsoleVRDPServer;
447
448	const ComObjPtr <Guest> mGuest;
449	const ComObjPtr <Keyboard> mKeyboard;
450	const ComObjPtr <Mouse> mMouse;
451	const ComObjPtr <Display> mDisplay;
452	const ComObjPtr <MachineDebugger> mDebugger;
453	const ComObjPtr <RemoteDisplayInfo> mRemoteDisplayInfo;
454
455	USBDeviceList mUSBDevices;
456	RemoteUSBDeviceList mRemoteUSBDevices;
457	SharedFolderList mSharedFolders;
458
459	/** The VM instance handle. */
460	PVM mpVM;
461	/** Holds the number of "readonly" mpVM callers (users) */
462	uint32_t mVMCallers;
463	/** Semaphore posted when the number of mpVM callers drops to zero */
464	RTSEMEVENT mVMZeroCallersSem;
465	/** true when Console has entered the mpVM destruction phase */
466	bool mVMDestroying : 1;
467
468	/** The current DVD drive state in the VM.
469	* This does not have to match the state maintained in the DVD. */
470	DriveState_T meDVDState;
471	/** The current Floppy drive state in the VM.
472	* This does not have to match the state maintained in the Floppy. */
473	DriveState_T meFloppyState;
474
475	VMMDev * const mVMMDev;
476	AudioSniffer * const mAudioSniffer;
477
478	PPDMLED mapFDLeds[2];
479	PPDMLED mapIDELeds[4];
480	PPDMLED mapNetworkLeds[8];
481	#ifdef VBOX_WITH_UNIXY_TAP_NETWORKING
482	Utf8Str maTAPDeviceName[8];
483	RTFILE maTapFD[8];
484	#endif
485
486	bool mVMStateChangeCallbackDisabled;
487
488	/* Local machine state value */
489	MachineState_T mMachineState;
490
491	typedef std::list <ComPtr <IConsoleCallback> > CallbackList;
492	CallbackList mCallbacks;
493
494	struct
495	{
496	/** OnMousePointerShapeChange() cache */
497	struct
498	{
499	bool valid;
500	bool visible;
501	bool alpha;
502	uint32_t xHot;
503	uint32_t yHot;
504	uint32_t width;
505	uint32_t height;
506	BYTE *shape;
507	size_t shapeSize;
508	}
509	mpsc;
510
511	/** OnMouseCapabilityChange() cache */
512	struct
513	{
514	bool valid;
515	BOOL supportsAbsolute;
516	BOOL needsHostCursor;
517	}
518	mcc;
519
520	/** OnKeyboardLedsChange() cache */
521	struct
522	{
523	bool valid;
524	bool numLock;
525	bool capsLock;
526	bool scrollLock;
527	}
528	klc;
529	}
530	mCallbackData;
531
532	friend struct VMTask;
533	};
534
535	#endif // ____H_CONSOLEIMPL

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

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

Download in other formats: