SessionImpl.cpp@ 11044

Last change on this file since 11044 was 11041, checked in by vboxsync, 16 years ago
Main: added guest property enumeration (currently only works when the machine is running)
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 31.6 KB

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

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

source: vbox/trunk/src/VBox/Main/SessionImpl.cpp@ 11044

Download in other formats: