Changeset 107588 in vbox for trunk/src/VBox/Main/src-server

Timestamp:

Jan 9, 2025 11:04:40 AM (2 months ago)

Author:

vboxsync

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

166661

Message:

Main,Puel: Made the object tracker code a compile time option (VBOX_WITH_MAIN_OBJECT_TRACKER) and disabled it since it causes VBoxSVC to crash during uninit. It is also badly in need of a review + style-cleanup (did some). Making it optional eliminates the need for Puel to include the object tracker code which it won't need (neither does VBoxC/Client.dll). bugref:10806

File:

• trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp (modified) (18 diffs)

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -108 +108 @@
 #include "ThreadTask.h"
 #include "VBoxEvents.h"
-
-#include "ObjectsTracker.h"
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
+# include "ObjectsTracker.h"
+#endif
 
 #include <QMTranslator.h>
@@ -133 +134 @@
 ////////////////////////////////////////////////////////////////////////////////
 
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
 extern TrackedObjectsCollector gTrackedObjectsCollector;
+#endif
 
 // static
@@ -334 +337 @@
         , cRefsCrypto(0)
         , pCryptoIf(NULL)
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
         , objectTrackerTask(NULL)
+#endif
     {
 #if defined(RT_OS_WINDOWS) && defined(VBOXSVC_WITH_CLIENT_WATCHER)
@@ -473 +478 @@
     /** @} */
 
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
     /** The tracked object collector (better if it'll be a singleton) */
-    ObjectTracker *objectTrackerTask;
+    ObjectTracker                      *objectTrackerTask;
+#endif
 };
 
@@ -569 +576 @@
     LogFlowThisFunc(("Version: %s, Package: %s, API Version: %s\n", sVersion.c_str(), sPackageType.c_str(), sAPIVersion.c_str()));
 
-    /* Try to start Object tracker thread as earlier as possible */
-    {
-        int vrc = 0;
-        if(gTrackedObjectsCollector.init())
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
+    /* Try to start Object tracker thread as earlier as possible (same code in VirtualBoxClientImpl.cpp). */
+    {
+        int vrc = VERR_GENERAL_FAILURE;
+        if (gTrackedObjectsCollector.init())
         {
             LogRel(("Starting the Object tracker thread\n"));
@@ -578 +586 @@
             {
                 m->objectTrackerTask = new ObjectTracker();
-                if (!m->objectTrackerTask->init()) // some init procedure
-                    vrc = VERR_INVALID_STATE;
-                else
+                if (m->objectTrackerTask->init()) // some init procedure - bird: some comment!
                     vrc = m->objectTrackerTask->createThread();
             }
@@ -594 +600 @@
             }
         }
-
-        if(RT_SUCCESS(vrc))
+        if (RT_SUCCESS(vrc))
             LogRel(("Successfully started the Object tracker thread\n"));
         else
             LogRel(("Failed to start the Object tracker thread (%Rrc)\n", vrc));
     }
+#endif
 
     /* Important: DO NOT USE any kind of "early return" (except the single
@@ -1169 +1175 @@
 
     m->mapProgressOperations.clear();
+
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
     /*
      * Call gTrackedObjectsCollector uninitialization before ExtPackManager uninitialization!!!
@@ -1180 +1188 @@
         gTrackedObjectsCollector.uninit();
     }
+#endif
 
 #ifdef VBOX_WITH_EXTPACK
@@ -6449 +6458 @@
 {
     if (!aId.isValid())
-        return setError(E_INVALIDARG,
-                        tr("The provided progress object GUID is invalid"));
-
-#ifdef VBOX_WITH_OBJ_TRACKER
+        return setError(E_INVALIDARG, tr("The provided progress object GUID is invalid"));
+
+#if 0 /** @todo def VBOX_WITH_MAIN_OBJECT_TRACKER - never used */
     std::vector<com::Utf8Str> lObjIdMap;
     gTrackedObjectsCollector.getObjIdsByClassIID(IID_IProgress, lObjIdMap);
 
-    for (const com::Utf8Str& item : lObjIdMap)
-    {
-        if(gTrackedObjectsCollector.checkObj(item.c_str()))
+    for (const com::Utf8Str &item : lObjIdMap)
+    {
+        if (gTrackedObjectsCollector.checkObj(item.c_str()))
         {
             TrackedObjectData temp;
@@ -6468 +6476 @@
             if (pProgress.isNotNull())
             {
-                Bstr reqId(aId.toString().c_str());
+                com::Bstr reqId(aId.toString());
                 Bstr foundId;
                 hrc = pProgress->COMGETTER(Id)(foundId.asOutParam());
@@ -6489 +6497 @@
         }
     }
-#else
+
+#else /* !VBOX_WITH_MAIN_OBJECT_TRACKER */
     /* protect mProgressOperations */
     AutoReadLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
@@ -6499 +6508 @@
         return S_OK;
     }
-#endif
-
-    return setError(E_INVALIDARG,
-                    tr("The progress object with the given GUID could not be found"));
-}
-
-HRESULT VirtualBox::getTrackedObject (const com::Utf8Str& aTrObjId,
-                                      ComPtr<IUnknown> &aPIface,
-                                      TrackedObjectState_T *aState,
-                                      LONG64 *aCreationTime,
-                                      LONG64 *aDeletionTime)
-{
+#endif /* !VBOX_WITH_MAIN_OBJECT_TRACKER */
+
+    /** @todo r=bird: E_INVALIDARG isn't a good choice here... */
+    return setError(E_INVALIDARG, tr("The progress object with the given GUID could not be found"));
+}
+
+HRESULT VirtualBox::getTrackedObject(const com::Utf8Str &aTrObjId,
+                                     ComPtr<IUnknown> &aPIface,
+                                     TrackedObjectState_T *aState,
+                                     LONG64 *aCreationTime,
+                                     LONG64 *aDeletionTime)
+{
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
     TrackedObjectData trObjData;
     HRESULT hrc = gTrackedObjectsCollector.getObj(aTrObjId, trObjData);
@@ -6524 +6534 @@
             *aDeletionTime = RTTimeSpecGetMilli(&time);
         }
+        /** @todo aDeletionTime isn't set */
     }
 
     return hrc;
-}
-
-
-std::map <com::Utf8Str, com::Utf8Str> lMapInterfaceNameToIID = {
+
+#else
+    RT_NOREF(aTrObjId, aPIface, aState, aCreationTime, aDeletionTime);
+    return E_NOTIMPL;
+#endif
+}
+
+
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
+static std::map<com::Utf8Str, com::Utf8Str> const g_lMapInterfaceNameToIID = {
     {"IProgress", Guid(IID_IProgress).toString()},
     {"ISession", Guid(IID_ISession).toString()},
@@ -6536 +6553 @@
     {"IMachine", Guid(IID_IMachine).toString()}
 };
+#endif
 
 /**
@@ -6545 +6563 @@
  * @return The list of the found objects Ids
  */
-HRESULT VirtualBox::getTrackedObjectIds (const com::Utf8Str& aName,
-                                         std::vector<com::Utf8Str> &aObjIdsList)
-{
+HRESULT VirtualBox::getTrackedObjectIds(const com::Utf8Str &aName,
+                                        std::vector<com::Utf8Str> &aObjIdsList)
+{
+#ifdef VBOX_WITH_MAIN_OBJECT_TRACKER
     HRESULT hrc = S_OK;
 
@@ -6553 +6572 @@
     {
         /* Check the supported tracked classes to avoid "out of range" exception */
-        if (lMapInterfaceNameToIID.count(aName))
-        {
-            hrc = gTrackedObjectsCollector.getObjIdsByClassIID(lMapInterfaceNameToIID.at(aName), aObjIdsList);
+        if (g_lMapInterfaceNameToIID.count(aName))
+        {
+            hrc = gTrackedObjectsCollector.getObjIdsByClassIID(g_lMapInterfaceNameToIID.at(aName), aObjIdsList);
             if (FAILED(hrc))
                 hrc = setError(VBOX_E_OBJECT_NOT_FOUND, tr("No objects were found for the passed interface name '%s'."),
@@ -6569 +6588 @@
 
     return hrc;
+
+#else
+    RT_NOREF(aName, aObjIdsList);
+    return E_NOTIMPL;
+#endif
 }