Changeset 86717 in vbox for trunk/src/VBox/GuestHost/SharedClipboard

Timestamp:

Oct 27, 2020 9:10:35 AM (4 years ago)

Author:

vboxsync

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

141102

Message:

Shared Clipboard/X11: More work on untangling / cleaning up the threading code. bugref:9848

File:

• trunk/src/VBox/GuestHost/SharedClipboard/clipboard-x11.cpp (modified) (13 diffs)

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-x11.cpp

@@ -405 +405 @@
 
 #ifndef TESTCASE
-    XtAppAddTimeOut(pCtx->appContext, 0, (XtTimerCallbackProc)proc,
+    XtAppAddTimeOut(pCtx->pAppContext, 0, (XtTimerCallbackProc)proc,
                     (XtPointer)client_data);
     ssize_t cbWritten = write(pCtx->wakeupPipeWrite, WAKE_UP_STRING, WAKE_UP_STRING_LEN);
@@ -824 +824 @@
     } event = { { 0 } };
 
-    if (XtAppPeekEvent(pCtx->appContext, &event.event))
+    if (XtAppPeekEvent(pCtx->pAppContext, &event.event))
     {
         if (   (event.event.type == pCtx->fixesEventBase)
@@ -847 +847 @@
 static DECLCALLBACK(int) clipThreadMain(RTTHREAD hThreadSelf, void *pvUser)
 {
-    RT_NOREF(hThreadSelf);
-    AssertPtrReturn(pvUser, VERR_INVALID_POINTER);
-
-    LogRel2(("Shared Clipboard: Starting X11 event thread\n"));
-
-    PSHCLX11CTX pCtx = (SHCLX11CTX *)pvUser;
-
-    clipInitInternal(pCtx);
-
-    if (pCtx->fGrabClipboardOnStart)
-        clipQueryX11Formats(pCtx);
-
-    /* We're now ready to run, tell parent. */
-    int rc2 = RTThreadUserSignal(hThreadSelf);
-    AssertRC(rc2);
-
-    while (XtAppGetExitFlag(pCtx->appContext) == FALSE)
-    {
-        clipPeekEventAndDoXFixesHandling(pCtx);
-        XtAppProcessEvent(pCtx->appContext, XtIMAll);
-    }
-
-    clipUninitInternal(pCtx);
-
-    LogRel2(("Shared Clipboard: X11 event thread terminated successfully\n"));
-    return VINF_SUCCESS;
+    PSHCLX11CTX pCtx = (PSHCLX11CTX)pvUser;
+    AssertPtr(pCtx);
+
+    LogFlowFunc(("pCtx=%p\n", pCtx));
+
+    bool fSignalled = false; /* Whether we have signalled the parent already or not. */
+
+    int rc = clipInitInternal(pCtx);
+    if (RT_SUCCESS(rc))
+    {
+        rc = clipRegisterContext(pCtx);
+        if (RT_SUCCESS(rc))
+        {
+            if (pCtx->fGrabClipboardOnStart)
+                clipQueryX11Formats(pCtx);
+
+            pCtx->fThreadStarted = true;
+
+            /* We're now ready to run, tell parent. */
+            int rc2 = RTThreadUserSignal(hThreadSelf);
+            AssertRC(rc2);
+
+            fSignalled = true;
+
+            while (XtAppGetExitFlag(pCtx->pAppContext) == FALSE)
+            {
+                clipPeekEventAndDoXFixesHandling(pCtx);
+                XtAppProcessEvent(pCtx->pAppContext, XtIMAll);
+            }
+
+            clipUnregisterContext(pCtx);
+        }
+
+        clipUninitInternal(pCtx);
+    }
+
+    if (!fSignalled) /* Signal parent if we didn't do so yet. */
+    {
+        int rc2 = RTThreadUserSignal(hThreadSelf);
+        AssertRC(rc2);
+    }
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
 }
 
@@ -891 +909 @@
      * reiterate that any outstanding requests from the X11 event loop to
      * the VBox part *must* have returned before we do this. */
-    XtAppSetExitFlag(pCtx->appContext);
+    XtAppSetExitFlag(pCtx->pAppContext);
 }
 
@@ -990 +1008 @@
     int rc = VINF_SUCCESS;
 
-    Assert(pCtx->appContext == NULL); /* No nested initialization. */
-    pCtx->appContext = XtCreateApplicationContext();
-    if (pCtx->appContext == NULL)
+    Assert(pCtx->pAppContext == NULL); /* No nested initialization. */
+    pCtx->pAppContext = XtCreateApplicationContext();
+    if (pCtx->pAppContext == NULL)
     {
         LogRel(("Shared Clipboard: Failed to create Xt application context\n"));
@@ -1001 +1019 @@
     int      cArgc  = 0;
     char    *pcArgv = 0;
-    Display *pDisplay = XtOpenDisplay(pCtx->appContext, 0, 0, "VBoxShCl", 0, 0, &cArgc, &pcArgv);
+    Display *pDisplay = XtOpenDisplay(pCtx->pAppContext, 0, 0, "VBoxShCl", 0, 0, &cArgc, &pcArgv);
     if (pDisplay == NULL)
     {
@@ -1025 +1043 @@
         if (pCtx->pWidget == NULL)
         {
-            LogRel(("Shared Clipboard: Failed to construct the X11 window\n"));
+            LogRel(("Shared Clipboard: Failed to create Xt app shell\n"));
             rc = VERR_NO_MEMORY; /** @todo r=andy Improve this. */
         }
         else
-            rc = clipRegisterContext(pCtx);
+        {
+#ifndef TESTCASE
+            if (!XtAppAddInput(pCtx->pAppContext, pCtx->wakeupPipeRead,
+                               (XtPointer) XtInputReadMask,
+                               clipThreadDrainWakeupPipe, (XtPointer) pCtx))
+            {
+                LogRel(("Shared Clipboard: Failed to add input to Xt app context\n"));
+                rc = VERR_ACCESS_DENIED; /** @todo r=andy Improve this. */
+            }
+#endif
+        }
     }
 
@@ -1071 +1099 @@
     {
         /* Valid widget + invalid appcontext = bug.  But don't return yet. */
-        AssertPtr(pCtx->appContext);
-        clipUnregisterContext(pCtx);
+        AssertPtr(pCtx->pAppContext);
 
         XtDestroyWidget(pCtx->pWidget);
@@ -1078 +1105 @@
     }
 
-    if (pCtx->appContext)
-    {
-        XtDestroyApplicationContext(pCtx->appContext);
-        pCtx->appContext = NULL;
+    if (pCtx->pAppContext)
+    {
+        XtDestroyApplicationContext(pCtx->pAppContext);
+        pCtx->pAppContext = NULL;
     }
 
@@ -1133 +1160 @@
         /** @todo The testcases currently do not utilize the threading code. So init stuff here. */
         rc = clipInitInternal(pCtx);
+        if (RT_SUCCESS(rc))
+            rc = clipRegisterContext(pCtx);
     }
 #endif
@@ -1155 +1184 @@
     /** @todo The testcases currently do not utilize the threading code. So uninit stuff here. */
     clipUninitInternal(pCtx);
+    clipUnregisterContext(pCtx);
 #endif
 
@@ -1197 +1227 @@
     if (!pipe(pipes))
     {
-        pCtx->wakeupPipeRead = pipes[0];
+        pCtx->wakeupPipeRead  = pipes[0];
         pCtx->wakeupPipeWrite = pipes[1];
-        if (!XtAppAddInput(pCtx->appContext, pCtx->wakeupPipeRead,
-                           (XtPointer) XtInputReadMask,
-                           clipThreadDrainWakeupPipe, (XtPointer) pCtx))
-            rc = VERR_NO_MEMORY;  /* What failure means is not doc'ed. */
-        if (   RT_SUCCESS(rc)
-            && (fcntl(pCtx->wakeupPipeRead, F_SETFL, O_NONBLOCK) != 0))
+
+        if (!fcntl(pCtx->wakeupPipeRead, F_SETFL, O_NONBLOCK))
+        {
+            rc = VINF_SUCCESS;
+        }
+        else
             rc = RTErrConvertFromErrno(errno);
-        if (RT_FAILURE(rc))
-            LogRel(("Shared Clipboard: Failed to setup the termination mechanism\n"));
     }
     else
@@ -1227 +1255 @@
         }
         else
-            LogRel2(("Shared Clipboard: X11 event thread started\n"));
+        {
+            if (!pCtx->fThreadStarted)
+            {
+                LogRel(("Shared Clipboard: X11 event thread reported an error while starting\n"));
+            }
+            else
+                LogRel2(("Shared Clipboard: X11 event thread started\n"));
+        }
     }