Changeset 102614 in vbox for trunk/src/VBox/Main/src-client

Timestamp:

Dec 15, 2023 4:10:30 PM (12 months ago)

Author:

vboxsync

Message:

Guest Control: Keep a COM object reference to the guest and console objects, so that we can easier access those when needed. Also added a IGuestSession::i_isReady() function that checks the current VM state. This should help wrt closing a guest sessions when the VM already is in a transient state, for instance while a guest session is left open and a VM snapshot is being taken. Should fix the guest session re-connection issues after a VM shutdown + saved state has been taken with FE/Qt's file manager.

File:

• trunk/src/VBox/Main/src-client/GuestSessionImpl.cpp (modified) (11 diffs)

trunk/src/VBox/Main/src-client/GuestSessionImpl.cpp

@@ -221 +221 @@
      * Initialize our data members from the input.
      */
-    mParent = pGuest;
+    mParent  = pGuest;
+    mConsole = pGuest->i_getConsole();
 
     /* Copy over startup info. */
@@ -1440 +1441 @@
     alock.release();
 
-    Console *pConsole = mParent->i_getConsole();
-    AssertPtr(pConsole);
-
-    vrc = pDirectory->init(pConsole, this /* Parent */, idObject, openInfo);
+    vrc = pDirectory->init(mConsole, this /* Parent */, idObject, openInfo);
     if (RT_SUCCESS(vrc))
         vrc = pDirectory->i_open(pvrcGuest);
@@ -1923 +1921 @@
     }
 
-    Console *pConsole = mParent->i_getConsole();
-    AssertPtr(pConsole);
-
-    vrc = pFile->init(pConsole, this /* GuestSession */, idObject, openInfo);
+    vrc = pFile->init(mConsole, this /* GuestSession */, idObject, openInfo);
     if (RT_FAILURE(vrc))
         return vrc;
@@ -2308 +2303 @@
 
 /**
- * Checks if this session is ready state where it can handle
+ * Checks if this session is in a ready state where it can handle
  * all session-bound actions (like guest processes, guest files).
- * Only used by official API methods. Will set an external
- * error when not ready.
+ *
+ * Only used by official API methods.
+ * Takes the read lock.
+ *
+ * @returns S_OK if ready, E_FAIL if not.
+ * @note    Will set an external error when not ready.
  */
 HRESULT GuestSession::i_isStartedExternal(void)
@@ -2317 +2316 @@
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    /** @todo Be a bit more informative. */
     if (!i_isStarted())
-        return setError(E_UNEXPECTED, tr("Session is not in started state"));
-
+        return setError(E_FAIL, tr("Session is not in started state (state is '%s')",
+                                   Global::stringifyGuestSessionStatus(mData.mStatus)));
     return S_OK;
+}
+
+/**
+ * Returns if this session is in a ready-to-use state or not.
+ *
+ * @returns \c true if ready, or \c false if not.
+ */
+bool GuestSession::i_isReady(void)
+{
+    /* Check if the VM has the right machine state we can operate with. Also make sure that
+     * the VM is in an online *and* non-transient state while at it.
+     *
+     * This for instance is required if we want to close a guest session while the VM state is being saved or
+     * is doing some other lenghtly operations we can't operate with the guest.
+     */
+    MachineState_T enmMachineState = MachineState_Null;
+    HRESULT hrc = mConsole->COMGETTER(State)(&enmMachineState);
+    ComAssertComRCRet(hrc, false);
+    if (   !Global::IsOnline(enmMachineState)
+        ||  Global::IsTransient(enmMachineState))
+        return false;
+
+    return true;
 }
 
@@ -3277 +3298 @@
     }
 
-    vrc = pProcess->init(mParent->i_getConsole() /* Console */, this /* Session */, idObject, procInfo, mData.mpBaseEnvironment);
+    vrc = pProcess->init(mConsole, this /* Session */, idObject, procInfo, mData.mpBaseEnvironment);
     if (RT_FAILURE(vrc))
         return vrc;
@@ -3363 +3384 @@
  *
  * @returns VBox status code.
+ * @retval  VERR_VM_INVALID_VM_STATE if the VM is in a state where can't send message to the guest (anymore).
  * @param   uMessage            Message ID to send.
  * @param   uParms              Number of parameters in \a paParms to send.
@@ -3374 +3396 @@
 
 #ifndef VBOX_GUESTCTRL_TEST_CASE
-    AutoCaller autoCallerParent(mParent);
-    if (FAILED(autoCallerParent.hrc()))
-        return VERR_STATE_CHANGED;
-
-    ComObjPtr<Console> pConsole = mParent->i_getConsole();
-    Assert(!pConsole.isNull());
+    VMMDev *pVMMDev = mConsole->i_getVMMDev();
+    AssertPtrReturn(pVMMDev, VERR_VM_INVALID_VM_STATE);
 
     /* Forward the information to the VMM device. */
-    VMMDev *pVMMDev = pConsole->i_getVMMDev();
-    if (!pVMMDev)
-        return VERR_STATE_CHANGED;
-
     LogFlowThisFunc(("uMessage=%RU32 (%s), uParms=%RU32\n", uMessage, GstCtrlHostMsgtoStr((guestControl::eHostMsg)uMessage), uParms));
 
@@ -3493 +3507 @@
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    AssertPtrReturn(mParent, VERR_INVALID_POINTER);
     if (!(mParent->i_getGuestControlFeatures0() & VBOX_GUESTCTRL_GF_0_SHUTDOWN))
         return VERR_NOT_SUPPORTED;
@@ -3861 +3874 @@
     LogFlowThisFuncEnter();
 
+    HRESULT hrc = i_isStartedExternal();
+    if (FAILED(hrc))
+        return hrc;
+
+    int vrc = VINF_SUCCESS; /* Shut up MSVC. */
+
+    /* If the guest session is not in an unsable state (anymore), do the cleanup stuff ourselves. */
+    if (!i_isReady())
+    {
+        i_onRemove();
+        return S_OK;
+    }
+
     /* Note: Don't check if the session is ready via i_isStartedExternal() here;
      *       the session (already) could be in a stopped / aborted state. */
 
-    int vrc      = VINF_SUCCESS; /* Shut up MSVC. */
     int vrcGuest = VINF_SUCCESS;
 
@@ -3889 +3914 @@
     /* We have to make sure that our parent (IGuest) still is alive and in a working shapee.
      * If not, skip removing the session from it. */
-    AutoCaller autoCallerParent(mParent);
-    if (SUCCEEDED(autoCallerParent.hrc()))
-    {
-        LogFlowThisFunc(("Removing session '%s' from parent ...", mData.mSession.mName.c_str()));
-
-        /* Remove ourselves from the session list. */
-        AssertPtr(mParent);
-        int vrc2 = mParent->i_sessionRemove(mData.mSession.mID);
-        if (vrc2 == VERR_NOT_FOUND) /* Not finding the session anymore isn't critical. */
-            vrc2 = VINF_SUCCESS;
-
-        if (RT_SUCCESS(vrc))
-            vrc = vrc2;
-    }
-    else /* Do the session remove stuff ourselves. */
-        vrc = i_onRemove();
+    LogFlowThisFunc(("Removing session '%s' from parent ...", mData.mSession.mName.c_str()));
+
+    /* Remove ourselves from the session list. */
+    int vrc2 = mParent->i_sessionRemove(mData.mSession.mID);
+    if (vrc2 == VERR_NOT_FOUND) /* Not finding the session anymore isn't critical. */
+        vrc2 = VINF_SUCCESS;
+
+    if (RT_SUCCESS(vrc))
+        vrc = vrc2;
 
     LogFlowThisFunc(("Returning vrc=%Rrc, vrcGuest=%Rrc\n", vrc, vrcGuest));