Changeset 107958 in vbox for trunk

Timestamp:

Jan 28, 2025 9:28:51 AM (3 months ago)

Author:

vboxsync

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

167206

Message:

VBoxTray/IPC: Unified logging to also use the VBoxTray logging facilities, back off a little in the main worker thread if something has failed, to not hog the CPU too much. Note: This does not fix the actual issue yet but only fixes the symptom. ticketref:22123

File:

• trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxIPC.cpp (modified) (21 diffs)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxIPC.cpp

@@ -45 +45 @@
 
 #include "VBoxTray.h"
+#include "VBoxTrayInternal.h"
 #include "VBoxTrayMsg.h"
 #include "VBoxHelpers.h"
@@ -282 +283 @@
     AssertPtrReturnVoid(pvInstance);
 
-    LogFlowFunc(("Stopping pvInstance=%p\n", pvInstance));
+     VBoxTrayInfo("IPC: Stopping worker thread ...\n");
 
     /* Shut down local IPC server. */
@@ -331 +332 @@
         rc = RTLocalIpcServerDestroy(pCtx->hServer);
         if (RT_FAILURE(rc))
-            LogFlowFunc(("Unable to destroy IPC server, rc=%Rrc\n", rc));
+            VBoxTrayError("IPC: Unable to destroy IPC server, rc=%Rrc\n", rc);
 
         int rc2 = RTCritSectLeave(&pCtx->CritSect);
@@ -338 +339 @@
     }
 
-    LogFlowFunc(("Waiting for remaining IPC sessions to shut down ...\n"));
+    VBoxTrayInfo("IPC: Waiting for remaining IPC sessions to shut down ...\n");
 
     /* Wait for all IPC session threads to shut down. */
@@ -359 +360 @@
     } while (!fListIsEmpty);
 
-    AssertMsg(fListIsEmpty,
-              ("Session thread list is not empty when it should\n"));
-
-    LogFlowFunc(("All remaining IPC sessions shut down\n"));
+    AssertMsg(fListIsEmpty, ("Session thread list is not empty when it should\n"));
+    VBoxTrayInfo("IPC: All remaining IPC sessions shut down\n");
 
     int rc2 = RTCritSectDelete(&pCtx->CritSect);
@@ -368 +367 @@
         rc = rc2;
 
-    LogFlowFunc(("Destroyed pvInstance=%p, rc=%Rrc\n",
-             pvInstance, rc));
+    LogFlowFunc(("Destroyed pvInstance=%p, rc=%Rrc\n", pvInstance, rc));
 }
 
@@ -387 +385 @@
     AssertReturn(hSession != NIL_RTLOCALIPCSESSION, VERR_INVALID_PARAMETER);
 
-    LogFlowFunc(("pThis=%p\n", pThis));
+    VBoxTrayVerbose(1, "IPC: Session thread %#x started\n", hSession);
 
     int rc = VINF_SUCCESS;
@@ -419 +417 @@
                 || Hdr.uVersion != VBOXTRAY_IPC_HDR_VERSION)
             {
-                LogRelFunc(("Session %p: Invalid header magic/version: %#x, %#x, %#x, %#x\n",
-                            pThis, Hdr.uMagic, Hdr.uVersion, Hdr.enmMsgType, Hdr.cbPayload));
+                VBoxTrayVerbose(1, "IPC: Session %#x: Invalid header magic/version: %#x, %#x, %#x, %#x\n",
+                                hSession, Hdr.uMagic, Hdr.uVersion, Hdr.enmMsgType, Hdr.cbPayload);
                 rc = VERR_INVALID_MAGIC;
                 break;
@@ -426 +424 @@
             if (Hdr.cbPayload > VBOXTRAY_IPC_MAX_PAYLOAD)
             {
-                LogRelFunc(("Session %p: Payload to big: %#x, %#x, %#x, %#x - max %#x\n",
-                            pThis, Hdr.uMagic, Hdr.uVersion, Hdr.enmMsgType, Hdr.cbPayload, VBOXTRAY_IPC_MAX_PAYLOAD));
+                VBoxTrayVerbose(1, "IPC: Session %#x: Payload too big: %#x, %#x, %#x, %#x - max %#x\n",
+                                hSession, Hdr.uMagic, Hdr.uVersion, Hdr.enmMsgType, Hdr.cbPayload, VBOXTRAY_IPC_MAX_PAYLOAD);
                 rc = VERR_TOO_MUCH_DATA;
                 break;
@@ -434 +432 @@
                 || Hdr.enmMsgType >= VBOXTRAYIPCMSGTYPE_END)
             {
-                LogRelFunc(("Session %p: Unknown message: %#x, %#x, %#x, %#x\n",
-                            pThis, Hdr.uMagic, Hdr.uVersion, Hdr.enmMsgType, Hdr.cbPayload));
+                VBoxTrayVerbose(1, "IPC: Session %#x: Unknown message: %#x, %#x, %#x, %#x\n",
+                                hSession, Hdr.uMagic, Hdr.uVersion, Hdr.enmMsgType, Hdr.cbPayload);
                 rc = VERR_INVALID_FUNCTION;
                 break;
@@ -461 +459 @@
             }
             if (RT_FAILURE(rc))
-                LogFlowFunc(("Session %p: Handling command %RU32 failed with rc=%Rrc\n", pThis, Hdr.enmMsgType, rc));
+                VBoxTrayVerbose(1, "IPC: Session %#x: Handling command %RU32 failed with rc=%Rrc\n",
+                                hSession, Hdr.enmMsgType, rc);
         }
         else if (rc == VERR_CANCELLED)
         {
-            LogFlowFunc(("Session %p: Waiting for data cancelled\n", pThis));
+            VBoxTrayVerbose(1, "IPC: Session %#x: Waiting for data cancelled\n", hSession);
             rc = VINF_SUCCESS;
             break;
         }
         else
-            LogFlowFunc(("Session %p: Waiting for session data failed with rc=%Rrc\n", pThis, rc));
-    }
-
-    LogFlowFunc(("Session %p: Handler ended with rc=%Rrc\n", pThis, rc));
+            VBoxTrayError("IPC: Session %#x: Waiting for session data failed with rc=%Rrc\n", hSession, rc);
+    }
+
+    VBoxTrayVerbose(1, "IPC: Session thread %#x ended with rc=%Rrc\n", hSession, rc);
 
     /*
@@ -480 +479 @@
     int rc2 = RTLocalIpcSessionClose(hSession);
     if (RT_FAILURE(rc2))
-        LogFlowFunc(("Session %p: Failed closing session %p, rc=%Rrc\n", pThis, rc2));
+        VBoxTrayError("IPC: Failed closing session %#x, rc=%Rrc\n", hSession, rc);
 
     /*
@@ -486 +485 @@
      */
     PVBOXIPCCONTEXT pCtx = ASMAtomicReadPtrT(&pThis->pCtx, PVBOXIPCCONTEXT);
-    AssertMsg(pCtx, ("Session %p: No context found\n", pThis));
+    AssertMsg(pCtx, ("Session %#x: No context found\n", hSession));
     rc2 = RTCritSectEnter(&pCtx->CritSect);
     if (RT_SUCCESS(rc2))
@@ -498 +497 @@
     }
 
-    LogFlowFunc(("Session %p: Terminated with rc=%Rrc, freeing ...\n", pThis, rc));
+    VBoxTrayVerbose(1, "IPC: Session thread %#x terminated with rc=%Rrc\n", hSession, rc);
 
     RTMemFree(pThis);
@@ -517 +516 @@
         if (pSession)
         {
-            pSession->pCtx      = pCtx;
+            pSession->pCtx       = pCtx;
             pSession->hSession   = hSession;
             pSession->fTerminate = false;
@@ -536 +535 @@
                 int rc2 = RTLocalIpcSessionClose(hSession);
                 if (RT_FAILURE(rc2))
-                    LogFlowFunc(("Failed closing session %p, rc=%Rrc\n", pSession, rc2));
-
-                LogFlowFunc(("Failed to create thread for session %p, rc=%Rrc\n", pSession, rc));
+                    VBoxTrayError("IPC: Failed closing client session %#x with rc=%Rrc\n", hSession, rc2);
                 RTMemFree(pSession);
             }
@@ -557 +554 @@
 
     ASMAtomicWriteBool(&pSession->fTerminate, true);
+
+    VBoxTrayInfo("IPC: Stopping worker thread ...\n");
 
     RTLOCALIPCSESSION hSession;
@@ -567 +566 @@
 
 /**
- * Thread function to wait for and process seamless mode change
- * requests
+ * Thread worker for the IPC handling code.
  */
 DECLCALLBACK(int) vbtrIPCWorker(void *pvInstance, bool volatile *pfShutdown)
 {
-    AssertPtr(pvInstance);
-    LogFlowFunc(("pvInstance=%p\n", pvInstance));
-
-    LogFlowFuncEnter();
+    AssertPtrReturn(pvInstance, VERR_INVALID_PARAMETER);
+    LogFunc(("pvInstance=%p\n", pvInstance));
 
     /*
@@ -583 +579 @@
     RTThreadUserSignal(RTThreadSelf());
 
+    VBoxTrayInfo("IPC: Worker thread started\n");
+
     PVBOXIPCCONTEXT pCtx = (PVBOXIPCCONTEXT)pvInstance;
     AssertPtr(pCtx);
@@ -588 +586 @@
     int rc;
 
-    bool fShutdown = false;
     for (;;)
     {
@@ -597 +594 @@
             if (rc == VERR_CANCELLED)
             {
-                LogFlow(("Cancelled\n"));
-                fShutdown = true;
+                VBoxTrayInfo("IPC: Worker thread cancelled\n");
+                rc = VINF_SUCCESS;
+                break;
             }
             else
-                LogRelFunc(("Listening failed with rc=%Rrc\n", rc));
-        }
-
-        if (fShutdown)
-            break;
-        rc = vboxIPCSessionCreate(pCtx, hClientSession);
-        if (RT_FAILURE(rc))
-        {
-            LogRelFunc(("Creating new IPC server session failed with rc=%Rrc\n", rc));
-            /* Keep going. */
+                VBoxTrayError("IPC: Listening failed with rc=%Rrc\n", rc);
+        }
+        else
+        {
+            VBoxTrayVerbose(1, "IPC: New client connected with session %#x\n", hClientSession);
+
+            rc = vboxIPCSessionCreate(pCtx, hClientSession);
+            if (RT_FAILURE(rc))
+            {
+                VBoxTrayError("IPC: Creating session %#x failed with rc=%Rrc\n", hClientSession, rc);
+                /* Keep going. */
+            }
         }
 
         if (*pfShutdown)
             break;
-    }
-
-    LogFlowFuncLeaveRC(rc);
+
+        /* Back off a little to not hog the CPU too much. */
+        RTThreadSleep(100 /* ms */);
+    }
+
+    VBoxTrayInfo("IPC: Worker thread stopped with %Rrc\n", rc);
     return rc;
 }