Changeset 18756 in vbox

Timestamp:

Apr 6, 2009 1:53:45 PM (16 years ago)

Author:

vboxsync

Message:

HostServices/SharedClipboard: a couple of fixes and some assertions

Location:

trunk/src/VBox

Files:

• GuestHost/SharedClipboard/x11-clipboard.cpp (modified) (5 diffs)
• HostServices/SharedClipboard/x11-clipboard.cpp (modified) (2 diffs)

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

@@ -762 +762 @@
         return;
 
+    /* We set this to NULL when the event thread exits.  It really should
+     * have exited at this point, when we are about to unload the code from
+     * memory. */
+    Assert(pCtx->widget == NULL);
     RTSemEventDestroy(pCtx->waitForData);
 }
@@ -823 +827 @@
  * Shut down the shared clipboard X11 backend.
  * @note  X11 backend code
+ * @note  Any requests from this object to get clipboard data from VBox
+ *        *must* have completed or aborted before we are called, as
+ *        otherwise the X11 event loop will still be waiting for the request
+ *        to return and will not be able to terminate.
  */
 int VBoxX11ClipboardStopX11(VBOXCLIPBOARDCONTEXTX11 *pCtx)
@@ -835 +843 @@
         return VINF_SUCCESS;
 
+    /* This might mean that we are getting stopped twice. */
+    AssertReturn(pCtx->widget != NULL, VERR_WRONG_ORDER);
     pCtx->eOwner = NONE;
     pCtx->X11TextFormat = INVALID;
@@ -840 +850 @@
     LogRelFunc(("stopping the shared clipboard X11 backend\n"));
 
-    /* Set the termination flag.  This has been observed to block if it was set
-     * during a request for clipboard data coming from X11, so only we do it
-     * after releasing any such requests. */
+    /* Set the termination flag to tell the Xt event loop to exit.  We
+     * reiterate that any outstanding requests from the X11 event loop to
+     * the VBox part *must* have returned before we do this. */
     XtAppSetExitFlag(pCtx->appContext);
     /* Wake up the event loop */
@@ -861 +871 @@
         LogRelFunc(("rc=%Rrc\n", rc));
     XtCloseDisplay(XtDisplay(pCtx->widget));
+    pCtx->widget = NULL;  /* For sanity assertions. */
     LogFlowFunc(("returning %Rrc.\n", rc));
     return rc;

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

@@ -185 +185 @@
     int rc = VINF_SUCCESS;
     LogRelFunc(("shutting down host clipboard\n"));
+    VBoxX11ClipboardDestructX11(g_ctxHost.pBackend);
+    /* We can safely destroy these as the backend has exited
+     * successfully and no other calls from the host code should be
+     * forthcoming. */
+    RTSemEventDestroy(g_ctxHost.waitForData);
+    RTSemMutexDestroy(g_ctxHost.clipboardMutex);
+}
+
+/**
+ * Connect a guest to the shared clipboard.
+ * @note  host glue code
+ * @note  on the host, we assume that some other application already owns
+ *        the clipboard and leave ownership to X11.
+ */
+int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient)
+{
+    int rc = VINF_SUCCESS;
+    LogFlowFunc(("\n"));
+    /* Only one client is supported for now */
+    AssertLogRelReturn(g_ctxHost.pClient == 0, VERR_NOT_SUPPORTED);
+    pClient->pCtx = &g_ctxHost;
+    pClient->pCtx->pClient = pClient;
+    /** The pClient pointer is a dummy anyway, as we only support a single
+     * client at a time. */
+    rc = VBoxX11ClipboardStartX11(g_ctxHost.pBackend,
+                                  true /* fOwnClipboard */);
+    return rc;
+}
+
+/**
+ * Synchronise the contents of the host clipboard with the guest, called
+ * after a save and restore of the guest.
+ * @note  Host glue code
+ */
+int vboxClipboardSync (VBOXCLIPBOARDCLIENTDATA *pClient)
+{
+
+    /* On a Linux host, the guest should never synchronise/cache its
+     * clipboard contents, as we have no way of reliably telling when the
+     * host clipboard data changes.  So instead of synchronising, we tell
+     * the guest to empty its clipboard, and we set the cached flag so that
+     * we report formats to the guest next time we poll for them. */
+    /** @note  This has been changed so that the message is sent even if
+     *         X11 is not available. */
+    vboxSvcClipboardReportMsg (g_ctxHost.pClient,
+                               VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS, 0);
+    VBoxX11ClipboardRequestSyncX11(g_ctxHost.pBackend);
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * Shut down the shared clipboard service and "disconnect" the guest.
+ * @note  Host glue code
+ */
+void vboxClipboardDisconnect (VBOXCLIPBOARDCLIENTDATA *)
+{
+    LogFlow(("vboxClipboardDisconnect\n"));
+
+    RTSemMutexRequest(g_ctxHost.clipboardMutex, RT_INDEFINITE_WAIT);
     /* Drop the reference to the client, in case it is still there.  This
      * will cause any outstanding clipboard data requests from X11 to fail
@@ -199 +259 @@
      *         even if we are not waiting. */
     RTSemEventSignal(g_ctxHost.waitForData);
-    VBoxX11ClipboardDestructX11(g_ctxHost.pBackend);
-    /* We can safely destroy these as the backend has exited
-     * successfully and no other calls from the host code should be
-     * forthcoming. */
-    RTSemEventDestroy(g_ctxHost.waitForData);
-    RTSemMutexDestroy(g_ctxHost.clipboardMutex);
-}
-
-/**
- * Connect a guest to the shared clipboard.
- * @note  host glue code
- * @note  on the host, we assume that some other application already owns
- *        the clipboard and leave ownership to X11.
- */
-int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient)
-{
-    int rc = VINF_SUCCESS;
-    LogFlowFunc(("\n"));
-    /* Only one client is supported for now */
-    AssertLogRelReturn(g_ctxHost.pClient == 0, VERR_NOT_SUPPORTED);
-    pClient->pCtx = &g_ctxHost;
-    pClient->pCtx->pClient = pClient;
-    /** The pClient pointer is a dummy anyway, as we only support a single
-     * client at a time. */
-    rc = VBoxX11ClipboardStartX11(g_ctxHost.pBackend,
-                                  true /* fOwnClipboard */);
-    return rc;
-}
-
-/**
- * Synchronise the contents of the host clipboard with the guest, called
- * after a save and restore of the guest.
- * @note  Host glue code
- */
-int vboxClipboardSync (VBOXCLIPBOARDCLIENTDATA *pClient)
-{
-
-    /* On a Linux host, the guest should never synchronise/cache its
-     * clipboard contents, as we have no way of reliably telling when the
-     * host clipboard data changes.  So instead of synchronising, we tell
-     * the guest to empty its clipboard, and we set the cached flag so that
-     * we report formats to the guest next time we poll for them. */
-    /** @note  This has been changed so that the message is sent even if
-     *         X11 is not available. */
-    vboxSvcClipboardReportMsg (g_ctxHost.pClient,
-                               VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS, 0);
-    VBoxX11ClipboardRequestSyncX11(g_ctxHost.pBackend);
-
-    return VINF_SUCCESS;
-}
-
-/**
- * Shut down the shared clipboard service and "disconnect" the guest.
- * @note  Host glue code
- */
-void vboxClipboardDisconnect (VBOXCLIPBOARDCLIENTDATA *)
-{
-    LogFlow(("vboxClipboardDisconnect\n"));
-
-    RTSemMutexRequest(g_ctxHost.clipboardMutex, RT_INDEFINITE_WAIT);
-    g_ctxHost.pClient = NULL;
+    int rc = VBoxX11ClipboardStopX11(g_ctxHost.pBackend);
     /** @todo handle this slightly more reasonably, or be really sure
      *        it won't go wrong. */
-    AssertRC(VBoxX11ClipboardStopX11(g_ctxHost.pBackend));
+    AssertRC(rc);
     RTSemMutexRelease(g_ctxHost.clipboardMutex);
 }