ConsoleImpl.h@ 38296

Last change on this file since 38296 was 37851, checked in by vboxsync, 13 years ago
Main/Console+Machine: new method for deleting a range of snapshot, right now not implemented
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 34.3 KB

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

Download in other formats: