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

Timestamp:

Mar 6, 2019 4:40:18 PM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

129207

Message:

Guest Control/Main: Implemented virtual guest object methods for session status changes to allow guest objects set their internal state accordingly. The guest session's object map now also keeps a (weak) pointer to the guest objects for handling the callbacks.

Location:

trunk/src/VBox/Main/src-client

Files:

• GuestDirectoryImpl.cpp (modified) (1 diff)
• GuestFileImpl.cpp (modified) (2 diffs)
• GuestProcessImpl.cpp (modified) (4 diffs)
• GuestSessionImpl.cpp (modified) (17 diffs)

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

@@ -231 +231 @@
 
 /**
- * Called by IGuestSession right before this directory gets
- * removed from the public directory list.
- */
-int GuestDirectory::i_onRemove(void)
-{
+ * @copydoc GuestObject::i_onUnregister
+ */
+int GuestDirectory::i_onUnregister(void)
+{
+    LogFlowThisFuncEnter();
+
+    int vrc = VINF_SUCCESS;
+
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
+}
+
+/**
+ * @copydoc GuestObject::i_onSessionStatusChange
+ */
+int GuestDirectory::i_onSessionStatusChange(GuestSessionStatus_T enmSessionStatus)
+{
+    RT_NOREF(enmSessionStatus);
+
     LogFlowThisFuncEnter();
 

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

@@ -617 +617 @@
 
 /**
- * Called by IGuestSession right before this file gets removed
- * from the public file list.
+ * @copydoc GuestObject::i_onUnregister
  */
-int GuestFile::i_onRemove(void)
+int GuestFile::i_onUnregister(void)
 {
     LogFlowThisFuncEnter();
@@ -639 +638 @@
         unconst(mEventSource).setNull();
     }
+
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
+}
+
+/**
+ * @copydoc GuestObject::i_onSessionStatusChange
+ */
+int GuestFile::i_onSessionStatusChange(GuestSessionStatus_T enmSessionStatus)
+{
+    LogFlowThisFuncEnter();
+
+    int vrc = VINF_SUCCESS;
+
+    /* If the session now is in a terminated state, set the file status
+     * to "down", as there is not much else we can do now. */
+    if (GuestSession::i_isTerminated(enmSessionStatus))
+        vrc = i_setFileStatus(FileStatus_Down, 0 /* fileRc, ignored */);
 
     LogFlowFuncLeaveRC(vrc);

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

@@ -281 +281 @@
     LogFlowThisFunc(("mExe=%s, PID=%RU32\n", mData.mProcess.mExecutable.c_str(), mData.mPID));
 
-    /* Terminate process if not already done yet. */
-    int rcGuest = VINF_SUCCESS;
-    int vrc = i_terminateProcess(30 * 1000, &rcGuest); /** @todo Make timeouts configurable. */
-    /* Note: Don't return here yet; first uninit all other stuff in
-     *       case of failure. */
-
     if (mData.mpSessionBaseEnv)
     {
@@ -295 +289 @@
     baseUninit();
 
-    LogFlowThisFunc(("Returning rc=%Rrc, rcGuest=%Rrc\n", vrc, rcGuest));
-    RT_NOREF_PV(vrc);
+    LogFlowFuncLeave();
 }
 
@@ -818 +811 @@
 
 /**
- * Called by IGuestSession right before this process gets
- * removed from the public process list.
+ * @copydoc GuestObject::i_onUnregister
  */
-int GuestProcess::i_onRemove(void)
+int GuestProcess::i_onUnregister(void)
 {
     LogFlowThisFuncEnter();
@@ -839 +831 @@
         mLocalListener.setNull();
         unconst(mEventSource).setNull();
+    }
+
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
+}
+
+/**
+ * @copydoc GuestObject::i_onSessionStatusChange
+ */
+int GuestProcess::i_onSessionStatusChange(GuestSessionStatus_T enmSessionStatus)
+{
+    LogFlowThisFuncEnter();
+
+    int vrc = VINF_SUCCESS;
+
+    /* If the session now is in a terminated state, set the process status
+     * to "down", as there is not much else we can do now. */
+    if (GuestSession::i_isTerminated(enmSessionStatus))
+    {
+        AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+        vrc = i_setProcessStatus(ProcessStatus_Down, 0 /* rc, ignored */);
     }
 

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

@@ -227 +227 @@
      * objects (like files, directories, ...) which are bound to this session.
      */
-    int rc = i_objectRegister(SESSIONOBJECTTYPE_SESSION, &mData.mObjectID);
+    int rc = i_objectRegister(NULL /* pObject */, SESSIONOBJECTTYPE_SESSION, &mData.mObjectID);
     if (RT_SUCCESS(rc))
     {
@@ -306 +306 @@
     LogFlowThisFuncEnter();
 
+    /* Call i_onRemove to take care of the object cleanups. */
+    i_onRemove();
+
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    LogFlowThisFunc(("Closing directories (%zu total)\n",
-                     mData.mDirectories.size()));
-    for (SessionDirectories::iterator itDirs = mData.mDirectories.begin();
-         itDirs != mData.mDirectories.end(); ++itDirs)
-    {
-        itDirs->second->i_onRemove();
-        itDirs->second->uninit();
-    }
-    mData.mDirectories.clear();
-
-    LogFlowThisFunc(("Closing files (%zu total)\n",
-                     mData.mFiles.size()));
-    for (SessionFiles::iterator itFiles = mData.mFiles.begin();
-         itFiles != mData.mFiles.end(); ++itFiles)
-    {
-        itFiles->second->i_onRemove();
-        itFiles->second->uninit();
-    }
-    mData.mFiles.clear();
-
-    LogFlowThisFunc(("Closing processes (%zu total)\n",
-                     mData.mProcesses.size()));
-    for (SessionProcesses::iterator itProcs = mData.mProcesses.begin();
-         itProcs != mData.mProcesses.end(); ++itProcs)
-    {
-        itProcs->second->i_onRemove();
-        itProcs->second->uninit();
-    }
-    mData.mProcesses.clear();
 
     /* Unregister the session's object ID. */
     i_objectUnregister(mData.mObjectID);
 
+    Assert(mData.mObjects.size () == 0);
     mData.mObjects.clear();
 
@@ -1034 +1008 @@
                  idObject, mData.mSession.mID, mData.mDirectories.size()));
 
-    rc = pDirConsumed->i_onRemove();
+    rc = pDirConsumed->i_onUnregister();
     AssertRCReturn(rc, rc);
 
@@ -1161 +1135 @@
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    /* Register a new object ID. */
-    uint32_t idObject;
-    int rc = i_objectRegister(SESSIONOBJECTTYPE_DIRECTORY, &idObject);
-    if (RT_FAILURE(rc))
-        return rc;
-
     /* Create the directory object. */
     HRESULT hr = pDirectory.createObject();
     if (FAILED(hr))
         return VERR_COM_UNEXPECTED;
+
+    /* Register a new object ID. */
+    uint32_t idObject;
+    int rc = i_objectRegister(pDirectory, SESSIONOBJECTTYPE_DIRECTORY, &idObject);
+    if (RT_FAILURE(rc))
+    {
+        pDirectory.setNull();
+        return rc;
+    }
 
     Console *pConsole = mParent->i_getConsole();
@@ -1433 +1410 @@
                  pFileConsumed->getObjectID(), mData.mSession.mID, mData.mFiles.size()));
 
-    rc = pFileConsumed->i_onRemove();
+    rc = pFileConsumed->i_onUnregister();
     AssertRCReturn(rc, rc);
 
@@ -1519 +1496 @@
     }
 
-    /* Register a new object ID. */
-    uint32_t idObject;
-    int rc = i_objectRegister(SESSIONOBJECTTYPE_FILE, &idObject);
-    if (RT_FAILURE(rc))
-        return rc;
-
     /* Create the directory object. */
     HRESULT hr = pFile.createObject();
     if (FAILED(hr))
         return VERR_COM_UNEXPECTED;
+
+    /* Register a new object ID. */
+    uint32_t idObject;
+    int rc = i_objectRegister(pFile, SESSIONOBJECTTYPE_FILE, &idObject);
+    if (RT_FAILURE(rc))
+    {
+        pFile.setNull();
+        return rc;
+    }
 
     Console *pConsole = mParent->i_getConsole();
@@ -1760 +1740 @@
 
 /**
- * Returns whether the session is in a terminated state or not.
+ * Returns whether a session status implies a terminated state or not.
  *
- * @returns \c true if in a terminated state, or \c false if not.
+ * @returns \c true if it's a terminated state, or \c false if not.
  */
-bool GuestSession::i_isTerminated(void) const
-{
-    switch (mData.mStatus)
+/* static */
+bool GuestSession::i_isTerminated(GuestSessionStatus_T enmStatus)
+{
+    switch (enmStatus)
     {
         case GuestSessionStatus_Terminated:
@@ -1787 +1768 @@
 
 /**
+ * Returns whether the session is in a terminated state or not.
+ *
+ * @returns \c true if in a terminated state, or \c false if not.
+ */
+bool GuestSession::i_isTerminated(void) const
+{
+    return GuestSession::i_isTerminated(mData.mStatus);
+}
+
+/**
  * Called by IGuest right before this session gets removed from
  * the public session list.
@@ -1796 +1787 @@
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    int vrc = VINF_SUCCESS;
+    int vrc = i_objectsUnregister();
 
     /*
@@ -2087 +2078 @@
  * @retval  VERR_GSTCTL_MAX_OBJECTS_REACHED if the maximum of concurrent objects
  *          is reached.
+ * @param   pObject     Guest object to register (weak pointer). Optional.
  * @param   enmType     Session object type to register.
- * @param   pidObject   Where to return the object ID on success.
+ * @param   pidObject   Where to return the object ID on success. Optional.
  */
-int GuestSession::i_objectRegister(SESSIONOBJECTTYPE enmType, uint32_t *pidObject)
-{
+int GuestSession::i_objectRegister(GuestObject *pObject, SESSIONOBJECTTYPE enmType, uint32_t *pidObject)
+{
+    /* pObject can be NULL. */
+    /* pidObject is optional. */
+
     /*
      * Pick a random bit as starting point.  If it's in use, search forward
@@ -2121 +2116 @@
     try
     {
+        mData.mObjects[idObject].pObject = pObject; /* Can be NULL. */
         mData.mObjects[idObject].enmType = enmType;
         mData.mObjects[idObject].msBirth = RTTimeMilliTS();
@@ -2130 +2126 @@
     }
 
-    alock.release();
-
-    *pidObject = idObject;
+    if (pidObject)
+        *pidObject = idObject;
+
     return VINF_SUCCESS;
 }
 
 /**
- * Unregisters an object from a session.
+ * Unregisters an object from the session objects list.
  *
  * @retval  VINF_SUCCESS on success.
@@ -2155 +2151 @@
 
     return rc;
+}
+
+/**
+ * Unregisters all objects from the session list.
+ *
+ * @returns VBox status code.
+ */
+int GuestSession::i_objectsUnregister(void)
+{
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    LogFlowThisFunc(("Unregistering directories (%zu total)\n", mData.mDirectories.size()));
+
+    SessionDirectories::iterator itDirs;
+    while ((itDirs = mData.mDirectories.begin()) != mData.mDirectories.end())
+    {
+        alock.release();
+        i_directoryUnregister(itDirs->second);
+        alock.acquire();
+    }
+
+    Assert(mData.mDirectories.size() == 0);
+    mData.mDirectories.clear();
+
+    LogFlowThisFunc(("Unregistering files (%zu total)\n", mData.mFiles.size()));
+
+    SessionFiles::iterator itFiles;
+    while ((itFiles = mData.mFiles.begin()) != mData.mFiles.end())
+    {
+        alock.release();
+        i_fileUnregister(itFiles->second);
+        alock.acquire();
+    }
+
+    Assert(mData.mFiles.size() == 0);
+    mData.mFiles.clear();
+
+    LogFlowThisFunc(("Unregistering processes (%zu total)\n", mData.mProcesses.size()));
+
+    SessionProcesses::iterator itProcs;
+    while ((itProcs = mData.mProcesses.begin()) != mData.mProcesses.end())
+    {
+        alock.release();
+        i_processUnregister(itProcs->second);
+        alock.acquire();
+    }
+
+    Assert(mData.mProcesses.size() == 0);
+    mData.mProcesses.clear();
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * Notifies all registered objects about a session status change.
+ *
+ * @returns VBox status code.
+ * @param   enmSessionStatus    Session status to notify objects about.
+ */
+int GuestSession::i_objectsNotifyAboutStatusChange(GuestSessionStatus_T enmSessionStatus)
+{
+    LogFlowThisFunc(("enmSessionStatus=%RU32\n", enmSessionStatus));
+
+    int vrc = VINF_SUCCESS;
+
+    SessionObjects::iterator itObjs = mData.mObjects.begin();
+    while (itObjs != mData.mObjects.end())
+    {
+        GuestObject *pObj = itObjs->second.pObject;
+        if (pObj) /* pObject can be NULL (weak pointer). */
+        {
+            int vrc2 = pObj->i_onSessionStatusChange(enmSessionStatus);
+            if (RT_SUCCESS(vrc))
+                vrc = vrc2;
+
+            /* If the session got terminated, make sure to cancel all wait events for
+             * the current object. */
+            if (i_isTerminated())
+                pObj->cancelWaitEvents();
+        }
+
+        ++itObjs;
+    }
+
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
 }
 
@@ -2333 +2415 @@
                  idObject, mData.mSession.mID, uPID, mData.mProcesses.size()));
 
-    rc = pProcess->i_onRemove();
+    rc = pProcess->i_onUnregister();
     AssertRCReturn(rc, rc);
 
@@ -2414 +2496 @@
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    /* Register a new object ID. */
-    uint32_t idObject;
-    int rc = i_objectRegister(SESSIONOBJECTTYPE_PROCESS, &idObject);
-    if (RT_FAILURE(rc))
-        return rc;
-
     /* Create the process object. */
     HRESULT hr = pProcess.createObject();
     if (FAILED(hr))
         return VERR_COM_UNEXPECTED;
+
+    /* Register a new object ID. */
+    uint32_t idObject;
+    int rc = i_objectRegister(pProcess, SESSIONOBJECTTYPE_PROCESS, &idObject);
+    if (RT_FAILURE(rc))
+    {
+        pProcess.setNull();
+        return rc;
+    }
 
     rc = pProcess->init(mParent->i_getConsole() /* Console */, this /* Session */, idObject,
@@ -2551 +2636 @@
         AssertMsg(RT_SUCCESS(sessionRc), ("Guest rc must not be an error (%Rrc)\n", sessionRc));
 
+    int vrc = VINF_SUCCESS;
+
     if (mData.mStatus != sessionStatus)
     {
         mData.mStatus = sessionStatus;
         mData.mRC     = sessionRc;
+
+        /* Make sure to notify all underlying objects first. */
+        vrc = i_objectsNotifyAboutStatusChange(sessionStatus);
 
         ComObjPtr<VirtualBoxErrorInfo> errorInfo;
@@ -2568 +2658 @@
     }
 
-    return VINF_SUCCESS;
+    LogFlowFuncLeaveRC(vrc);
+    return vrc;
 }