SessionImpl.cpp@ 35650

Last change on this file since 35650 was 35638, checked in by vboxsync, 14 years ago
Main. QT/FE: fix long standing COM issue
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 38.2 KB

Line
1	/* $Id: SessionImpl.cpp 35638 2011-01-19 19:10:49Z vboxsync $ */
2	/** @file
3	* VBox Client Session COM Class implementation in VBoxC.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 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	#ifdef VBOX_WITH_SYS_V_IPC_SESSION_WATCHER
19	# include <errno.h>
20	# include <sys/types.h>
21	# include <sys/stat.h>
22	# include <sys/ipc.h>
23	# include <sys/sem.h>
24	#endif
25
26	#include "SessionImpl.h"
27	#include "ConsoleImpl.h"
28	#include "Global.h"
29
30	#include "AutoCaller.h"
31	#include "Logging.h"
32
33	#include <VBox/err.h>
34	#include <iprt/process.h>
35
36	#if defined(RT_OS_WINDOWS) \|\| defined (RT_OS_OS2)
37	/** VM IPC mutex holder thread */
38	static DECLCALLBACK(int) IPCMutexHolderThread(RTTHREAD Thread, void *pvUser);
39	#endif
40
41	/**
42	* Local macro to check whether the session is open and return an error if not.
43	* @note Don't forget to do \|Auto[Reader]Lock alock (this);\| before using this
44	* macro.
45	*/
46	#define CHECK_OPEN() \
47	do { \
48	if (mState != SessionState_Locked) \
49	return setError(E_UNEXPECTED, tr ("The session is not locked (session state: %s)"), Global::stringifySessionState(mState)); \
50	} while (0)
51
52	// constructor / destructor
53	/////////////////////////////////////////////////////////////////////////////
54
55	HRESULT Session::FinalConstruct()
56	{
57	LogFlowThisFunc(("\n"));
58
59	HRESULT rc = init();
60
61	BaseFinalConstruct();
62
63	return rc;
64	}
65
66	void Session::FinalRelease()
67	{
68	LogFlowThisFunc(("\n"));
69
70	uninit();
71
72	BaseFinalRelease();
73	}
74
75	// public initializer/uninitializer for internal purposes only
76	/////////////////////////////////////////////////////////////////////////////
77
78	/**
79	* Initializes the Session object.
80	*/
81	HRESULT Session::init()
82	{
83	/* Enclose the state transition NotReady->InInit->Ready */
84	AutoInitSpan autoInitSpan(this);
85	AssertReturn(autoInitSpan.isOk(), E_FAIL);
86
87	LogFlowThisFuncEnter();
88
89	mState = SessionState_Unlocked;
90	mType = SessionType_Null;
91
92	#if defined(RT_OS_WINDOWS)
93	mIPCSem = NULL;
94	mIPCThreadSem = NULL;
95	#elif defined(RT_OS_OS2)
96	mIPCThread = NIL_RTTHREAD;
97	mIPCThreadSem = NIL_RTSEMEVENT;
98	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
99	mIPCSem = -1;
100	#else
101	# error "Port me!"
102	#endif
103
104	/* Confirm a successful initialization when it's the case */
105	autoInitSpan.setSucceeded();
106
107	LogFlowThisFuncLeave();
108
109	return S_OK;
110	}
111
112	/**
113	* Uninitializes the Session object.
114	*
115	* @note Locks this object for writing.
116	*/
117	void Session::uninit()
118	{
119	LogFlowThisFuncEnter();
120
121	/* Enclose the state transition Ready->InUninit->NotReady */
122	AutoUninitSpan autoUninitSpan(this);
123	if (autoUninitSpan.uninitDone())
124	{
125	LogFlowThisFunc(("Already uninitialized.\n"));
126	LogFlowThisFuncLeave();
127	return;
128	}
129
130	/* close() needs write lock */
131	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
132
133	if (mState != SessionState_Unlocked)
134	{
135	Assert(mState == SessionState_Locked \|\|
136	mState == SessionState_Spawning);
137
138	HRESULT rc = unlockMachine(true /* aFinalRelease /, false / aFromServer */);
139	AssertComRC(rc);
140	}
141
142	LogFlowThisFuncLeave();
143	}
144
145	// ISession properties
146	/////////////////////////////////////////////////////////////////////////////
147
148	STDMETHODIMP Session::COMGETTER(State)(SessionState_T *aState)
149	{
150	CheckComArgOutPointerValid(aState);
151
152	AutoCaller autoCaller(this);
153	if (FAILED(autoCaller.rc())) return autoCaller.rc();
154
155	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
156
157	*aState = mState;
158
159	return S_OK;
160	}
161
162	STDMETHODIMP Session::COMGETTER(Type)(SessionType_T *aType)
163	{
164	CheckComArgOutPointerValid(aType);
165
166	AutoCaller autoCaller(this);
167	if (FAILED(autoCaller.rc())) return autoCaller.rc();
168
169	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
170
171	CHECK_OPEN();
172
173	*aType = mType;
174	return S_OK;
175	}
176
177	STDMETHODIMP Session::COMGETTER(Machine)(IMachine **aMachine)
178	{
179	CheckComArgOutPointerValid(aMachine);
180
181	AutoCaller autoCaller(this);
182	if (FAILED(autoCaller.rc())) return autoCaller.rc();
183
184	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
185
186	CHECK_OPEN();
187
188	HRESULT rc;
189	if (mConsole)
190	rc = mConsole->machine().queryInterfaceTo(aMachine);
191	else
192	rc = mRemoteMachine.queryInterfaceTo(aMachine);
193	if (FAILED(rc))
194	{
195	/** @todo VBox 3.3: replace E_FAIL with rc here. */
196	if (mConsole)
197	setError(E_FAIL, tr("Failed to query the session machine (%Rhrc)"), rc);
198	else if (FAILED_DEAD_INTERFACE(rc))
199	setError(E_FAIL, tr("Peer process crashed"));
200	else
201	setError(E_FAIL, tr("Failed to query the remote session machine (%Rhrc)"), rc);
202	}
203
204	return rc;
205	}
206
207	STDMETHODIMP Session::COMGETTER(Console)(IConsole **aConsole)
208	{
209	CheckComArgOutPointerValid(aConsole);
210
211	AutoCaller autoCaller(this);
212	if (FAILED(autoCaller.rc())) return autoCaller.rc();
213
214	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
215
216	CHECK_OPEN();
217
218	HRESULT rc;
219	if (mConsole)
220	rc = mConsole.queryInterfaceTo(aConsole);
221	else
222	rc = mRemoteConsole.queryInterfaceTo(aConsole);
223
224	if (FAILED(rc))
225	{
226	/** @todo VBox 3.3: replace E_FAIL with rc here. */
227	if (mConsole)
228	setError(E_FAIL, tr("Failed to query the console (%Rhrc)"), rc);
229	else if (FAILED_DEAD_INTERFACE(rc))
230	setError(E_FAIL, tr("Peer process crashed"));
231	else
232	setError(E_FAIL, tr("Failed to query the remote console (%Rhrc)"), rc);
233	}
234
235	return rc;
236	}
237
238	// ISession methods
239	/////////////////////////////////////////////////////////////////////////////
240
241	STDMETHODIMP Session::UnlockMachine()
242	{
243	LogFlowThisFunc(("mState=%d, mType=%d\n", mState, mType));
244
245	AutoCaller autoCaller(this);
246	if (FAILED(autoCaller.rc())) return autoCaller.rc();
247
248	/* close() needs write lock */
249	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
250
251	CHECK_OPEN();
252
253	return unlockMachine(false /* aFinalRelease /, false / aFromServer */);
254	}
255
256	// IInternalSessionControl methods
257	/////////////////////////////////////////////////////////////////////////////
258
259	STDMETHODIMP Session::GetPID(ULONG *aPid)
260	{
261	AssertReturn(aPid, E_POINTER);
262
263	AutoCaller autoCaller(this);
264	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
265
266	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
267
268	*aPid = (ULONG)RTProcSelf();
269	AssertCompile(sizeof(*aPid) == sizeof(RTPROCESS));
270
271	return S_OK;
272	}
273
274	STDMETHODIMP Session::GetRemoteConsole(IConsole **aConsole)
275	{
276	LogFlowThisFuncEnter();
277	AssertReturn(aConsole, E_POINTER);
278
279	AutoCaller autoCaller(this);
280	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
281
282	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
283
284	AssertReturn(mState != SessionState_Unlocked, VBOX_E_INVALID_VM_STATE);
285
286	AssertMsgReturn(mType == SessionType_WriteLock && !!mConsole,
287	("This is not a direct session!\n"),
288	VBOX_E_INVALID_OBJECT_STATE);
289
290	/* return a failure if the session already transitioned to Closing
291	* but the server hasn't processed Machine::OnSessionEnd() yet. */
292	if (mState != SessionState_Locked)
293	return VBOX_E_INVALID_VM_STATE;
294
295	mConsole.queryInterfaceTo(aConsole);
296
297	LogFlowThisFuncLeave();
298
299	return S_OK;
300	}
301
302	STDMETHODIMP Session::AssignMachine(IMachine *aMachine)
303	{
304	LogFlowThisFuncEnter();
305	LogFlowThisFunc(("aMachine=%p\n", aMachine));
306
307	AutoCaller autoCaller(this);
308	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
309
310	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
311
312	AssertReturn(mState == SessionState_Unlocked, VBOX_E_INVALID_VM_STATE);
313
314	if (!aMachine)
315	{
316	/*
317	* A special case: the server informs us that this session has been
318	* passed to IMachine::launchVMProcess() so this session will become
319	* remote (but not existing) when AssignRemoteMachine() is called.
320	*/
321
322	AssertReturn(mType == SessionType_Null, VBOX_E_INVALID_OBJECT_STATE);
323	mType = SessionType_Remote;
324	mState = SessionState_Spawning;
325
326	LogFlowThisFuncLeave();
327	return S_OK;
328	}
329
330	HRESULT rc = E_FAIL;
331
332	/* query IInternalMachineControl interface */
333	mControl = aMachine;
334	AssertReturn(!!mControl, E_FAIL);
335
336	rc = mConsole.createObject();
337	AssertComRCReturn(rc, rc);
338
339	rc = mConsole->init(aMachine, mControl);
340	AssertComRCReturn(rc, rc);
341
342	rc = grabIPCSemaphore();
343
344	/*
345	* Reference the VirtualBox object to ensure the server is up
346	* until the session is closed
347	*/
348	if (SUCCEEDED(rc))
349	rc = aMachine->COMGETTER(Parent)(mVirtualBox.asOutParam());
350
351	if (SUCCEEDED(rc))
352	{
353	mType = SessionType_WriteLock;
354	mState = SessionState_Locked;
355	}
356	else
357	{
358	/* some cleanup */
359	mControl.setNull();
360	mConsole->uninit();
361	mConsole.setNull();
362	}
363
364	LogFlowThisFunc(("rc=%08X\n", rc));
365	LogFlowThisFuncLeave();
366
367	return rc;
368	}
369
370	STDMETHODIMP Session::AssignRemoteMachine(IMachine aMachine, IConsole aConsole)
371	{
372	LogFlowThisFuncEnter();
373	LogFlowThisFunc(("aMachine=%p, aConsole=%p\n", aMachine, aConsole));
374
375	AssertReturn(aMachine && aConsole, E_INVALIDARG);
376
377	AutoCaller autoCaller(this);
378	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
379
380	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
381
382	AssertReturn(mState == SessionState_Unlocked \|\|
383	mState == SessionState_Spawning, VBOX_E_INVALID_VM_STATE);
384
385	HRESULT rc = E_FAIL;
386
387	/* query IInternalMachineControl interface */
388	mControl = aMachine;
389	AssertReturn(!!mControl, E_FAIL);
390
391	/// @todo (dmik)
392	// currently, the remote session returns the same machine and
393	// console objects as the direct session, thus giving the
394	// (remote) client full control over the direct session. For the
395	// console, it is the desired behavior (the ability to control
396	// VM execution is a must for the remote session). What about
397	// the machine object, we may want to prevent the remote client
398	// from modifying machine data. In this case, we must:
399	// 1) assign the Machine object (instead of the SessionMachine
400	// object that is passed to this method) to mRemoteMachine;
401	// 2) remove GetMachine() property from the IConsole interface
402	// because it always returns the SessionMachine object
403	// (alternatively, we can supply a separate IConsole
404	// implementation that will return the Machine object in
405	// response to GetMachine()).
406
407	mRemoteMachine = aMachine;
408	mRemoteConsole = aConsole;
409
410	/*
411	* Reference the VirtualBox object to ensure the server is up
412	* until the session is closed
413	*/
414	rc = aMachine->COMGETTER(Parent)(mVirtualBox.asOutParam());
415
416	if (SUCCEEDED(rc))
417	{
418	/*
419	* RemoteSession type can be already set by AssignMachine() when its
420	* argument is NULL (a special case)
421	*/
422	if (mType != SessionType_Remote)
423	mType = SessionType_Shared;
424	else
425	Assert(mState == SessionState_Spawning);
426
427	mState = SessionState_Locked;
428	}
429	else
430	{
431	/* some cleanup */
432	mControl.setNull();
433	mRemoteMachine.setNull();
434	mRemoteConsole.setNull();
435	}
436
437	LogFlowThisFunc(("rc=%08X\n", rc));
438	LogFlowThisFuncLeave();
439
440	return rc;
441	}
442
443	STDMETHODIMP Session::UpdateMachineState(MachineState_T aMachineState)
444	{
445	AutoCaller autoCaller(this);
446
447	if (autoCaller.state() != Ready)
448	{
449	/*
450	* We might have already entered Session::uninit() at this point, so
451	* return silently (not interested in the state change during uninit)
452	*/
453	LogFlowThisFunc(("Already uninitialized.\n"));
454	return S_OK;
455	}
456
457	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
458
459	if (mState == SessionState_Unlocking)
460	{
461	LogFlowThisFunc(("Already being unlocked.\n"));
462	return S_OK;
463	}
464
465	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
466	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
467
468	AssertReturn(!mControl.isNull(), E_FAIL);
469	AssertReturn(!mConsole.isNull(), E_FAIL);
470
471	return mConsole->updateMachineState(aMachineState);
472	}
473
474	STDMETHODIMP Session::Uninitialize()
475	{
476	LogFlowThisFuncEnter();
477
478	AutoCaller autoCaller(this);
479
480	HRESULT rc = S_OK;
481
482	if (autoCaller.state() == Ready)
483	{
484	/* close() needs write lock */
485	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
486
487	LogFlowThisFunc(("mState=%s, mType=%d\n", Global::stringifySessionState(mState), mType));
488
489	if (mState == SessionState_Unlocking)
490	{
491	LogFlowThisFunc(("Already being unlocked.\n"));
492	return S_OK;
493	}
494
495	AssertReturn(mState == SessionState_Locked \|\|
496	mState == SessionState_Spawning, VBOX_E_INVALID_VM_STATE);
497
498	/* close ourselves */
499	rc = unlockMachine(false /* aFinalRelease /, true / aFromServer */);
500	}
501	else if (autoCaller.state() == InUninit)
502	{
503	/*
504	* We might have already entered Session::uninit() at this point,
505	* return silently
506	*/
507	LogFlowThisFunc(("Already uninitialized.\n"));
508	}
509	else
510	{
511	LogWarningThisFunc(("UNEXPECTED uninitialization!\n"));
512	rc = autoCaller.rc();
513	}
514
515	LogFlowThisFunc(("rc=%08X\n", rc));
516	LogFlowThisFuncLeave();
517
518	return rc;
519	}
520
521	STDMETHODIMP Session::OnNetworkAdapterChange(INetworkAdapter *networkAdapter, BOOL changeAdapter)
522	{
523	LogFlowThisFunc(("\n"));
524
525	AutoCaller autoCaller(this);
526	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
527
528	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
529	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
530	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
531
532	return mConsole->onNetworkAdapterChange(networkAdapter, changeAdapter);
533	}
534
535	STDMETHODIMP Session::OnSerialPortChange(ISerialPort *serialPort)
536	{
537	LogFlowThisFunc(("\n"));
538
539	AutoCaller autoCaller(this);
540	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
541
542	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
543	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
544	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
545
546	return mConsole->onSerialPortChange(serialPort);
547	}
548
549	STDMETHODIMP Session::OnParallelPortChange(IParallelPort *parallelPort)
550	{
551	LogFlowThisFunc(("\n"));
552
553	AutoCaller autoCaller(this);
554	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
555
556	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
557	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
558	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
559
560	return mConsole->onParallelPortChange(parallelPort);
561	}
562
563	STDMETHODIMP Session::OnStorageControllerChange()
564	{
565	LogFlowThisFunc(("\n"));
566
567	AutoCaller autoCaller(this);
568	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
569
570	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
571	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
572	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
573
574	return mConsole->onStorageControllerChange();
575	}
576
577	STDMETHODIMP Session::OnMediumChange(IMediumAttachment *aMediumAttachment, BOOL aForce)
578	{
579	LogFlowThisFunc(("\n"));
580
581	AutoCaller autoCaller(this);
582	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
583
584	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
585	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
586	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
587
588	return mConsole->onMediumChange(aMediumAttachment, aForce);
589	}
590
591	STDMETHODIMP Session::OnCPUChange(ULONG aCPU, BOOL aRemove)
592	{
593	LogFlowThisFunc(("\n"));
594
595	AutoCaller autoCaller(this);
596	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
597
598	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
599	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
600	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
601
602	return mConsole->onCPUChange(aCPU, aRemove);
603	}
604
605	STDMETHODIMP Session::OnCPUExecutionCapChange(ULONG aExecutionCap)
606	{
607	LogFlowThisFunc(("\n"));
608
609	AutoCaller autoCaller(this);
610	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
611
612	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
613	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
614	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
615
616	return mConsole->onCPUExecutionCapChange(aExecutionCap);
617	}
618
619	STDMETHODIMP Session::OnVRDEServerChange(BOOL aRestart)
620	{
621	LogFlowThisFunc(("\n"));
622
623	AutoCaller autoCaller(this);
624	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
625
626	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
627	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
628	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
629
630	return mConsole->onVRDEServerChange(aRestart);
631	}
632
633	STDMETHODIMP Session::OnUSBControllerChange()
634	{
635	LogFlowThisFunc(("\n"));
636
637	AutoCaller autoCaller(this);
638	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
639
640	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
641	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
642	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
643
644	return mConsole->onUSBControllerChange();
645	}
646
647	STDMETHODIMP Session::OnSharedFolderChange(BOOL aGlobal)
648	{
649	LogFlowThisFunc(("\n"));
650
651	AutoCaller autoCaller(this);
652	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
653
654	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
655	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
656	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
657
658	return mConsole->onSharedFolderChange(aGlobal);
659	}
660
661	STDMETHODIMP Session::OnUSBDeviceAttach(IUSBDevice *aDevice,
662	IVirtualBoxErrorInfo *aError,
663	ULONG aMaskedIfs)
664	{
665	LogFlowThisFunc(("\n"));
666
667	AutoCaller autoCaller(this);
668	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
669
670	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
671	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
672	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
673
674	return mConsole->onUSBDeviceAttach(aDevice, aError, aMaskedIfs);
675	}
676
677	STDMETHODIMP Session::OnUSBDeviceDetach(IN_BSTR aId,
678	IVirtualBoxErrorInfo *aError)
679	{
680	LogFlowThisFunc(("\n"));
681
682	AutoCaller autoCaller(this);
683	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
684
685	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
686	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
687	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
688
689	return mConsole->onUSBDeviceDetach(aId, aError);
690	}
691
692	STDMETHODIMP Session::OnShowWindow(BOOL aCheck, BOOL aCanShow, LONG64 aWinId)
693	{
694	AutoCaller autoCaller(this);
695	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
696
697	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
698
699	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
700
701	if (mState != SessionState_Locked)
702	{
703	/* the call from Machine issued when the session is open can arrive
704	* after the session starts closing or gets closed. Note that when
705	* aCheck is false, we return E_FAIL to indicate that aWinId we return
706	* is not valid */
707	*aCanShow = FALSE;
708	*aWinId = 0;
709	return aCheck ? S_OK : E_FAIL;
710	}
711
712	return mConsole->onShowWindow(aCheck, aCanShow, aWinId);
713	}
714
715	STDMETHODIMP Session::OnBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup)
716	{
717	LogFlowThisFunc(("\n"));
718
719	AutoCaller autoCaller(this);
720	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
721
722	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
723	AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
724	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
725
726	return mConsole->onBandwidthGroupChange(aBandwidthGroup);
727	}
728
729	STDMETHODIMP Session::AccessGuestProperty(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags,
730	BOOL aIsSetter, BSTR aRetValue, LONG64 aRetTimestamp, BSTR *aRetFlags)
731	{
732	#ifdef VBOX_WITH_GUEST_PROPS
733	AutoCaller autoCaller(this);
734	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
735
736	if (mState != SessionState_Locked)
737	return setError(VBOX_E_INVALID_VM_STATE,
738	tr("Machine is not locked by session (session state: %s)."),
739	Global::stringifySessionState(mState));
740	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
741	CheckComArgStrNotEmptyOrNull(aName);
742	if (!aIsSetter && !VALID_PTR(aRetValue))
743	return E_POINTER;
744	if (!aIsSetter && !VALID_PTR(aRetTimestamp))
745	return E_POINTER;
746	if (!aIsSetter && !VALID_PTR(aRetFlags))
747	return E_POINTER;
748	/* aValue can be NULL for a setter call if the property is to be deleted. */
749	if (aIsSetter && (aValue != NULL) && !VALID_PTR(aValue))
750	return E_INVALIDARG;
751	/* aFlags can be null if it is to be left as is */
752	if (aIsSetter && (aFlags != NULL) && !VALID_PTR(aFlags))
753	return E_INVALIDARG;
754	if (!aIsSetter)
755	return mConsole->getGuestProperty(aName, aRetValue, aRetTimestamp, aRetFlags);
756	else
757	return mConsole->setGuestProperty(aName, aValue, aFlags);
758	#else /* VBOX_WITH_GUEST_PROPS not defined */
759	ReturnComNotImplemented();
760	#endif /* VBOX_WITH_GUEST_PROPS not defined */
761	}
762
763	STDMETHODIMP Session::EnumerateGuestProperties(IN_BSTR aPatterns,
764	ComSafeArrayOut(BSTR, aNames),
765	ComSafeArrayOut(BSTR, aValues),
766	ComSafeArrayOut(LONG64, aTimestamps),
767	ComSafeArrayOut(BSTR, aFlags))
768	{
769	#ifdef VBOX_WITH_GUEST_PROPS
770	AutoCaller autoCaller(this);
771	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
772
773	if (mState != SessionState_Locked)
774	return setError(VBOX_E_INVALID_VM_STATE,
775	tr("Machine is not locked by session (session state: %s)."),
776	Global::stringifySessionState(mState));
777	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
778	if (!VALID_PTR(aPatterns) && (aPatterns != NULL))
779	return E_POINTER;
780	if (ComSafeArrayOutIsNull(aNames))
781	return E_POINTER;
782	if (ComSafeArrayOutIsNull(aValues))
783	return E_POINTER;
784	if (ComSafeArrayOutIsNull(aTimestamps))
785	return E_POINTER;
786	if (ComSafeArrayOutIsNull(aFlags))
787	return E_POINTER;
788	return mConsole->enumerateGuestProperties(aPatterns,
789	ComSafeArrayOutArg(aNames),
790	ComSafeArrayOutArg(aValues),
791	ComSafeArrayOutArg(aTimestamps),
792	ComSafeArrayOutArg(aFlags));
793	#else /* VBOX_WITH_GUEST_PROPS not defined */
794	ReturnComNotImplemented();
795	#endif /* VBOX_WITH_GUEST_PROPS not defined */
796	}
797
798	STDMETHODIMP Session::OnlineMergeMedium(IMediumAttachment *aMediumAttachment,
799	ULONG aSourceIdx, ULONG aTargetIdx,
800	IMedium aSource, IMedium aTarget,
801	BOOL aMergeForward,
802	IMedium *aParentForTarget,
803	ComSafeArrayIn(IMedium *, aChildrenToReparent),
804	IProgress *aProgress)
805	{
806	AutoCaller autoCaller(this);
807	AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
808
809	if (mState != SessionState_Locked)
810	return setError(VBOX_E_INVALID_VM_STATE,
811	tr("Machine is not locked by session (session state: %s)."),
812	Global::stringifySessionState(mState));
813	AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
814	CheckComArgNotNull(aMediumAttachment);
815	CheckComArgSafeArrayNotNull(aChildrenToReparent);
816
817	return mConsole->onlineMergeMedium(aMediumAttachment, aSourceIdx,
818	aTargetIdx, aSource, aTarget,
819	aMergeForward, aParentForTarget,
820	ComSafeArrayInArg(aChildrenToReparent),
821	aProgress);
822	}
823
824
825	// private methods
826	///////////////////////////////////////////////////////////////////////////////
827
828	/**
829	* Unlocks a machine associated with the current session.
830	*
831	* @param aFinalRelease called as a result of FinalRelease()
832	* @param aFromServer called as a result of Uninitialize()
833	*
834	* @note To be called only from #uninit(), #UnlockMachine() or #Uninitialize().
835	* @note Locks this object for writing.
836	*/
837	HRESULT Session::unlockMachine(bool aFinalRelease, bool aFromServer)
838	{
839	LogFlowThisFuncEnter();
840	LogFlowThisFunc(("aFinalRelease=%d, isFromServer=%d\n",
841	aFinalRelease, aFromServer));
842
843	AutoCaller autoCaller(this);
844	AssertComRCReturnRC(autoCaller.rc());
845
846	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
847
848	LogFlowThisFunc(("mState=%s, mType=%d\n", Global::stringifySessionState(mState), mType));
849
850	if (mState != SessionState_Locked)
851	{
852	Assert(mState == SessionState_Spawning);
853
854	/* The session object is going to be uninitialized before it has been
855	* assigned a direct console of the machine the client requested to open
856	* a remote session to using IVirtualBox:: openRemoteSession(). It is OK
857	* only if this close request comes from the server (for example, it
858	* detected that the VM process it started terminated before opening a
859	* direct session). Otherwise, it means that the client is too fast and
860	* trying to close the session before waiting for the progress object it
861	* got from IVirtualBox:: openRemoteSession() to complete, so assert. */
862	Assert(aFromServer);
863
864	mState = SessionState_Unlocked;
865	mType = SessionType_Null;
866	#if defined(RT_OS_WINDOWS)
867	Assert(!mIPCSem && !mIPCThreadSem);
868	#elif defined(RT_OS_OS2)
869	Assert(mIPCThread == NIL_RTTHREAD &&
870	mIPCThreadSem == NIL_RTSEMEVENT);
871	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
872	Assert(mIPCSem == -1);
873	#else
874	# error "Port me!"
875	#endif
876	LogFlowThisFuncLeave();
877	return S_OK;
878	}
879
880	/* go to the closing state */
881	mState = SessionState_Unlocking;
882
883	if (mType == SessionType_WriteLock)
884	{
885	mConsole->uninit();
886	mConsole.setNull();
887	}
888	else
889	{
890	mRemoteMachine.setNull();
891	mRemoteConsole.setNull();
892	}
893
894	ComPtr<IProgress> progress;
895
896	if (!aFinalRelease && !aFromServer)
897	{
898	/*
899	* We trigger OnSessionEnd() only when the session closes itself using
900	* Close(). Note that if isFinalRelease = TRUE here, this means that
901	* the client process has already initialized the termination procedure
902	* without issuing Close() and the IPC channel is no more operational --
903	* so we cannot call the server's method (it will definitely fail). The
904	* server will instead simply detect the abnormal client death (since
905	* OnSessionEnd() is not called) and reset the machine state to Aborted.
906	*/
907
908	/*
909	* while waiting for OnSessionEnd() to complete one of our methods
910	* can be called by the server (for example, Uninitialize(), if the
911	* direct session has initiated a closure just a bit before us) so
912	* we need to release the lock to avoid deadlocks. The state is already
913	* SessionState_Closing here, so it's safe.
914	*/
915	alock.leave();
916
917	LogFlowThisFunc(("Calling mControl->OnSessionEnd()...\n"));
918	HRESULT rc = mControl->OnSessionEnd(this, progress.asOutParam());
919	LogFlowThisFunc(("mControl->OnSessionEnd()=%08X\n", rc));
920
921	alock.enter();
922
923	/*
924	* If we get E_UNEXPECTED this means that the direct session has already
925	* been closed, we're just too late with our notification and nothing more
926	*
927	* bird: Seems E_ACCESSDENIED is what gets returned these days; see
928	* VirtualBoxBase::addCaller.
929	*/
930	if (mType != SessionType_WriteLock && (rc == E_UNEXPECTED \|\| rc == E_ACCESSDENIED))
931	rc = S_OK;
932
933	#ifndef DEBUG_bird /* I don't want clients crashing on me just because VBoxSVC went belly up. */
934	AssertComRC(rc);
935	#endif
936	}
937
938	mControl.setNull();
939
940	if (mType == SessionType_WriteLock)
941	{
942	releaseIPCSemaphore();
943	if (!aFinalRelease && !aFromServer)
944	{
945	/*
946	* Wait for the server to grab the semaphore and destroy the session
947	* machine (allowing us to open a new session with the same machine
948	* once this method returns)
949	*/
950	Assert(!!progress);
951	if (progress)
952	progress->WaitForCompletion(-1);
953	}
954	}
955
956	mState = SessionState_Unlocked;
957	mType = SessionType_Null;
958
959	/* release the VirtualBox instance as the very last step */
960	mVirtualBox.setNull();
961
962	LogFlowThisFuncLeave();
963	return S_OK;
964	}
965
966	/** @note To be called only from #AssignMachine() */
967	HRESULT Session::grabIPCSemaphore()
968	{
969	HRESULT rc = E_FAIL;
970
971	/* open the IPC semaphore based on the sessionId and try to grab it */
972	Bstr ipcId;
973	rc = mControl->GetIPCId(ipcId.asOutParam());
974	AssertComRCReturnRC(rc);
975
976	LogFlowThisFunc(("ipcId='%ls'\n", ipcId.raw()));
977
978	#if defined(RT_OS_WINDOWS)
979
980	/*
981	* Since Session is an MTA object, this method can be executed on
982	* any thread, and this thread will not necessarily match the thread on
983	* which close() will be called later. Therefore, we need a separate
984	* thread to hold the IPC mutex and then release it in close().
985	*/
986
987	mIPCThreadSem = ::CreateEvent(NULL, FALSE, FALSE, NULL);
988	AssertMsgReturn(mIPCThreadSem,
989	("Cannot create an event sem, err=%d", ::GetLastError()),
990	E_FAIL);
991
992	void *data[3];
993	data[0] = (void*)(BSTR)ipcId.raw();
994	data[1] = (void*)mIPCThreadSem;
995	data[2] = 0; /* will get an output from the thread */
996
997	/* create a thread to hold the IPC mutex until signalled to release it */
998	RTTHREAD tid;
999	int vrc = RTThreadCreate(&tid, IPCMutexHolderThread, (void*)data, 0, RTTHREADTYPE_MAIN_WORKER, 0, "IPCHolder");
1000	AssertRCReturn(vrc, E_FAIL);
1001
1002	/* wait until thread init is completed */
1003	DWORD wrc = ::WaitForSingleObject(mIPCThreadSem, INFINITE);
1004	AssertMsg(wrc == WAIT_OBJECT_0, ("Wait failed, err=%d\n", ::GetLastError()));
1005	Assert(data[2]);
1006
1007	if (wrc == WAIT_OBJECT_0 && data[2])
1008	{
1009	/* memorize the event sem we should signal in close() */
1010	mIPCSem = (HANDLE)data[2];
1011	rc = S_OK;
1012	}
1013	else
1014	{
1015	::CloseHandle(mIPCThreadSem);
1016	mIPCThreadSem = NULL;
1017	rc = E_FAIL;
1018	}
1019
1020	#elif defined(RT_OS_OS2)
1021
1022	/* We use XPCOM where any message (including close()) can arrive on any
1023	* worker thread (which will not necessarily match this thread that opens
1024	* the mutex). Therefore, we need a separate thread to hold the IPC mutex
1025	* and then release it in close(). */
1026
1027	int vrc = RTSemEventCreate(&mIPCThreadSem);
1028	AssertRCReturn(vrc, E_FAIL);
1029
1030	void *data[3];
1031	data[0] = (void*)ipcId.raw();
1032	data[1] = (void*)mIPCThreadSem;
1033	data[2] = (void)false; / will get the thread result here */
1034
1035	/* create a thread to hold the IPC mutex until signalled to release it */
1036	vrc = RTThreadCreate(&mIPCThread, IPCMutexHolderThread, (void *) data,
1037	0, RTTHREADTYPE_MAIN_WORKER, 0, "IPCHolder");
1038	AssertRCReturn(vrc, E_FAIL);
1039
1040	/* wait until thread init is completed */
1041	vrc = RTThreadUserWait (mIPCThread, RT_INDEFINITE_WAIT);
1042	AssertReturn(RT_SUCCESS(vrc) \|\| vrc == VERR_INTERRUPTED, E_FAIL);
1043
1044	/* the thread must succeed */
1045	AssertReturn((bool)data[2], E_FAIL);
1046
1047	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
1048
1049	# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
1050	Utf8Str ipcKey = ipcId;
1051	key_t key = RTStrToUInt32(ipcKey.c_str());
1052	AssertMsgReturn (key != 0,
1053	("Key value of 0 is not valid for IPC semaphore"),
1054	E_FAIL);
1055	# else /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
1056	Utf8Str semName = ipcId;
1057	char *pszSemName = NULL;
1058	RTStrUtf8ToCurrentCP (&pszSemName, semName);
1059	key_t key = ::ftok (pszSemName, 'V');
1060	RTStrFree (pszSemName);
1061	# endif /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
1062
1063	mIPCSem = ::semget (key, 0, 0);
1064	AssertMsgReturn (mIPCSem >= 0,
1065	("Cannot open IPC semaphore, errno=%d", errno),
1066	E_FAIL);
1067
1068	/* grab the semaphore */
1069	::sembuf sop = { 0, -1, SEM_UNDO };
1070	int rv = ::semop (mIPCSem, &sop, 1);
1071	AssertMsgReturn (rv == 0,
1072	("Cannot grab IPC semaphore, errno=%d", errno),
1073	E_FAIL);
1074
1075	#else
1076	# error "Port me!"
1077	#endif
1078
1079	return rc;
1080	}
1081
1082	/** @note To be called only from #close() */
1083	void Session::releaseIPCSemaphore()
1084	{
1085	/* release the IPC semaphore */
1086	#if defined(RT_OS_WINDOWS)
1087
1088	if (mIPCSem && mIPCThreadSem)
1089	{
1090	/*
1091	* tell the thread holding the IPC mutex to release it;
1092	* it will close mIPCSem handle
1093	*/
1094	::SetEvent (mIPCSem);
1095	/* wait for the thread to finish */
1096	::WaitForSingleObject (mIPCThreadSem, INFINITE);
1097	::CloseHandle (mIPCThreadSem);
1098
1099	mIPCThreadSem = NULL;
1100	mIPCSem = NULL;
1101	}
1102
1103	#elif defined(RT_OS_OS2)
1104
1105	if (mIPCThread != NIL_RTTHREAD)
1106	{
1107	Assert (mIPCThreadSem != NIL_RTSEMEVENT);
1108
1109	/* tell the thread holding the IPC mutex to release it */
1110	int vrc = RTSemEventSignal (mIPCThreadSem);
1111	AssertRC(vrc == NO_ERROR);
1112
1113	/* wait for the thread to finish */
1114	vrc = RTThreadUserWait (mIPCThread, RT_INDEFINITE_WAIT);
1115	Assert (RT_SUCCESS(vrc) \|\| vrc == VERR_INTERRUPTED);
1116
1117	mIPCThread = NIL_RTTHREAD;
1118	}
1119
1120	if (mIPCThreadSem != NIL_RTSEMEVENT)
1121	{
1122	RTSemEventDestroy (mIPCThreadSem);
1123	mIPCThreadSem = NIL_RTSEMEVENT;
1124	}
1125
1126	#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
1127
1128	if (mIPCSem >= 0)
1129	{
1130	::sembuf sop = { 0, 1, SEM_UNDO };
1131	::semop (mIPCSem, &sop, 1);
1132
1133	mIPCSem = -1;
1134	}
1135
1136	#else
1137	# error "Port me!"
1138	#endif
1139	}
1140
1141	#if defined(RT_OS_WINDOWS)
1142	/** VM IPC mutex holder thread */
1143	DECLCALLBACK(int) IPCMutexHolderThread (RTTHREAD Thread, void *pvUser)
1144	{
1145	LogFlowFuncEnter();
1146
1147	Assert (pvUser);
1148	void data = (void ) pvUser;
1149
1150	BSTR sessionId = (BSTR)data[0];
1151	HANDLE initDoneSem = (HANDLE)data[1];
1152
1153	HANDLE ipcMutex = ::OpenMutex (MUTEX_ALL_ACCESS, FALSE, sessionId);
1154	AssertMsg (ipcMutex, ("cannot open IPC mutex, err=%d\n", ::GetLastError()));
1155
1156	if (ipcMutex)
1157	{
1158	/* grab the mutex */
1159	DWORD wrc = ::WaitForSingleObject (ipcMutex, 0);
1160	AssertMsg (wrc == WAIT_OBJECT_0, ("cannot grab IPC mutex, err=%d\n", wrc));
1161	if (wrc == WAIT_OBJECT_0)
1162	{
1163	HANDLE finishSem = ::CreateEvent (NULL, FALSE, FALSE, NULL);
1164	AssertMsg (finishSem, ("cannot create event sem, err=%d\n", ::GetLastError()));
1165	if (finishSem)
1166	{
1167	data[2] = (void*)finishSem;
1168	/* signal we're done with init */
1169	::SetEvent (initDoneSem);
1170	/* wait until we're signaled to release the IPC mutex */
1171	::WaitForSingleObject (finishSem, INFINITE);
1172	/* release the IPC mutex */
1173	LogFlow (("IPCMutexHolderThread(): releasing IPC mutex...\n"));
1174	BOOL success = ::ReleaseMutex (ipcMutex);
1175	AssertMsg (success, ("cannot release mutex, err=%d\n", ::GetLastError()));
1176	::CloseHandle (ipcMutex);
1177	::CloseHandle (finishSem);
1178	}
1179	}
1180	}
1181
1182	/* signal we're done */
1183	::SetEvent (initDoneSem);
1184
1185	LogFlowFuncLeave();
1186
1187	return 0;
1188	}
1189	#endif
1190
1191	#if defined(RT_OS_OS2)
1192	/** VM IPC mutex holder thread */
1193	DECLCALLBACK(int) IPCMutexHolderThread (RTTHREAD Thread, void *pvUser)
1194	{
1195	LogFlowFuncEnter();
1196
1197	Assert (pvUser);
1198	void data = (void ) pvUser;
1199
1200	Utf8Str ipcId = (BSTR)data[0];
1201	RTSEMEVENT finishSem = (RTSEMEVENT)data[1];
1202
1203	LogFlowFunc (("ipcId='%s', finishSem=%p\n", ipcId.raw(), finishSem));
1204
1205	HMTX ipcMutex = NULLHANDLE;
1206	APIRET arc = ::DosOpenMutexSem ((PSZ) ipcId.raw(), &ipcMutex);
1207	AssertMsg (arc == NO_ERROR, ("cannot open IPC mutex, arc=%ld\n", arc));
1208
1209	if (arc == NO_ERROR)
1210	{
1211	/* grab the mutex */
1212	LogFlowFunc (("grabbing IPC mutex...\n"));
1213	arc = ::DosRequestMutexSem (ipcMutex, SEM_IMMEDIATE_RETURN);
1214	AssertMsg (arc == NO_ERROR, ("cannot grab IPC mutex, arc=%ld\n", arc));
1215	if (arc == NO_ERROR)
1216	{
1217	/* store the answer */
1218	data[2] = (void*)true;
1219	/* signal we're done */
1220	int vrc = RTThreadUserSignal (Thread);
1221	AssertRC(vrc);
1222
1223	/* wait until we're signaled to release the IPC mutex */
1224	LogFlowFunc (("waiting for termination signal..\n"));
1225	vrc = RTSemEventWait (finishSem, RT_INDEFINITE_WAIT);
1226	Assert (arc == ERROR_INTERRUPT \|\| ERROR_TIMEOUT);
1227
1228	/* release the IPC mutex */
1229	LogFlowFunc (("releasing IPC mutex...\n"));
1230	arc = ::DosReleaseMutexSem (ipcMutex);
1231	AssertMsg (arc == NO_ERROR, ("cannot release mutex, arc=%ld\n", arc));
1232	}
1233
1234	::DosCloseMutexSem (ipcMutex);
1235	}
1236
1237	/* store the answer */
1238	data[1] = (void*)false;
1239	/* signal we're done */
1240	int vrc = RTThreadUserSignal (Thread);
1241	AssertRC(vrc);
1242
1243	LogFlowFuncLeave();
1244
1245	return 0;
1246	}
1247	#endif
1248	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

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

source: vbox/trunk/src/VBox/Main/src-client/SessionImpl.cpp@ 35650

Download in other formats: