ConsoleImpl.h@ 2106

Last change on this file since 2106 was 902, checked in by vboxsync, 18 years ago
Main: Restored r18598 + fixes (don't call OnStateChange on new callback registration, free old shape memory before allocating it again!).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 18.6 KB

Line
1	/** @file
2	*
3	* VBox Console COM Class definition
4	*/
5
6	/*
7	* Copyright (C) 2006 InnoTek Systemberatung 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);
177	HRESULT onUSBDeviceDetach(INPTR GUIDPARAM aId);
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 onRuntimeError (BOOL aFatal, INPTR BSTR aErrorID, INPTR BSTR aMessage);
201
202	static const PDMDRVREG DrvStatusReg;
203
204	void reportAuthLibraryError (const char *filename, int rc)
205	{
206	setError (E_FAIL, tr("Could not load the external authentication library '%s' (%Vrc)"), filename, rc);
207	}
208
209	// for VirtualBoxSupportErrorInfoImpl
210	static const wchar_t *getComponentName() { return L"Console"; }
211
212	private:
213
214	/**
215	* Base template for AutoVMCaller and SaveVMPtr. Template arguments
216	* have the same meaning as arguments of Console::addVMCaller().
217	*/
218	template <bool taQuiet = false, bool taAllowNullVM = false>
219	class AutoVMCallerBase
220	{
221	public:
222	AutoVMCallerBase (Console *aThat) : mThat (aThat), mRC (S_OK)
223	{
224	Assert (aThat);
225	mRC = aThat->addVMCaller (taQuiet, taAllowNullVM);
226	}
227	~AutoVMCallerBase()
228	{
229	if (SUCCEEDED (mRC))
230	mThat->releaseVMCaller();
231	}
232	/** Decreases the number of callers before the instance is destroyed. */
233	void release()
234	{
235	AssertReturnVoid (SUCCEEDED (mRC));
236	mThat->releaseVMCaller();
237	mRC = E_FAIL;
238	}
239	/** Restores the number of callers after by #release(). #rc() must be
240	* rechecked to ensure the operation succeeded. */
241	void add()
242	{
243	AssertReturnVoid (!SUCCEEDED (mRC));
244	mRC = mThat->addVMCaller (taQuiet, taAllowNullVM);
245	}
246	/** Returns the result of Console::addVMCaller() */
247	HRESULT rc() const { return mRC; }
248	/** Shortcut to SUCCEEDED (rc()) */
249	bool isOk() const { return SUCCEEDED (mRC); }
250	protected:
251	Console *mThat;
252	HRESULT mRC;
253	private:
254	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (AutoVMCallerBase)
255	DECLARE_CLS_NEW_DELETE_NOOP (AutoVMCallerBase)
256	};
257
258	/**
259	* Helper class that protects sections of code using the mpVM pointer by
260	* automatically calling addVMCaller() on construction and
261	* releaseVMCaller() on destruction. Intended for Console methods dealing
262	* with mpVM. The usage pattern is:
263	* <code>
264	* AutoVMCaller autoVMCaller (this);
265	* CheckComRCReturnRC (autoVMCaller.rc());
266	* ...
267	* VMR3ReqCall (mpVM, ...
268	* </code>
269	*
270	* @sa SafeVMPtr, SafeVMPtrQuiet
271	*/
272	typedef AutoVMCallerBase <false, false> AutoVMCaller;
273
274	/**
275	* Base template for SaveVMPtr and SaveVMPtrQuiet.
276	*/
277	template <bool taQuiet = false>
278	class SafeVMPtrBase : public AutoVMCallerBase <taQuiet, true>
279	{
280	typedef AutoVMCallerBase <taQuiet, true> Base;
281	public:
282	SafeVMPtrBase (Console *aThat) : Base (aThat), mpVM (NULL)
283	{
284	if (SUCCEEDED (Base::mRC))
285	mpVM = aThat->mpVM;
286	}
287	/** Smart SaveVMPtr to PVM cast operator */
288	operator PVM() const { return mpVM; }
289	/** Direct PVM access for printf()-like functions */
290	PVM raw() const { return mpVM; }
291	private:
292	PVM mpVM;
293	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP (SafeVMPtrBase)
294	DECLARE_CLS_NEW_DELETE_NOOP (SafeVMPtrBase)
295	};
296
297	public:
298
299	/**
300	* Helper class that safely manages the Console::mpVM pointer
301	* by calling addVMCaller() on construction and releaseVMCaller() on
302	* destruction. Intended for Console children. The usage pattern is:
303	* <code>
304	* Console::SaveVMPtr pVM (mParent);
305	* CheckComRCReturnRC (pVM.rc());
306	* ...
307	* VMR3ReqCall (pVM, ...
308	* ...
309	* printf ("%p\n", pVM.raw());
310	* </code>
311	*
312	* @sa SafeVMPtrQuiet, AutoVMCaller
313	*/
314	typedef SafeVMPtrBase <false> SafeVMPtr;
315
316	/**
317	* A deviation of SaveVMPtr that doesn't set the error info on failure.
318	* Intenede for pieces of code that don't need to return the VM access
319	* failure to the caller. The usage pattern is:
320	* <code>
321	* Console::SaveVMPtrQuiet pVM (mParent);
322	* if (pVM.rc())
323	* VMR3ReqCall (pVM, ...
324	* return S_OK;
325	* </code>
326	*
327	* @sa SafeVMPtr, AutoVMCaller
328	*/
329	typedef SafeVMPtrBase <true> SafeVMPtrQuiet;
330
331	private:
332
333	typedef std::list <ComObjPtr <OUSBDevice> > USBDeviceList;
334	typedef std::list <ComObjPtr <RemoteUSBDevice> > RemoteUSBDeviceList;
335	typedef std::list <ComObjPtr <SharedFolder> > SharedFolderList;
336
337	HRESULT addVMCaller (bool aQuiet = false, bool aAllowNullVM = false);
338	void releaseVMCaller();
339
340	HRESULT powerDown();
341
342	HRESULT attachToHostInterface(INetworkAdapter *networkAdapter);
343	HRESULT detachFromHostInterface(INetworkAdapter *networkAdapter);
344	HRESULT powerDownHostInterfaces();
345
346	HRESULT setMachineState (MachineState_T aMachineState, bool aUpdateServer = true);
347	HRESULT setMachineStateLocally (MachineState_T aMachineState)
348	{
349	return setMachineState (aMachineState, false /* aUpdateServer */);
350	}
351
352	HRESULT findSharedFolder (const BSTR aName,
353	ComObjPtr <SharedFolder> &aSharedFolder,
354	bool aSetError = false);
355
356	static DECLCALLBACK(int) configConstructor(PVM pVM, void *pvConsole);
357	static DECLCALLBACK(void) vmstateChangeCallback(PVM aVM, VMSTATE aState,
358	VMSTATE aOldState, void *aUser);
359	HRESULT doDriveChange (const char *pszDevice, unsigned uInstance,
360	unsigned uLun, DriveState_T eState,
361	DriveState_T peState, const char pszPath,
362	bool fPassthrough);
363	static DECLCALLBACK(int) changeDrive (Console pThis, const char pszDevice,
364	unsigned uInstance, unsigned uLun,
365	DriveState_T eState, DriveState_T *peState,
366	const char *pszPath, bool fPassthrough);
367
368	HRESULT attachUSBDevice (IUSBDevice *aHostDevice, bool aManual,
369	PVUSBIRHCONFIG aConfig);
370
371	static DECLCALLBACK(int)
372	usbAttachCallback (Console that, IUSBDevice aHostDevice,
373	PVUSBIRHCONFIG aConfig, PCRTUUID aUuid, bool aRemote,
374	const char aAddress, void aRemoteBackend);
375	static DECLCALLBACK(int)
376	usbDetachCallback (Console that, USBDeviceList::iterator aIt,
377	bool aManual, PVUSBIRHCONFIG aConfig, PCRTUUID aUuid);
378
379	static DECLCALLBACK (int)
380	stateProgressCallback (PVM pVM, unsigned uPercent, void *pvUser);
381
382	static DECLCALLBACK(void)
383	setVMErrorCallback (PVM pVM, void *pvUser, int rc, RT_SRC_POS_DECL,
384	const char *pszFormat, va_list args);
385
386	static DECLCALLBACK(void)
387	setVMRuntimeErrorCallback (PVM pVM, void *pvUser, bool fFatal,
388	const char *pszErrorID,
389	const char *pszFormat, va_list args);
390
391	HRESULT captureUSBDevices (PVM pVM);
392	void releaseAllUSBDevices (void);
393
394	static DECLCALLBACK (int) powerUpThread (RTTHREAD Thread, void *pvUser);
395	static DECLCALLBACK (int) saveStateThread (RTTHREAD Thread, void *pvUser);
396	static DECLCALLBACK (int) powerDownThread (RTTHREAD Thread, void *pvUser);
397
398	static DECLCALLBACK(void *) drvStatus_QueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface);
399	static DECLCALLBACK(void) drvStatus_UnitChanged(PPDMILEDCONNECTORS pInterface, unsigned iLUN);
400	static DECLCALLBACK(void) drvStatus_Destruct(PPDMDRVINS pDrvIns);
401	static DECLCALLBACK(int) drvStatus_Construct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle);
402
403	#ifdef VRDP_MC
404	int m_cAudioRefs;
405
406	static DECLCALLBACK(int) vrdp_ClientLogon (void pvUser, uint32_t u32ClientId, const char pszUser, const char pszPassword, const char pszDomain);
407	static DECLCALLBACK(void) vrdp_ClientConnect (void *pvUser, uint32_t u32ClientId);
408	static DECLCALLBACK(void) vrdp_ClientDisconnect (void *pvUser, uint32_t u32ClientId, uint32_t fu32Intercepted);
409	static DECLCALLBACK(void) vrdp_InterceptAudio (void *pvUser, uint32_t u32ClientId);
410	static DECLCALLBACK(void) vrdp_InterceptUSB (void pvUser, uint32_t u32ClientId, PFNVRDPUSBCALLBACK ppfn, void **ppv);
411	#else
412	static DECLCALLBACK(int) vrdp_ClientLogon (void pvUser, const char pszUser, const char pszPassword, const char pszDomain);
413	static DECLCALLBACK(void) vrdp_ClientConnect (void *pvUser, uint32_t fu32SupportedOrders);
414	static DECLCALLBACK(void) vrdp_ClientDisconnect (void *pvUser);
415	static DECLCALLBACK(void) vrdp_InterceptAudio (void *pvUser, bool keepHostAudio);
416	static DECLCALLBACK(void) vrdp_InterceptUSB (void pvUser, PFNVRDPUSBCALLBACK ppfn, void **ppv);
417	#endif /* VRDP_MC */
418
419	static VRDPSERVERCALLBACK sVrdpServerCallback;
420
421	static char *sSSMConsoleUnit;
422	static uint32_t sSSMConsoleVer;
423
424	HRESULT loadDataFromSavedState();
425
426	static DECLCALLBACK(void) saveStateFileExec (PSSMHANDLE pSSM, void *pvUser);
427	static DECLCALLBACK(int) loadStateFileExec (PSSMHANDLE pSSM, void *pvUser, uint32_t u32Version);
428
429	bool mSavedStateDataLoaded : 1;
430
431	const ComPtr <IMachine> mMachine;
432	const ComPtr <IInternalMachineControl> mControl;
433
434	const ComPtr <IVRDPServer> mVRDPServer;
435	const ComPtr <IDVDDrive> mDVDDrive;
436	const ComPtr <IFloppyDrive> mFloppyDrive;
437
438	ConsoleVRDPServer * const mConsoleVRDPServer;
439
440	const ComObjPtr <Guest> mGuest;
441	const ComObjPtr <Keyboard> mKeyboard;
442	const ComObjPtr <Mouse> mMouse;
443	const ComObjPtr <Display> mDisplay;
444	const ComObjPtr <MachineDebugger> mDebugger;
445	const ComObjPtr <RemoteDisplayInfo> mRemoteDisplayInfo;
446
447	USBDeviceList mUSBDevices;
448	RemoteUSBDeviceList mRemoteUSBDevices;
449	SharedFolderList mSharedFolders;
450
451	/** The VM instance handle. */
452	PVM mpVM;
453	/** Holds the number of "readonly" mpVM callers (users) */
454	uint32_t mVMCallers;
455	/** Semaphore posted when the number of mpVM callers drops to zero */
456	RTSEMEVENT mVMZeroCallersSem;
457	/** true when Console has entered the mpVM destruction phase */
458	bool mVMDestroying : 1;
459
460	/** The current DVD drive state in the VM.
461	* This does not have to match the state maintained in the DVD. */
462	DriveState_T meDVDState;
463	/** The current Floppy drive state in the VM.
464	* This does not have to match the state maintained in the Floppy. */
465	DriveState_T meFloppyState;
466
467	VMMDev * const mVMMDev;
468	AudioSniffer * const mAudioSniffer;
469
470	PPDMLED mapFDLeds[2];
471	PPDMLED mapIDELeds[4];
472	PPDMLED mapNetworkLeds[8];
473	#ifdef VBOX_WITH_UNIXY_TAP_NETWORKING
474	Utf8Str maTAPDeviceName[8];
475	RTFILE maTapFD[8];
476	#endif
477
478	bool mVMStateChangeCallbackDisabled;
479
480	/* Local machine state value */
481	MachineState_T mMachineState;
482
483	typedef std::list <ComPtr <IConsoleCallback> > CallbackList;
484	CallbackList mCallbacks;
485
486	struct
487	{
488	/** OnMousePointerShapeChange() cache */
489	struct
490	{
491	bool valid;
492	bool visible;
493	bool alpha;
494	uint32_t xHot;
495	uint32_t yHot;
496	uint32_t width;
497	uint32_t height;
498	BYTE *shape;
499	size_t shapeSize;
500	}
501	mpsc;
502
503	/** OnMouseCapabilityChange() cache */
504	struct
505	{
506	bool valid;
507	BOOL supportsAbsolute;
508	BOOL needsHostCursor;
509	}
510	mcc;
511
512	/** OnKeyboardLedsChange() cache */
513	struct
514	{
515	bool valid;
516	bool numLock;
517	bool capsLock;
518	bool scrollLock;
519	}
520	klc;
521	}
522	mCallbackData;
523
524	friend struct VMTask;
525	};
526
527	#endif // ____H_CONSOLEIMPL

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

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

Download in other formats: