Changeset 102929 in vbox for trunk/src

Timestamp:

Jan 17, 2024 3:30:48 PM (11 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Better documented for what headless mode is and why we need it; improved testing here and there a bit, so we have better coverage there.

Location:

trunk/src/VBox/GuestHost/SharedClipboard

Files:

• clipboard-x11.cpp (modified) (15 diffs)
• testcase/tstClipboardGH-X11.cpp (modified) (3 diffs)
• testcase/tstClipboardGH-X11Smoke.cpp (modified) (1 diff)

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

@@ -334 +334 @@
 
     Widget pWidget = pCtx->pWidget;
-    AssertPtrReturnVoid(pWidget);
+    if (!pWidget)
+        return;
 
     bool fFound = false;
@@ -1155 +1156 @@
 
 /**
+ * Helper function for public X11 Shared Clipboard APIs to know whether we're running in headless mode or not.
+ *
+ * Headless mode either could mean that we don't want to touch the X11 clipboard, or that X simply isn't installed and/or
+ * isn't available (e.g. running on a pure server installation w/o any desktop environment).
+ *
+ * Goal here is to make the X11 API transparent for the caller whether X is available or not.
+ *
+ * @returns \c true if running in headless mode, or \c false if not.
+ * @param   pCtx                The X11 clipboard context to use.
+ */
+DECLINLINE(bool) shClX11HeadlessIsEnabled(PSHCLX11CTX pCtx)
+{
+    return pCtx->fHeadless;
+}
+
+/**
  * Sets the callback table, internal version.
  *
@@ -1196 +1213 @@
     LogFlowFunc(("pCtx=%p\n", pCtx));
 
-    int rc = VINF_SUCCESS;
-
     RT_BZERO(pCtx, sizeof(SHCLX11CTX));
-
-    if (fHeadless)
-    {
-        /*
-         * If we don't find the DISPLAY environment variable we assume that
-         * we are not connected to an X11 server. Don't actually try to do
-         * this then, just fail silently and report success on every call.
-         * This is important for VBoxHeadless.
-         */
-        LogRel(("Shared Clipboard: X11 DISPLAY variable not set -- disabling clipboard sharing\n"));
-    }
 
     /* Init clipboard cache. */
@@ -1217 +1221 @@
     shClX11SetCallbacksInternal(pCtx, pCallbacks);
 
-    pCtx->fHaveX11       = !fHeadless;
+    pCtx->fHeadless      = fHeadless;
     pCtx->pFrontend      = pParent;
 
@@ -1225 +1229 @@
 #endif
 
+    int rc = VINF_SUCCESS;
+
+    LogRel(("Shared Clipboard: Initializing X11 clipboard (%s mode)\n", fHeadless ? "headless" : "regular"));
+
+    if (!pCtx->fHeadless)
+    {
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS_HTTP
-    ShClTransferHttpServerInit(&pCtx->HttpCtx.HttpServer);
+        rc = ShClTransferHttpServerInit(&pCtx->HttpCtx.HttpServer);
 #endif
 
 #ifdef TESTCASE
-    if (RT_SUCCESS(rc))
-    {
-        /** @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
+        {
+            /** @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
+    }
+
+    if (RT_FAILURE(rc))
+        LogRel(("Shared Clipboard: Initializing X11 clipboard failed with %Rrc\n", rc));
 
     LogFlowFuncLeaveRC(rc);
@@ -1246 +1260 @@
  * Destroys a Shared Clipboard X11 context.
  *
+ * @returns VBox status code.
  * @param   pCtx                The X11 clipboard context to destroy.
  */
-void ShClX11Destroy(PSHCLX11CTX pCtx)
+int ShClX11Destroy(PSHCLX11CTX pCtx)
 {
     if (!pCtx)
-        return;
+        return VINF_SUCCESS;
 
     LogFlowFunc(("pCtx=%p\n", pCtx));
@@ -1258 +1273 @@
     ShClCacheDestroy(&pCtx->Cache);
 
+    int rc = VINF_SUCCESS;
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS_HTTP
-    ShClTransferHttpServerDestroy(&pCtx->HttpCtx.HttpServer);
+    rc = ShClTransferHttpServerDestroy(&pCtx->HttpCtx.HttpServer);
 #endif
 
@@ -1268 +1284 @@
 #endif
 
-    if (pCtx->fHaveX11)
+    if (!shClX11HeadlessIsEnabled(pCtx))
     {
         /* 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->pWidget == NULL);
-    }
+        AssertStmt(pCtx->pWidget == NULL, rc = VERR_WRONG_ORDER);
+    }
+
+    return rc;
 }
 
@@ -1290 +1308 @@
     AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
 
-    /*
-     * Immediately return if we are not connected to the X server.
-     */
-    if (!pCtx->fHaveX11)
+    if (shClX11HeadlessIsEnabled(pCtx))
         return VINF_SUCCESS;
 
@@ -1376 +1391 @@
 int ShClX11ThreadStop(PSHCLX11CTX pCtx)
 {
-    int rc;
-    /*
-     * Immediately return if we are not connected to the X server.
-     */
-    if (!pCtx->fHaveX11)
+    if (shClX11HeadlessIsEnabled(pCtx))
         return VINF_SUCCESS;
 
@@ -1386 +1397 @@
 
     /* Write to the "stop" pipe. */
-    rc = clipThreadScheduleCall(pCtx, clipThreadSignalStop, (XtPointer)pCtx);
+    int rc = clipThreadScheduleCall(pCtx, clipThreadSignalStop, (XtPointer)pCtx);
     if (RT_FAILURE(rc))
     {
@@ -1985 +1996 @@
 int ShClX11ReportFormatsToX11Async(PSHCLX11CTX pCtx, SHCLFORMATS uFormats)
 {
-    /*
-     * Immediately return if we are not connected to the X server.
-     */
-    if (!pCtx->fHaveX11)
+    if (shClX11HeadlessIsEnabled(pCtx))
         return VINF_SUCCESS;
 
@@ -2632 +2640 @@
 {
     AssertPtrReturn(pEvent, VERR_INVALID_POINTER);
-    /*
-     * Immediately return if we are not connected to the X server.
-     */
-    if (!pCtx->fHaveX11)
+
+    if (shClX11HeadlessIsEnabled(pCtx))
         return VINF_SUCCESS;
 
@@ -2683 +2689 @@
     AssertReturn(cbBuf, VERR_INVALID_PARAMETER);
     /* pcbRead is optional. */
+
+    if (shClX11HeadlessIsEnabled(pCtx))
+    {
+        if (pcbRead)
+            *pcbRead = 0;
+        return VINF_SUCCESS;
+    }
 
     PSHCLEVENT pEvent;
@@ -2750 +2763 @@
     /* pEvent not used yet. */ RT_NOREF(pEvent);
 
-    /*
-     * Immediately return if we are not connected to the X server.
-     */
-    if (!pCtx->fHaveX11)
+    if (shClX11HeadlessIsEnabled(pCtx))
         return VINF_SUCCESS;
 

trunk/src/VBox/GuestHost/SharedClipboard/testcase/tstClipboardGH-X11.cpp

@@ -589 +589 @@
         RTTestFailureDetails(hTest, "Conversion to %s, expected \"%s\"\n",
                              pcszTarget, valueExp);
-}
-
-static void tstNoX11(PSHCLX11CTX pCtx, const char *pcszTestCtx)
-{
-    uint32_t cbActual = 0;
-    uint8_t  abBuf[TESTCASE_MAX_BUF_SIZE];
-    int rc = ShClX11ReadDataFromX11(pCtx, &g_EventSource, g_msTimeout, VBOX_SHCL_FMT_UNICODETEXT, abBuf, sizeof(abBuf), &cbActual);
-    RTTESTI_CHECK_MSG(rc == VERR_NO_DATA, ("context: %s\n", pcszTestCtx));
 }
 
@@ -878 +870 @@
      * Headless clipboard tests
      */
-    rc = ShClX11Init(&X11Ctx, &Callbacks, NULL /* pParent */, true /* fHeadless */);
-    AssertRCReturn(rc, RTEXITCODE_FAILURE);
+    RTTEST_CHECK_RC_OK(hTest, ShClX11Init(&X11Ctx, &Callbacks, NULL /* pParent */, true /* fHeadless */));
 
     /* Read from X11 */
     RTTestSub(hTest, "reading from X11, headless clipboard");
+
     /* Simple test */
-    tstClipSetVBoxUtf16(&X11Ctx, VINF_SUCCESS, "",
-                        sizeof("") * 2);
-    tstClipSetSelectionValues("UTF8_STRING", XA_STRING, "hello world",
-                              sizeof("hello world"), 8);
-    tstNoX11(&X11Ctx, "reading from X11, headless clipboard");
+    tstClipSetVBoxUtf16(&X11Ctx, VINF_SUCCESS, "", sizeof("") * 2);
+    tstClipSetSelectionValues("UTF8_STRING", XA_STRING, "hello world", sizeof("hello world"), 8);
+    rc = ShClX11ReadDataFromX11(&X11Ctx, &g_EventSource, g_msTimeout, VBOX_SHCL_FMT_UNICODETEXT, abBuf, sizeof(abBuf), &cbActual);
+    RTTESTI_CHECK_MSG(cbActual == 0, ("expected 0 but got %RU32\n", cbActual));
+    RTTESTI_CHECK_MSG(rc == VINF_SUCCESS, ("expected VINF_SUCCESS but got %Rrc, context: %s\n", rc));
 
     /* Read from VBox */
     RTTestSub(hTest, "reading from VBox, headless clipboard");
+
     /* Simple test */
     tstClipEmptyVBox(&X11Ctx, VERR_WRONG_ORDER);
@@ -899 +892 @@
     tstNoSelectionOwnership(&X11Ctx, "reading from VBox, headless clipboard");
 
-    ShClX11Destroy(&X11Ctx);
+    RTTEST_CHECK_RC_OK(hTest, ShClX11Destroy(&X11Ctx));
     ShClEventSourceDestroy(&g_EventSource);
 

trunk/src/VBox/GuestHost/SharedClipboard/testcase/tstClipboardGH-X11Smoke.cpp

@@ -90 +90 @@
 
     SHCLX11CTX X11Ctx;
-    rc = ShClX11Init(&X11Ctx, &Callbacks, NULL /* pParent */, false);
-    AssertRCReturn(rc, 1);
-    rc = ShClX11ThreadStart(&X11Ctx, false /* fGrab */);
-    AssertRCReturn(rc, 1);
+    RTTEST_CHECK_RC_OK(hTest, ShClX11Init(&X11Ctx, &Callbacks, NULL /* pParent */, false /* fHeadless */));
+    RTTEST_CHECK_RC_OK(hTest, ShClX11ThreadStart(&X11Ctx, false /* fGrab */));
+
     /* Give the clipboard time to synchronise. */
     RTThreadSleep(500);
-    rc = ShClX11ThreadStop(&X11Ctx);
-    AssertRCReturn(rc, 1);
-    ShClX11Destroy(&X11Ctx);
+
+    RTTEST_CHECK_RC_OK(hTest, ShClX11ThreadStop(&X11Ctx));
+    RTTEST_CHECK_RC_OK(hTest, ShClX11Destroy(&X11Ctx));
+
     return RTTestSummaryAndDestroy(hTest);
 }