VirtualBox

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

Last change on this file since 38399 was 37423, checked in by vboxsync, 14 years ago

Ran the source code massager (scm).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 38.7 KB
Line 
1/* $Id: SessionImpl.cpp 37423 2011-06-12 18:37:56Z 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 */
38static 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
55HRESULT Session::FinalConstruct()
56{
57 LogFlowThisFunc(("\n"));
58
59 HRESULT rc = init();
60
61 BaseFinalConstruct();
62
63 return rc;
64}
65
66void 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 */
81HRESULT 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 */
117void 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
148STDMETHODIMP 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
162STDMETHODIMP 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
177STDMETHODIMP 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
207STDMETHODIMP 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
241STDMETHODIMP 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
259STDMETHODIMP 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
274STDMETHODIMP 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
302STDMETHODIMP 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
370STDMETHODIMP 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
443STDMETHODIMP 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
474STDMETHODIMP 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
521STDMETHODIMP 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
535STDMETHODIMP 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
549STDMETHODIMP 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
563STDMETHODIMP 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
577STDMETHODIMP 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
591STDMETHODIMP 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
605STDMETHODIMP 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
619STDMETHODIMP 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
633STDMETHODIMP 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
647STDMETHODIMP 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
661STDMETHODIMP 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
677STDMETHODIMP 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
692STDMETHODIMP 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
715STDMETHODIMP 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
729STDMETHODIMP Session::OnStorageDeviceChange(IMediumAttachment *aMediumAttachment, BOOL aRemove)
730{
731 LogFlowThisFunc(("\n"));
732
733 AutoCaller autoCaller(this);
734 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
735
736 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
737 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
738 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
739
740 return mConsole->onStorageDeviceChange(aMediumAttachment, aRemove);
741}
742
743STDMETHODIMP Session::AccessGuestProperty(IN_BSTR aName, IN_BSTR aValue, IN_BSTR aFlags,
744 BOOL aIsSetter, BSTR *aRetValue, LONG64 *aRetTimestamp, BSTR *aRetFlags)
745{
746#ifdef VBOX_WITH_GUEST_PROPS
747 AutoCaller autoCaller(this);
748 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
749
750 if (mState != SessionState_Locked)
751 return setError(VBOX_E_INVALID_VM_STATE,
752 tr("Machine is not locked by session (session state: %s)."),
753 Global::stringifySessionState(mState));
754 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
755 CheckComArgStrNotEmptyOrNull(aName);
756 if (!aIsSetter && !VALID_PTR(aRetValue))
757 return E_POINTER;
758 if (!aIsSetter && !VALID_PTR(aRetTimestamp))
759 return E_POINTER;
760 if (!aIsSetter && !VALID_PTR(aRetFlags))
761 return E_POINTER;
762 /* aValue can be NULL for a setter call if the property is to be deleted. */
763 if (aIsSetter && (aValue != NULL) && !VALID_PTR(aValue))
764 return E_INVALIDARG;
765 /* aFlags can be null if it is to be left as is */
766 if (aIsSetter && (aFlags != NULL) && !VALID_PTR(aFlags))
767 return E_INVALIDARG;
768 if (!aIsSetter)
769 return mConsole->getGuestProperty(aName, aRetValue, aRetTimestamp, aRetFlags);
770 else
771 return mConsole->setGuestProperty(aName, aValue, aFlags);
772#else /* VBOX_WITH_GUEST_PROPS not defined */
773 ReturnComNotImplemented();
774#endif /* VBOX_WITH_GUEST_PROPS not defined */
775}
776
777STDMETHODIMP Session::EnumerateGuestProperties(IN_BSTR aPatterns,
778 ComSafeArrayOut(BSTR, aNames),
779 ComSafeArrayOut(BSTR, aValues),
780 ComSafeArrayOut(LONG64, aTimestamps),
781 ComSafeArrayOut(BSTR, aFlags))
782{
783#ifdef VBOX_WITH_GUEST_PROPS
784 AutoCaller autoCaller(this);
785 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
786
787 if (mState != SessionState_Locked)
788 return setError(VBOX_E_INVALID_VM_STATE,
789 tr("Machine is not locked by session (session state: %s)."),
790 Global::stringifySessionState(mState));
791 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
792 if (!VALID_PTR(aPatterns) && (aPatterns != NULL))
793 return E_POINTER;
794 if (ComSafeArrayOutIsNull(aNames))
795 return E_POINTER;
796 if (ComSafeArrayOutIsNull(aValues))
797 return E_POINTER;
798 if (ComSafeArrayOutIsNull(aTimestamps))
799 return E_POINTER;
800 if (ComSafeArrayOutIsNull(aFlags))
801 return E_POINTER;
802 return mConsole->enumerateGuestProperties(aPatterns,
803 ComSafeArrayOutArg(aNames),
804 ComSafeArrayOutArg(aValues),
805 ComSafeArrayOutArg(aTimestamps),
806 ComSafeArrayOutArg(aFlags));
807#else /* VBOX_WITH_GUEST_PROPS not defined */
808 ReturnComNotImplemented();
809#endif /* VBOX_WITH_GUEST_PROPS not defined */
810}
811
812STDMETHODIMP Session::OnlineMergeMedium(IMediumAttachment *aMediumAttachment,
813 ULONG aSourceIdx, ULONG aTargetIdx,
814 IMedium *aSource, IMedium *aTarget,
815 BOOL aMergeForward,
816 IMedium *aParentForTarget,
817 ComSafeArrayIn(IMedium *, aChildrenToReparent),
818 IProgress *aProgress)
819{
820 AutoCaller autoCaller(this);
821 AssertComRCReturn(autoCaller.rc(), autoCaller.rc());
822
823 if (mState != SessionState_Locked)
824 return setError(VBOX_E_INVALID_VM_STATE,
825 tr("Machine is not locked by session (session state: %s)."),
826 Global::stringifySessionState(mState));
827 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
828 CheckComArgNotNull(aMediumAttachment);
829 CheckComArgSafeArrayNotNull(aChildrenToReparent);
830
831 return mConsole->onlineMergeMedium(aMediumAttachment, aSourceIdx,
832 aTargetIdx, aSource, aTarget,
833 aMergeForward, aParentForTarget,
834 ComSafeArrayInArg(aChildrenToReparent),
835 aProgress);
836}
837
838
839// private methods
840///////////////////////////////////////////////////////////////////////////////
841
842/**
843 * Unlocks a machine associated with the current session.
844 *
845 * @param aFinalRelease called as a result of FinalRelease()
846 * @param aFromServer called as a result of Uninitialize()
847 *
848 * @note To be called only from #uninit(), #UnlockMachine() or #Uninitialize().
849 * @note Locks this object for writing.
850 */
851HRESULT Session::unlockMachine(bool aFinalRelease, bool aFromServer)
852{
853 LogFlowThisFuncEnter();
854 LogFlowThisFunc(("aFinalRelease=%d, isFromServer=%d\n",
855 aFinalRelease, aFromServer));
856
857 AutoCaller autoCaller(this);
858 AssertComRCReturnRC(autoCaller.rc());
859
860 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
861
862 LogFlowThisFunc(("mState=%s, mType=%d\n", Global::stringifySessionState(mState), mType));
863
864 if (mState != SessionState_Locked)
865 {
866 Assert(mState == SessionState_Spawning);
867
868 /* The session object is going to be uninitialized before it has been
869 * assigned a direct console of the machine the client requested to open
870 * a remote session to using IVirtualBox:: openRemoteSession(). It is OK
871 * only if this close request comes from the server (for example, it
872 * detected that the VM process it started terminated before opening a
873 * direct session). Otherwise, it means that the client is too fast and
874 * trying to close the session before waiting for the progress object it
875 * got from IVirtualBox:: openRemoteSession() to complete, so assert. */
876 Assert(aFromServer);
877
878 mState = SessionState_Unlocked;
879 mType = SessionType_Null;
880#if defined(RT_OS_WINDOWS)
881 Assert(!mIPCSem && !mIPCThreadSem);
882#elif defined(RT_OS_OS2)
883 Assert(mIPCThread == NIL_RTTHREAD &&
884 mIPCThreadSem == NIL_RTSEMEVENT);
885#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
886 Assert(mIPCSem == -1);
887#else
888# error "Port me!"
889#endif
890 LogFlowThisFuncLeave();
891 return S_OK;
892 }
893
894 /* go to the closing state */
895 mState = SessionState_Unlocking;
896
897 if (mType == SessionType_WriteLock)
898 {
899 mConsole->uninit();
900 mConsole.setNull();
901 }
902 else
903 {
904 mRemoteMachine.setNull();
905 mRemoteConsole.setNull();
906 }
907
908 ComPtr<IProgress> progress;
909
910 if (!aFinalRelease && !aFromServer)
911 {
912 /*
913 * We trigger OnSessionEnd() only when the session closes itself using
914 * Close(). Note that if isFinalRelease = TRUE here, this means that
915 * the client process has already initialized the termination procedure
916 * without issuing Close() and the IPC channel is no more operational --
917 * so we cannot call the server's method (it will definitely fail). The
918 * server will instead simply detect the abnormal client death (since
919 * OnSessionEnd() is not called) and reset the machine state to Aborted.
920 */
921
922 /*
923 * while waiting for OnSessionEnd() to complete one of our methods
924 * can be called by the server (for example, Uninitialize(), if the
925 * direct session has initiated a closure just a bit before us) so
926 * we need to release the lock to avoid deadlocks. The state is already
927 * SessionState_Closing here, so it's safe.
928 */
929 alock.leave();
930
931 LogFlowThisFunc(("Calling mControl->OnSessionEnd()...\n"));
932 HRESULT rc = mControl->OnSessionEnd(this, progress.asOutParam());
933 LogFlowThisFunc(("mControl->OnSessionEnd()=%08X\n", rc));
934
935 alock.enter();
936
937 /*
938 * If we get E_UNEXPECTED this means that the direct session has already
939 * been closed, we're just too late with our notification and nothing more
940 *
941 * bird: Seems E_ACCESSDENIED is what gets returned these days; see
942 * VirtualBoxBase::addCaller.
943 */
944 if (mType != SessionType_WriteLock && (rc == E_UNEXPECTED || rc == E_ACCESSDENIED))
945 rc = S_OK;
946
947#ifndef DEBUG_bird /* I don't want clients crashing on me just because VBoxSVC went belly up. */
948 AssertComRC(rc);
949#endif
950 }
951
952 mControl.setNull();
953
954 if (mType == SessionType_WriteLock)
955 {
956 releaseIPCSemaphore();
957 if (!aFinalRelease && !aFromServer)
958 {
959 /*
960 * Wait for the server to grab the semaphore and destroy the session
961 * machine (allowing us to open a new session with the same machine
962 * once this method returns)
963 */
964 Assert(!!progress);
965 if (progress)
966 progress->WaitForCompletion(-1);
967 }
968 }
969
970 mState = SessionState_Unlocked;
971 mType = SessionType_Null;
972
973 /* release the VirtualBox instance as the very last step */
974 mVirtualBox.setNull();
975
976 LogFlowThisFuncLeave();
977 return S_OK;
978}
979
980/** @note To be called only from #AssignMachine() */
981HRESULT Session::grabIPCSemaphore()
982{
983 HRESULT rc = E_FAIL;
984
985 /* open the IPC semaphore based on the sessionId and try to grab it */
986 Bstr ipcId;
987 rc = mControl->GetIPCId(ipcId.asOutParam());
988 AssertComRCReturnRC(rc);
989
990 LogFlowThisFunc(("ipcId='%ls'\n", ipcId.raw()));
991
992#if defined(RT_OS_WINDOWS)
993
994 /*
995 * Since Session is an MTA object, this method can be executed on
996 * any thread, and this thread will not necessarily match the thread on
997 * which close() will be called later. Therefore, we need a separate
998 * thread to hold the IPC mutex and then release it in close().
999 */
1000
1001 mIPCThreadSem = ::CreateEvent(NULL, FALSE, FALSE, NULL);
1002 AssertMsgReturn(mIPCThreadSem,
1003 ("Cannot create an event sem, err=%d", ::GetLastError()),
1004 E_FAIL);
1005
1006 void *data[3];
1007 data[0] = (void*)(BSTR)ipcId.raw();
1008 data[1] = (void*)mIPCThreadSem;
1009 data[2] = 0; /* will get an output from the thread */
1010
1011 /* create a thread to hold the IPC mutex until signalled to release it */
1012 RTTHREAD tid;
1013 int vrc = RTThreadCreate(&tid, IPCMutexHolderThread, (void*)data, 0, RTTHREADTYPE_MAIN_WORKER, 0, "IPCHolder");
1014 AssertRCReturn(vrc, E_FAIL);
1015
1016 /* wait until thread init is completed */
1017 DWORD wrc = ::WaitForSingleObject(mIPCThreadSem, INFINITE);
1018 AssertMsg(wrc == WAIT_OBJECT_0, ("Wait failed, err=%d\n", ::GetLastError()));
1019 Assert(data[2]);
1020
1021 if (wrc == WAIT_OBJECT_0 && data[2])
1022 {
1023 /* memorize the event sem we should signal in close() */
1024 mIPCSem = (HANDLE)data[2];
1025 rc = S_OK;
1026 }
1027 else
1028 {
1029 ::CloseHandle(mIPCThreadSem);
1030 mIPCThreadSem = NULL;
1031 rc = E_FAIL;
1032 }
1033
1034#elif defined(RT_OS_OS2)
1035
1036 /* We use XPCOM where any message (including close()) can arrive on any
1037 * worker thread (which will not necessarily match this thread that opens
1038 * the mutex). Therefore, we need a separate thread to hold the IPC mutex
1039 * and then release it in close(). */
1040
1041 int vrc = RTSemEventCreate(&mIPCThreadSem);
1042 AssertRCReturn(vrc, E_FAIL);
1043
1044 void *data[3];
1045 data[0] = (void*)ipcId.raw();
1046 data[1] = (void*)mIPCThreadSem;
1047 data[2] = (void*)false; /* will get the thread result here */
1048
1049 /* create a thread to hold the IPC mutex until signalled to release it */
1050 vrc = RTThreadCreate(&mIPCThread, IPCMutexHolderThread, (void *) data,
1051 0, RTTHREADTYPE_MAIN_WORKER, 0, "IPCHolder");
1052 AssertRCReturn(vrc, E_FAIL);
1053
1054 /* wait until thread init is completed */
1055 vrc = RTThreadUserWait (mIPCThread, RT_INDEFINITE_WAIT);
1056 AssertReturn(RT_SUCCESS(vrc) || vrc == VERR_INTERRUPTED, E_FAIL);
1057
1058 /* the thread must succeed */
1059 AssertReturn((bool)data[2], E_FAIL);
1060
1061#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
1062
1063# ifdef VBOX_WITH_NEW_SYS_V_KEYGEN
1064 Utf8Str ipcKey = ipcId;
1065 key_t key = RTStrToUInt32(ipcKey.c_str());
1066 AssertMsgReturn (key != 0,
1067 ("Key value of 0 is not valid for IPC semaphore"),
1068 E_FAIL);
1069# else /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
1070 Utf8Str semName = ipcId;
1071 char *pszSemName = NULL;
1072 RTStrUtf8ToCurrentCP (&pszSemName, semName);
1073 key_t key = ::ftok (pszSemName, 'V');
1074 RTStrFree (pszSemName);
1075# endif /* !VBOX_WITH_NEW_SYS_V_KEYGEN */
1076
1077 mIPCSem = ::semget (key, 0, 0);
1078 AssertMsgReturn (mIPCSem >= 0,
1079 ("Cannot open IPC semaphore, errno=%d", errno),
1080 E_FAIL);
1081
1082 /* grab the semaphore */
1083 ::sembuf sop = { 0, -1, SEM_UNDO };
1084 int rv = ::semop (mIPCSem, &sop, 1);
1085 AssertMsgReturn (rv == 0,
1086 ("Cannot grab IPC semaphore, errno=%d", errno),
1087 E_FAIL);
1088
1089#else
1090# error "Port me!"
1091#endif
1092
1093 return rc;
1094}
1095
1096/** @note To be called only from #close() */
1097void Session::releaseIPCSemaphore()
1098{
1099 /* release the IPC semaphore */
1100#if defined(RT_OS_WINDOWS)
1101
1102 if (mIPCSem && mIPCThreadSem)
1103 {
1104 /*
1105 * tell the thread holding the IPC mutex to release it;
1106 * it will close mIPCSem handle
1107 */
1108 ::SetEvent (mIPCSem);
1109 /* wait for the thread to finish */
1110 ::WaitForSingleObject (mIPCThreadSem, INFINITE);
1111 ::CloseHandle (mIPCThreadSem);
1112
1113 mIPCThreadSem = NULL;
1114 mIPCSem = NULL;
1115 }
1116
1117#elif defined(RT_OS_OS2)
1118
1119 if (mIPCThread != NIL_RTTHREAD)
1120 {
1121 Assert (mIPCThreadSem != NIL_RTSEMEVENT);
1122
1123 /* tell the thread holding the IPC mutex to release it */
1124 int vrc = RTSemEventSignal (mIPCThreadSem);
1125 AssertRC(vrc == NO_ERROR);
1126
1127 /* wait for the thread to finish */
1128 vrc = RTThreadUserWait (mIPCThread, RT_INDEFINITE_WAIT);
1129 Assert (RT_SUCCESS(vrc) || vrc == VERR_INTERRUPTED);
1130
1131 mIPCThread = NIL_RTTHREAD;
1132 }
1133
1134 if (mIPCThreadSem != NIL_RTSEMEVENT)
1135 {
1136 RTSemEventDestroy (mIPCThreadSem);
1137 mIPCThreadSem = NIL_RTSEMEVENT;
1138 }
1139
1140#elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
1141
1142 if (mIPCSem >= 0)
1143 {
1144 ::sembuf sop = { 0, 1, SEM_UNDO };
1145 ::semop (mIPCSem, &sop, 1);
1146
1147 mIPCSem = -1;
1148 }
1149
1150#else
1151# error "Port me!"
1152#endif
1153}
1154
1155#if defined(RT_OS_WINDOWS)
1156/** VM IPC mutex holder thread */
1157DECLCALLBACK(int) IPCMutexHolderThread (RTTHREAD Thread, void *pvUser)
1158{
1159 LogFlowFuncEnter();
1160
1161 Assert (pvUser);
1162 void **data = (void **) pvUser;
1163
1164 BSTR sessionId = (BSTR)data[0];
1165 HANDLE initDoneSem = (HANDLE)data[1];
1166
1167 HANDLE ipcMutex = ::OpenMutex (MUTEX_ALL_ACCESS, FALSE, sessionId);
1168 AssertMsg (ipcMutex, ("cannot open IPC mutex, err=%d\n", ::GetLastError()));
1169
1170 if (ipcMutex)
1171 {
1172 /* grab the mutex */
1173 DWORD wrc = ::WaitForSingleObject (ipcMutex, 0);
1174 AssertMsg (wrc == WAIT_OBJECT_0, ("cannot grab IPC mutex, err=%d\n", wrc));
1175 if (wrc == WAIT_OBJECT_0)
1176 {
1177 HANDLE finishSem = ::CreateEvent (NULL, FALSE, FALSE, NULL);
1178 AssertMsg (finishSem, ("cannot create event sem, err=%d\n", ::GetLastError()));
1179 if (finishSem)
1180 {
1181 data[2] = (void*)finishSem;
1182 /* signal we're done with init */
1183 ::SetEvent (initDoneSem);
1184 /* wait until we're signaled to release the IPC mutex */
1185 ::WaitForSingleObject (finishSem, INFINITE);
1186 /* release the IPC mutex */
1187 LogFlow (("IPCMutexHolderThread(): releasing IPC mutex...\n"));
1188 BOOL success = ::ReleaseMutex (ipcMutex);
1189 AssertMsg (success, ("cannot release mutex, err=%d\n", ::GetLastError()));
1190 ::CloseHandle (ipcMutex);
1191 ::CloseHandle (finishSem);
1192 }
1193 }
1194 }
1195
1196 /* signal we're done */
1197 ::SetEvent (initDoneSem);
1198
1199 LogFlowFuncLeave();
1200
1201 return 0;
1202}
1203#endif
1204
1205#if defined(RT_OS_OS2)
1206/** VM IPC mutex holder thread */
1207DECLCALLBACK(int) IPCMutexHolderThread (RTTHREAD Thread, void *pvUser)
1208{
1209 LogFlowFuncEnter();
1210
1211 Assert (pvUser);
1212 void **data = (void **) pvUser;
1213
1214 Utf8Str ipcId = (BSTR)data[0];
1215 RTSEMEVENT finishSem = (RTSEMEVENT)data[1];
1216
1217 LogFlowFunc (("ipcId='%s', finishSem=%p\n", ipcId.raw(), finishSem));
1218
1219 HMTX ipcMutex = NULLHANDLE;
1220 APIRET arc = ::DosOpenMutexSem ((PSZ) ipcId.raw(), &ipcMutex);
1221 AssertMsg (arc == NO_ERROR, ("cannot open IPC mutex, arc=%ld\n", arc));
1222
1223 if (arc == NO_ERROR)
1224 {
1225 /* grab the mutex */
1226 LogFlowFunc (("grabbing IPC mutex...\n"));
1227 arc = ::DosRequestMutexSem (ipcMutex, SEM_IMMEDIATE_RETURN);
1228 AssertMsg (arc == NO_ERROR, ("cannot grab IPC mutex, arc=%ld\n", arc));
1229 if (arc == NO_ERROR)
1230 {
1231 /* store the answer */
1232 data[2] = (void*)true;
1233 /* signal we're done */
1234 int vrc = RTThreadUserSignal (Thread);
1235 AssertRC(vrc);
1236
1237 /* wait until we're signaled to release the IPC mutex */
1238 LogFlowFunc (("waiting for termination signal..\n"));
1239 vrc = RTSemEventWait (finishSem, RT_INDEFINITE_WAIT);
1240 Assert (arc == ERROR_INTERRUPT || ERROR_TIMEOUT);
1241
1242 /* release the IPC mutex */
1243 LogFlowFunc (("releasing IPC mutex...\n"));
1244 arc = ::DosReleaseMutexSem (ipcMutex);
1245 AssertMsg (arc == NO_ERROR, ("cannot release mutex, arc=%ld\n", arc));
1246 }
1247
1248 ::DosCloseMutexSem (ipcMutex);
1249 }
1250
1251 /* store the answer */
1252 data[1] = (void*)false;
1253 /* signal we're done */
1254 int vrc = RTThreadUserSignal (Thread);
1255 AssertRC(vrc);
1256
1257 LogFlowFuncLeave();
1258
1259 return 0;
1260}
1261#endif
1262/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette