VirtualBox

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

Last change on this file since 67918 was 67914, checked in by vboxsync, 8 years ago

src-client: Define LOG_GROUP according to interface or similar.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 37.3 KB
Line 
1/* $Id: SessionImpl.cpp 67914 2017-07-11 20:46:37Z vboxsync $ */
2/** @file
3 * VBox Client Session COM Class implementation in VBoxC.
4 */
5
6/*
7 * Copyright (C) 2006-2016 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#define LOG_GROUP LOG_GROUP_MAIN_SESSION
19#include "LoggingNew.h"
20
21#include "SessionImpl.h"
22#include "ConsoleImpl.h"
23#include "Global.h"
24#include "ClientTokenHolder.h"
25
26#include "AutoCaller.h"
27
28#include <VBox/err.h>
29#include <iprt/process.h>
30
31
32/**
33 * Local macro to check whether the session is open and return an error if not.
34 * @note Don't forget to do |Auto[Reader]Lock alock (this);| before using this
35 * macro.
36 */
37#define CHECK_OPEN() \
38 do { \
39 if (mState != SessionState_Locked) \
40 return setError(E_UNEXPECTED, tr ("The session is not locked (session state: %s)"), \
41 Global::stringifySessionState(mState)); \
42 } while (0)
43
44// constructor / destructor
45/////////////////////////////////////////////////////////////////////////////
46
47Session::Session()
48{
49}
50
51Session::~Session()
52{
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 mClientTokenHolder = NULL;
93
94 /* Confirm a successful initialization when it's the case */
95 autoInitSpan.setSucceeded();
96
97 LogFlowThisFuncLeave();
98
99 return S_OK;
100}
101
102/**
103 * Uninitializes the Session object.
104 *
105 * @note Locks this object for writing.
106 */
107void Session::uninit()
108{
109 LogFlowThisFuncEnter();
110
111 /* Enclose the state transition Ready->InUninit->NotReady */
112 AutoUninitSpan autoUninitSpan(this);
113 if (autoUninitSpan.uninitDone())
114 {
115 LogFlowThisFunc(("Already uninitialized.\n"));
116 LogFlowThisFuncLeave();
117 return;
118 }
119
120 /* close() needs write lock */
121 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
122
123 if (mState != SessionState_Unlocked)
124 {
125 Assert(mState == SessionState_Locked ||
126 mState == SessionState_Spawning);
127
128 HRESULT rc = i_unlockMachine(true /* aFinalRelease */, false /* aFromServer */, alock);
129 AssertComRC(rc);
130 }
131
132 LogFlowThisFuncLeave();
133}
134
135// ISession properties
136/////////////////////////////////////////////////////////////////////////////
137
138HRESULT Session::getState(SessionState_T *aState)
139{
140 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
141
142 *aState = mState;
143
144 return S_OK;
145}
146
147HRESULT Session::getType(SessionType_T *aType)
148{
149 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
150
151 CHECK_OPEN();
152
153 *aType = mType;
154 return S_OK;
155}
156
157HRESULT Session::getName(com::Utf8Str &aName)
158{
159 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
160
161 aName = mName;
162 return S_OK;
163}
164
165HRESULT Session::setName(const com::Utf8Str &aName)
166{
167 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
168
169 if (mState != SessionState_Unlocked)
170 return setError(VBOX_E_INVALID_OBJECT_STATE, tr("Trying to set name for a session which is not in state \"unlocked\""));
171
172 mName = aName;
173 return S_OK;
174}
175
176HRESULT Session::getMachine(ComPtr<IMachine> &aMachine)
177{
178 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
179
180 CHECK_OPEN();
181
182 HRESULT rc;
183#ifndef VBOX_COM_INPROC_API_CLIENT
184 if (mConsole)
185 rc = mConsole->i_machine().queryInterfaceTo(aMachine.asOutParam());
186 else
187#endif
188 rc = mRemoteMachine.queryInterfaceTo(aMachine.asOutParam());
189 if (FAILED(rc))
190 {
191#ifndef VBOX_COM_INPROC_API_CLIENT
192 if (mConsole)
193 setError(rc, tr("Failed to query the session machine"));
194 else
195#endif
196 if (FAILED_DEAD_INTERFACE(rc))
197 setError(rc, tr("Peer process crashed"));
198 else
199 setError(rc, tr("Failed to query the remote session machine"));
200 }
201
202 return rc;
203}
204
205HRESULT Session::getConsole(ComPtr<IConsole> &aConsole)
206{
207 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
208
209 CHECK_OPEN();
210
211 HRESULT rc = S_OK;
212#ifndef VBOX_COM_INPROC_API_CLIENT
213 if (mConsole)
214 rc = mConsole.queryInterfaceTo(aConsole.asOutParam());
215 else
216#endif
217 rc = mRemoteConsole.queryInterfaceTo(aConsole.asOutParam());
218
219 if (FAILED(rc))
220 {
221#ifndef VBOX_COM_INPROC_API_CLIENT
222 if (mConsole)
223 setError(rc, tr("Failed to query the console"));
224 else
225#endif
226 if (FAILED_DEAD_INTERFACE(rc))
227 setError(rc, tr("Peer process crashed"));
228 else
229 setError(rc, tr("Failed to query the remote console"));
230 }
231
232 return rc;
233}
234
235// ISession methods
236/////////////////////////////////////////////////////////////////////////////
237HRESULT Session::unlockMachine()
238{
239 LogFlowThisFunc(("mState=%d, mType=%d\n", mState, mType));
240
241 /* close() needs write lock */
242 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
243
244 CHECK_OPEN();
245 return i_unlockMachine(false /* aFinalRelease */, false /* aFromServer */, alock);
246}
247
248// IInternalSessionControl methods
249/////////////////////////////////////////////////////////////////////////////
250HRESULT Session::getPID(ULONG *aPid)
251{
252 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
253
254 *aPid = (ULONG)RTProcSelf();
255 AssertCompile(sizeof(*aPid) == sizeof(RTPROCESS));
256
257 return S_OK;
258}
259
260HRESULT Session::getRemoteConsole(ComPtr<IConsole> &aConsole)
261{
262 LogFlowThisFuncEnter();
263
264 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
265
266#ifndef VBOX_COM_INPROC_API_CLIENT
267 AssertMsgReturn(mType == SessionType_WriteLock && !!mConsole,
268 ("This is not a direct session!\n"),
269 VBOX_E_INVALID_OBJECT_STATE);
270
271 /* return a failure if the session already transitioned to Closing
272 * but the server hasn't processed Machine::OnSessionEnd() yet. */
273 if (mState != SessionState_Locked)
274 return VBOX_E_INVALID_VM_STATE;
275
276 mConsole.queryInterfaceTo(aConsole.asOutParam());
277
278 LogFlowThisFuncLeave();
279
280 return S_OK;
281
282#else /* VBOX_COM_INPROC_API_CLIENT */
283 RT_NOREF(aConsole);
284 AssertFailed();
285 return VBOX_E_INVALID_OBJECT_STATE;
286#endif /* VBOX_COM_INPROC_API_CLIENT */
287}
288
289HRESULT Session::getNominalState(MachineState_T *aNominalState)
290{
291 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
292 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
293 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
294#ifndef VBOX_COM_INPROC_API_CLIENT
295 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
296
297 return mConsole->i_getNominalState(*aNominalState);
298#else
299 RT_NOREF(aNominalState);
300 AssertFailed();
301 return E_NOTIMPL;
302#endif
303}
304
305#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
306HRESULT Session::assignMachine(const ComPtr<IMachine> &aMachine,
307 LockType_T aLockType,
308 const com::Utf8Str &aTokenId)
309#else
310HRESULT Session::assignMachine(const ComPtr<IMachine> &aMachine,
311 LockType_T aLockType,
312 const ComPtr<IToken> &aToken)
313#endif /* !VBOX_WITH_GENERIC_SESSION_WATCHER */
314{
315 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
316
317 AssertReturn(mState == SessionState_Unlocked, VBOX_E_INVALID_VM_STATE);
318
319 if (!aMachine)
320 {
321 /*
322 * A special case: the server informs us that this session has been
323 * passed to IMachine::launchVMProcess() so this session will become
324 * remote (but not existing) when AssignRemoteMachine() is called.
325 */
326
327 AssertReturn(mType == SessionType_Null, VBOX_E_INVALID_OBJECT_STATE);
328 mType = SessionType_Remote;
329 mState = SessionState_Spawning;
330
331 return S_OK;
332 }
333
334 /* query IInternalMachineControl interface */
335 mControl = aMachine;
336 AssertReturn(!!mControl, E_FAIL);
337
338 HRESULT rc = S_OK;
339#ifndef VBOX_COM_INPROC_API_CLIENT
340 if (aLockType == LockType_VM)
341 {
342 /* This is what is special about VM processes: they have a Console
343 * object which is the root of all VM related activity. */
344 rc = mConsole.createObject();
345 AssertComRCReturn(rc, rc);
346
347 rc = mConsole->init(aMachine, mControl, aLockType);
348 AssertComRCReturn(rc, rc);
349 }
350 else
351 mRemoteMachine = aMachine;
352#else
353 RT_NOREF(aLockType);
354 mRemoteMachine = aMachine;
355#endif
356
357#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
358 Utf8Str strTokenId(aTokenId);
359 Assert(!strTokenId.isEmpty());
360#else /* VBOX_WITH_GENERIC_SESSION_WATCHER */
361 Assert(!aToken.isNull());
362#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
363 /* create the machine client token */
364 try
365 {
366#ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
367 mClientTokenHolder = new ClientTokenHolder(strTokenId);
368#else /* VBOX_WITH_GENERIC_SESSION_WATCHER */
369 mClientTokenHolder = new ClientTokenHolder(aToken);
370#endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
371 if (!mClientTokenHolder->isReady())
372 {
373 delete mClientTokenHolder;
374 mClientTokenHolder = NULL;
375 rc = E_FAIL;
376 }
377 }
378 catch (std::bad_alloc &)
379 {
380 rc = E_OUTOFMEMORY;
381 }
382
383 /*
384 * Reference the VirtualBox object to ensure the server is up
385 * until the session is closed
386 */
387 if (SUCCEEDED(rc))
388 rc = aMachine->COMGETTER(Parent)(mVirtualBox.asOutParam());
389
390 if (SUCCEEDED(rc))
391 {
392 mType = SessionType_WriteLock;
393 mState = SessionState_Locked;
394 }
395 else
396 {
397 /* some cleanup */
398 mControl.setNull();
399#ifndef VBOX_COM_INPROC_API_CLIENT
400 if (!mConsole.isNull())
401 {
402 mConsole->uninit();
403 mConsole.setNull();
404 }
405#endif
406 }
407
408 return rc;
409}
410
411HRESULT Session::assignRemoteMachine(const ComPtr<IMachine> &aMachine,
412 const ComPtr<IConsole> &aConsole)
413
414{
415 AssertReturn(aMachine, E_INVALIDARG);
416
417 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
418
419 AssertReturn(mState == SessionState_Unlocked ||
420 mState == SessionState_Spawning, VBOX_E_INVALID_VM_STATE);
421
422 HRESULT rc = E_FAIL;
423
424 /* query IInternalMachineControl interface */
425 mControl = aMachine;
426 AssertReturn(!!mControl, E_FAIL);
427
428 /// @todo (dmik)
429 // currently, the remote session returns the same machine and
430 // console objects as the direct session, thus giving the
431 // (remote) client full control over the direct session. For the
432 // console, it is the desired behavior (the ability to control
433 // VM execution is a must for the remote session). What about
434 // the machine object, we may want to prevent the remote client
435 // from modifying machine data. In this case, we must:
436 // 1) assign the Machine object (instead of the SessionMachine
437 // object that is passed to this method) to mRemoteMachine;
438 // 2) remove GetMachine() property from the IConsole interface
439 // because it always returns the SessionMachine object
440 // (alternatively, we can supply a separate IConsole
441 // implementation that will return the Machine object in
442 // response to GetMachine()).
443
444 mRemoteMachine = aMachine;
445 mRemoteConsole = aConsole;
446
447 /*
448 * Reference the VirtualBox object to ensure the server is up
449 * until the session is closed
450 */
451 rc = aMachine->COMGETTER(Parent)(mVirtualBox.asOutParam());
452
453 if (SUCCEEDED(rc))
454 {
455 /*
456 * RemoteSession type can be already set by AssignMachine() when its
457 * argument is NULL (a special case)
458 */
459 if (mType != SessionType_Remote)
460 mType = SessionType_Shared;
461 else
462 Assert(mState == SessionState_Spawning);
463
464 mState = SessionState_Locked;
465 }
466 else
467 {
468 /* some cleanup */
469 mControl.setNull();
470 mRemoteMachine.setNull();
471 mRemoteConsole.setNull();
472 }
473
474 LogFlowThisFunc(("rc=%08X\n", rc));
475 LogFlowThisFuncLeave();
476
477 return rc;
478}
479
480HRESULT Session::updateMachineState(MachineState_T aMachineState)
481{
482
483 if (getObjectState().getState() != ObjectState::Ready)
484 {
485 /*
486 * We might have already entered Session::uninit() at this point, so
487 * return silently (not interested in the state change during uninit)
488 */
489 LogFlowThisFunc(("Already uninitialized.\n"));
490 return S_OK;
491 }
492
493 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
494
495 if (mState == SessionState_Unlocking)
496 {
497 LogFlowThisFunc(("Already being unlocked.\n"));
498 return S_OK;
499 }
500
501 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
502 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
503
504 AssertReturn(!mControl.isNull(), E_FAIL);
505#ifndef VBOX_COM_INPROC_API_CLIENT
506 AssertReturn(!mConsole.isNull(), E_FAIL);
507
508 return mConsole->i_updateMachineState(aMachineState);
509#else
510 RT_NOREF(aMachineState);
511 return S_OK;
512#endif
513}
514
515HRESULT Session::uninitialize()
516{
517 LogFlowThisFuncEnter();
518
519 AutoCaller autoCaller(this);
520
521 HRESULT rc = S_OK;
522
523 if (getObjectState().getState() == ObjectState::Ready)
524 {
525 /* close() needs write lock */
526 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
527
528 LogFlowThisFunc(("mState=%s, mType=%d\n", Global::stringifySessionState(mState), mType));
529
530 if (mState == SessionState_Unlocking)
531 {
532 LogFlowThisFunc(("Already being unlocked.\n"));
533 return S_OK;
534 }
535
536 if ( mState == SessionState_Locked
537 || mState == SessionState_Spawning)
538 { /* likely */ }
539 else
540 {
541#ifndef DEBUG_bird /* bird: hitting this all the time running tdAddBaseic1.py. */
542 AssertMsgFailed(("Session is in wrong state (%d), expected locked (%d) or spawning (%d)\n",
543 mState, SessionState_Locked, SessionState_Spawning));
544#endif
545 return VBOX_E_INVALID_VM_STATE;
546 }
547
548 /* close ourselves */
549 rc = i_unlockMachine(false /* aFinalRelease */, true /* aFromServer */, alock);
550 }
551 else if (getObjectState().getState() == ObjectState::InUninit)
552 {
553 /*
554 * We might have already entered Session::uninit() at this point,
555 * return silently
556 */
557 LogFlowThisFunc(("Already uninitialized.\n"));
558 }
559 else
560 {
561 Log1WarningThisFunc(("UNEXPECTED uninitialization!\n"));
562 rc = autoCaller.rc();
563 }
564
565 LogFlowThisFunc(("rc=%08X\n", rc));
566 LogFlowThisFuncLeave();
567
568 return rc;
569}
570
571HRESULT Session::onNetworkAdapterChange(const ComPtr<INetworkAdapter> &aNetworkAdapter,
572 BOOL aChangeAdapter)
573
574{
575 LogFlowThisFunc(("\n"));
576
577 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
578 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
579 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
580#ifndef VBOX_COM_INPROC_API_CLIENT
581 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
582
583 return mConsole->i_onNetworkAdapterChange(aNetworkAdapter, aChangeAdapter);
584#else
585 RT_NOREF(aNetworkAdapter, aChangeAdapter);
586 return S_OK;
587#endif
588}
589
590HRESULT Session::onSerialPortChange(const ComPtr<ISerialPort> &aSerialPort)
591{
592 LogFlowThisFunc(("\n"));
593
594 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
595 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
596 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
597#ifndef VBOX_COM_INPROC_API_CLIENT
598 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
599
600 return mConsole->i_onSerialPortChange(aSerialPort);
601#else
602 RT_NOREF(aSerialPort);
603 return S_OK;
604#endif
605}
606
607HRESULT Session::onParallelPortChange(const ComPtr<IParallelPort> &aParallelPort)
608{
609 LogFlowThisFunc(("\n"));
610
611 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
612 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
613 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
614#ifndef VBOX_COM_INPROC_API_CLIENT
615 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
616
617 return mConsole->i_onParallelPortChange(aParallelPort);
618#else
619 RT_NOREF(aParallelPort);
620 return S_OK;
621#endif
622}
623
624HRESULT Session::onStorageControllerChange()
625{
626 LogFlowThisFunc(("\n"));
627
628 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
629 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
630 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
631#ifndef VBOX_COM_INPROC_API_CLIENT
632 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
633
634 return mConsole->i_onStorageControllerChange();
635#else
636 return S_OK;
637#endif
638}
639
640HRESULT Session::onMediumChange(const ComPtr<IMediumAttachment> &aMediumAttachment,
641 BOOL aForce)
642{
643 LogFlowThisFunc(("\n"));
644
645 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
646 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
647 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
648#ifndef VBOX_COM_INPROC_API_CLIENT
649 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
650
651 return mConsole->i_onMediumChange(aMediumAttachment, aForce);
652#else
653 RT_NOREF(aMediumAttachment, aForce);
654 return S_OK;
655#endif
656}
657
658HRESULT Session::onCPUChange(ULONG aCpu, BOOL aAdd)
659{
660 LogFlowThisFunc(("\n"));
661
662 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
663 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
664 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
665#ifndef VBOX_COM_INPROC_API_CLIENT
666 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
667
668 return mConsole->i_onCPUChange(aCpu, aAdd);
669#else
670 RT_NOREF(aCpu, aAdd);
671 return S_OK;
672#endif
673}
674
675HRESULT Session::onCPUExecutionCapChange(ULONG aExecutionCap)
676{
677 LogFlowThisFunc(("\n"));
678
679 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
680 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
681 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
682#ifndef VBOX_COM_INPROC_API_CLIENT
683 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
684
685 return mConsole->i_onCPUExecutionCapChange(aExecutionCap);
686#else
687 RT_NOREF(aExecutionCap);
688 return S_OK;
689#endif
690}
691
692HRESULT Session::onVRDEServerChange(BOOL aRestart)
693{
694 LogFlowThisFunc(("\n"));
695
696 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
697 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
698 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
699#ifndef VBOX_COM_INPROC_API_CLIENT
700 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
701
702 return mConsole->i_onVRDEServerChange(aRestart);
703#else
704 RT_NOREF(aRestart);
705 return S_OK;
706#endif
707}
708
709HRESULT Session::onVideoCaptureChange()
710{
711 LogFlowThisFunc(("\n"));
712
713 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
714 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
715 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
716#ifndef VBOX_COM_INPROC_API_CLIENT
717 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
718
719 return mConsole->i_onVideoCaptureChange();
720#else
721 return S_OK;
722#endif
723}
724
725HRESULT Session::onUSBControllerChange()
726{
727 LogFlowThisFunc(("\n"));
728
729 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
730 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
731 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
732#ifndef VBOX_COM_INPROC_API_CLIENT
733 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
734
735 return mConsole->i_onUSBControllerChange();
736#else
737 return S_OK;
738#endif
739}
740
741HRESULT Session::onSharedFolderChange(BOOL aGlobal)
742{
743 LogFlowThisFunc(("\n"));
744
745 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
746 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
747 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
748#ifndef VBOX_COM_INPROC_API_CLIENT
749 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
750
751 return mConsole->i_onSharedFolderChange(aGlobal);
752#else
753 RT_NOREF(aGlobal);
754 return S_OK;
755#endif
756}
757
758HRESULT Session::onClipboardModeChange(ClipboardMode_T aClipboardMode)
759{
760 LogFlowThisFunc(("\n"));
761
762 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
763 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
764 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
765#ifndef VBOX_COM_INPROC_API_CLIENT
766 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
767
768 return mConsole->i_onClipboardModeChange(aClipboardMode);
769#else
770 RT_NOREF(aClipboardMode);
771 return S_OK;
772#endif
773}
774
775HRESULT Session::onDnDModeChange(DnDMode_T aDndMode)
776{
777 LogFlowThisFunc(("\n"));
778
779 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
780 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
781#ifndef VBOX_COM_INPROC_API_CLIENT
782 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
783 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
784
785 return mConsole->i_onDnDModeChange(aDndMode);
786#else
787 RT_NOREF(aDndMode);
788 return S_OK;
789#endif
790}
791
792HRESULT Session::onUSBDeviceAttach(const ComPtr<IUSBDevice> &aDevice,
793 const ComPtr<IVirtualBoxErrorInfo> &aError,
794 ULONG aMaskedInterfaces,
795 const com::Utf8Str &aCaptureFilename)
796{
797 LogFlowThisFunc(("\n"));
798
799 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
800 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
801 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
802#ifndef VBOX_COM_INPROC_API_CLIENT
803 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
804
805 return mConsole->i_onUSBDeviceAttach(aDevice, aError, aMaskedInterfaces, aCaptureFilename);
806#else
807 RT_NOREF(aDevice, aError, aMaskedInterfaces, aCaptureFilename);
808 return S_OK;
809#endif
810}
811
812HRESULT Session::onUSBDeviceDetach(const com::Guid &aId,
813 const ComPtr<IVirtualBoxErrorInfo> &aError)
814{
815 LogFlowThisFunc(("\n"));
816
817 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
818 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
819 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
820#ifndef VBOX_COM_INPROC_API_CLIENT
821 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
822
823 return mConsole->i_onUSBDeviceDetach(aId.toUtf16().raw(), aError);
824#else
825 RT_NOREF(aId, aError);
826 return S_OK;
827#endif
828}
829
830HRESULT Session::onShowWindow(BOOL aCheck, BOOL *aCanShow, LONG64 *aWinId)
831{
832 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
833
834 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
835#ifndef VBOX_COM_INPROC_API_CLIENT
836 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
837#endif
838
839 if (mState != SessionState_Locked)
840 {
841 /* the call from Machine issued when the session is open can arrive
842 * after the session starts closing or gets closed. Note that when
843 * aCheck is false, we return E_FAIL to indicate that aWinId we return
844 * is not valid */
845 *aCanShow = FALSE;
846 *aWinId = 0;
847 return aCheck ? S_OK : E_FAIL;
848 }
849
850#ifndef VBOX_COM_INPROC_API_CLIENT
851 return mConsole->i_onShowWindow(aCheck, aCanShow, aWinId);
852#else
853 return S_OK;
854#endif
855}
856
857HRESULT Session::onBandwidthGroupChange(const ComPtr<IBandwidthGroup> &aBandwidthGroup)
858{
859 LogFlowThisFunc(("\n"));
860
861 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
862 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
863 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
864#ifndef VBOX_COM_INPROC_API_CLIENT
865 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
866
867 return mConsole->i_onBandwidthGroupChange(aBandwidthGroup);
868#else
869 RT_NOREF(aBandwidthGroup);
870 return S_OK;
871#endif
872}
873
874HRESULT Session::onStorageDeviceChange(const ComPtr<IMediumAttachment> &aMediumAttachment, BOOL aRemove, BOOL aSilent)
875{
876 LogFlowThisFunc(("\n"));
877
878 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
879 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
880 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
881#ifndef VBOX_COM_INPROC_API_CLIENT
882 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
883
884 return mConsole->i_onStorageDeviceChange(aMediumAttachment, aRemove, aSilent);
885#else
886 RT_NOREF(aMediumAttachment, aRemove, aSilent);
887 return S_OK;
888#endif
889}
890
891HRESULT Session::accessGuestProperty(const com::Utf8Str &aName, const com::Utf8Str &aValue, const com::Utf8Str &aFlags,
892 ULONG aAccessMode, com::Utf8Str &aRetValue, LONG64 *aRetTimestamp, com::Utf8Str &aRetFlags)
893{
894#ifdef VBOX_WITH_GUEST_PROPS
895# ifndef VBOX_COM_INPROC_API_CLIENT
896 if (mState != SessionState_Locked)
897 return setError(VBOX_E_INVALID_VM_STATE,
898 tr("Machine is not locked by session (session state: %s)."),
899 Global::stringifySessionState(mState));
900 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
901 if (aName.isEmpty())
902 return E_INVALIDARG;
903 if (aAccessMode == 0 && !RT_VALID_PTR(aRetTimestamp))
904 return E_POINTER;
905
906 /* If this session is not in a VM process fend off the call. The caller
907 * handles this correctly, by doing the operation in VBoxSVC. */
908 if (!mConsole)
909 return E_ACCESSDENIED;
910
911 HRESULT hr;
912 if (aAccessMode == 2)
913 hr = mConsole->i_deleteGuestProperty(aName);
914 else if (aAccessMode == 1)
915 hr = mConsole->i_setGuestProperty(aName, aValue, aFlags);
916 else if (aAccessMode == 0)
917 hr = mConsole->i_getGuestProperty(aName, &aRetValue, aRetTimestamp, &aRetFlags);
918 else
919 hr = E_INVALIDARG;
920
921 return hr;
922# else /* VBOX_COM_INPROC_API_CLIENT */
923 /** @todo This is nonsense, non-VM API users shouldn't need to deal with this
924 * method call, VBoxSVC should be clever enough to see that the
925 * session doesn't have a console! */
926 RT_NOREF(aName, aValue, aFlags, aAccessMode, aRetValue, aRetTimestamp, aRetFlags);
927 return E_ACCESSDENIED;
928# endif /* VBOX_COM_INPROC_API_CLIENT */
929
930#else /* VBOX_WITH_GUEST_PROPS */
931 ReturnComNotImplemented();
932#endif /* VBOX_WITH_GUEST_PROPS */
933}
934
935HRESULT Session::enumerateGuestProperties(const com::Utf8Str &aPatterns,
936 std::vector<com::Utf8Str> &aKeys,
937 std::vector<com::Utf8Str> &aValues,
938 std::vector<LONG64> &aTimestamps,
939 std::vector<com::Utf8Str> &aFlags)
940{
941#if defined(VBOX_WITH_GUEST_PROPS) && !defined(VBOX_COM_INPROC_API_CLIENT)
942 if (mState != SessionState_Locked)
943 return setError(VBOX_E_INVALID_VM_STATE,
944 tr("Machine is not locked by session (session state: %s)."),
945 Global::stringifySessionState(mState));
946 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
947
948 /* If this session is not in a VM process fend off the call. The caller
949 * handles this correctly, by doing the operation in VBoxSVC. */
950 if (!mConsole)
951 return E_ACCESSDENIED;
952
953 return mConsole->i_enumerateGuestProperties(aPatterns, aKeys, aValues, aTimestamps, aFlags);
954
955#else /* VBOX_WITH_GUEST_PROPS not defined */
956 RT_NOREF(aPatterns, aKeys, aValues, aTimestamps, aFlags);
957 ReturnComNotImplemented();
958#endif /* VBOX_WITH_GUEST_PROPS not defined */
959}
960
961HRESULT Session::onlineMergeMedium(const ComPtr<IMediumAttachment> &aMediumAttachment, ULONG aSourceIdx,
962 ULONG aTargetIdx, const ComPtr<IProgress> &aProgress)
963{
964 if (mState != SessionState_Locked)
965 return setError(VBOX_E_INVALID_VM_STATE,
966 tr("Machine is not locked by session (session state: %s)."),
967 Global::stringifySessionState(mState));
968#ifndef VBOX_COM_INPROC_API_CLIENT
969 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
970 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
971
972 return mConsole->i_onlineMergeMedium(aMediumAttachment,
973 aSourceIdx, aTargetIdx,
974 aProgress);
975#else
976 RT_NOREF(aMediumAttachment, aSourceIdx, aTargetIdx, aProgress);
977 AssertFailed();
978 return E_NOTIMPL;
979#endif
980}
981
982HRESULT Session::reconfigureMediumAttachments(const std::vector<ComPtr<IMediumAttachment> > &aAttachments)
983{
984 if (mState != SessionState_Locked)
985 return setError(VBOX_E_INVALID_VM_STATE,
986 tr("Machine is not locked by session (session state: %s)."),
987 Global::stringifySessionState(mState));
988#ifndef VBOX_COM_INPROC_API_CLIENT
989 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
990 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
991
992 return mConsole->i_reconfigureMediumAttachments(aAttachments);
993#else
994 RT_NOREF(aAttachments);
995 AssertFailed();
996 return E_NOTIMPL;
997#endif
998}
999
1000HRESULT Session::enableVMMStatistics(BOOL aEnable)
1001{
1002 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1003 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
1004 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
1005#ifndef VBOX_COM_INPROC_API_CLIENT
1006 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
1007
1008 mConsole->i_enableVMMStatistics(aEnable);
1009
1010 return S_OK;
1011#else
1012 RT_NOREF(aEnable);
1013 AssertFailed();
1014 return E_NOTIMPL;
1015#endif
1016}
1017
1018HRESULT Session::pauseWithReason(Reason_T aReason)
1019{
1020 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1021 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
1022 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
1023#ifndef VBOX_COM_INPROC_API_CLIENT
1024 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
1025
1026 return mConsole->i_pause(aReason);
1027#else
1028 RT_NOREF(aReason);
1029 AssertFailed();
1030 return E_NOTIMPL;
1031#endif
1032}
1033
1034HRESULT Session::resumeWithReason(Reason_T aReason)
1035{
1036 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1037 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
1038 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
1039#ifndef VBOX_COM_INPROC_API_CLIENT
1040 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
1041
1042 AutoWriteLock dummyLock(mConsole COMMA_LOCKVAL_SRC_POS);
1043 return mConsole->i_resume(aReason, dummyLock);
1044#else
1045 RT_NOREF(aReason);
1046 AssertFailed();
1047 return E_NOTIMPL;
1048#endif
1049}
1050
1051HRESULT Session::saveStateWithReason(Reason_T aReason, const ComPtr<IProgress> &aProgress, const Utf8Str &aStateFilePath,
1052 BOOL aPauseVM, BOOL *aLeftPaused)
1053{
1054 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1055 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
1056 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
1057#ifndef VBOX_COM_INPROC_API_CLIENT
1058 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
1059
1060 bool fLeftPaused = false;
1061 HRESULT rc = mConsole->i_saveState(aReason, aProgress, aStateFilePath, !!aPauseVM, fLeftPaused);
1062 if (aLeftPaused)
1063 *aLeftPaused = fLeftPaused;
1064 return rc;
1065#else
1066 RT_NOREF(aReason, aProgress, aStateFilePath, aPauseVM, aLeftPaused);
1067 AssertFailed();
1068 return E_NOTIMPL;
1069#endif
1070}
1071
1072HRESULT Session::cancelSaveStateWithReason()
1073{
1074 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1075 AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
1076 AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
1077#ifndef VBOX_COM_INPROC_API_CLIENT
1078 AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
1079
1080 return mConsole->i_cancelSaveState();
1081#else
1082 AssertFailed();
1083 return E_NOTIMPL;
1084#endif
1085}
1086
1087// private methods
1088///////////////////////////////////////////////////////////////////////////////
1089
1090/**
1091 * Unlocks a machine associated with the current session.
1092 *
1093 * @param aFinalRelease called as a result of FinalRelease()
1094 * @param aFromServer called as a result of Uninitialize()
1095 * @param aLockW The write lock this object is protected with.
1096 * Must be acquired already and will be released
1097 * and later reacquired during the unlocking.
1098 *
1099 * @note To be called only from #uninit(), ISession::UnlockMachine() or
1100 * ISession::Uninitialize().
1101 */
1102HRESULT Session::i_unlockMachine(bool aFinalRelease, bool aFromServer, AutoWriteLock &aLockW)
1103{
1104 LogFlowThisFuncEnter();
1105 LogFlowThisFunc(("aFinalRelease=%d, isFromServer=%d\n",
1106 aFinalRelease, aFromServer));
1107
1108 LogFlowThisFunc(("mState=%s, mType=%d\n", Global::stringifySessionState(mState), mType));
1109
1110 Assert(aLockW.isWriteLockOnCurrentThread());
1111
1112 if (mState != SessionState_Locked)
1113 {
1114 Assert(mState == SessionState_Spawning);
1115
1116 /* The session object is going to be uninitialized before it has been
1117 * assigned a direct console of the machine the client requested to open
1118 * a remote session to using IVirtualBox:: openRemoteSession(). It is OK
1119 * only if this close request comes from the server (for example, it
1120 * detected that the VM process it started terminated before opening a
1121 * direct session). Otherwise, it means that the client is too fast and
1122 * trying to close the session before waiting for the progress object it
1123 * got from IVirtualBox:: openRemoteSession() to complete, so assert. */
1124 Assert(aFromServer);
1125
1126 mState = SessionState_Unlocked;
1127 mType = SessionType_Null;
1128
1129 Assert(!mClientTokenHolder);
1130
1131 LogFlowThisFuncLeave();
1132 return S_OK;
1133 }
1134
1135 /* go to the closing state */
1136 mState = SessionState_Unlocking;
1137
1138 if (mType == SessionType_WriteLock)
1139 {
1140#ifndef VBOX_COM_INPROC_API_CLIENT
1141 if (!mConsole.isNull())
1142 {
1143 mConsole->uninit();
1144 mConsole.setNull();
1145 }
1146#else
1147 mRemoteMachine.setNull();
1148#endif
1149 }
1150 else
1151 {
1152 mRemoteMachine.setNull();
1153 mRemoteConsole.setNull();
1154 }
1155
1156 ComPtr<IProgress> progress;
1157
1158 if (!aFinalRelease && !aFromServer)
1159 {
1160 /*
1161 * We trigger OnSessionEnd() only when the session closes itself using
1162 * Close(). Note that if isFinalRelease = TRUE here, this means that
1163 * the client process has already initialized the termination procedure
1164 * without issuing Close() and the IPC channel is no more operational --
1165 * so we cannot call the server's method (it will definitely fail). The
1166 * server will instead simply detect the abnormal client death (since
1167 * OnSessionEnd() is not called) and reset the machine state to Aborted.
1168 */
1169
1170 /*
1171 * while waiting for OnSessionEnd() to complete one of our methods
1172 * can be called by the server (for example, Uninitialize(), if the
1173 * direct session has initiated a closure just a bit before us) so
1174 * we need to release the lock to avoid deadlocks. The state is already
1175 * SessionState_Closing here, so it's safe.
1176 */
1177 aLockW.release();
1178
1179 Assert(!aLockW.isWriteLockOnCurrentThread());
1180
1181 LogFlowThisFunc(("Calling mControl->OnSessionEnd()...\n"));
1182 HRESULT rc = mControl->OnSessionEnd(this, progress.asOutParam());
1183 LogFlowThisFunc(("mControl->OnSessionEnd()=%08X\n", rc));
1184
1185 aLockW.acquire();
1186
1187 /*
1188 * If we get E_UNEXPECTED this means that the direct session has already
1189 * been closed, we're just too late with our notification and nothing more
1190 *
1191 * bird: Seems E_ACCESSDENIED is what gets returned these days; see
1192 * ObjectState::addCaller.
1193 */
1194 if (mType != SessionType_WriteLock && (rc == E_UNEXPECTED || rc == E_ACCESSDENIED))
1195 rc = S_OK;
1196
1197#if !defined(DEBUG_bird) && !defined(DEBUG_andy) /* I don't want clients crashing on me just because VBoxSVC went belly up. */
1198 AssertComRC(rc);
1199#endif
1200 }
1201
1202 mControl.setNull();
1203
1204 if (mType == SessionType_WriteLock)
1205 {
1206 if (mClientTokenHolder)
1207 {
1208 delete mClientTokenHolder;
1209 mClientTokenHolder = NULL;
1210 }
1211
1212 if (!aFinalRelease && !aFromServer)
1213 {
1214 /*
1215 * Wait for the server to grab the semaphore and destroy the session
1216 * machine (allowing us to open a new session with the same machine
1217 * once this method returns)
1218 */
1219 Assert(!!progress);
1220 if (progress)
1221 progress->WaitForCompletion(-1);
1222 }
1223 }
1224
1225 mState = SessionState_Unlocked;
1226 mType = SessionType_Null;
1227
1228 /* release the VirtualBox instance as the very last step */
1229 mVirtualBox.setNull();
1230
1231 LogFlowThisFuncLeave();
1232 return S_OK;
1233}
1234
1235/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

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