Changeset 86871 in vbox for trunk/src/VBox/Additions/x11/VBoxClient/clipboard.cpp

Timestamp:

Nov 12, 2020 10:15:18 AM (4 years ago)

Author:

vboxsync

Message:

Additions/VBoxClient: Big revamp of the internal service handling and termination fixes. A service now runs as part of a worker thread, while the main thread is used for initialization / shutdown and signal handling.

File:

• trunk/src/VBox/Additions/x11/VBoxClient/clipboard.cpp (modified) (12 diffs)

trunk/src/VBox/Additions/x11/VBoxClient/clipboard.cpp

@@ -58 +58 @@
 
 /**
- * Global clipboard context information.
+ * Struct keeping a Shared Clipboard context.
  */
 struct SHCLCONTEXT
@@ -75 +75 @@
 };
 
-/** Only one client is supported. There seems to be no need for more clients. */
+/** Only one context is supported at a time for now. */
 static SHCLCONTEXT g_Ctx;
 
@@ -258 +258 @@
 int vboxClipboardMain(void)
 {
-    LogRel(("Worker loop running\n"));
-
     int rc;
 
@@ -331 +329 @@
                 case VBGLR3CLIPBOARDEVENTTYPE_QUIT:
                 {
-                    LogRel2(("Host requested termination\n"));
+                    VBClLogVerbose(2, "Host requested termination\n");
                     fShutdown = true;
                     break;
@@ -368 +366 @@
     }
 
-    LogRel(("Worker loop ended\n"));
-
     LogFlowFuncLeaveRC(rc);
     return rc;
@@ -377 +373 @@
 static DECLCALLBACK(int) vboxClipoardFUSEThread(RTTHREAD hThreadSelf, void *pvUser)
 {
-    RT_NOREF(hThreadSelf, pvUser);
+    RT_NOREF(pvUser);
 
     VbglR3Init();
@@ -409 +405 @@
     }
     else
-        LogRel(("Error creating FUSE mount directory, rc=%Rrc\n", rc));
-
-    LogFlowFuncLeaveRC(rc);
-    return rc;
-}
-
-static int vboxClipboardFUSEStart()
+        VBClLogError("Error creating FUSE mount directory, rc=%Rrc\n", rc);
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+static int vboxClipboardFUSEStart(void)
 {
     LogFlowFuncEnter();
@@ -430 +426 @@
 }
 
-static int vboxClipboardFUSEStop()
+static int vboxClipboardFUSEStop(void)
 {
     LogFlowFuncEnter();
@@ -444 +440 @@
 #endif /* VBOX_WITH_SHARED_CLIPBOARD_FUSE */
 
-static const char *getName()
-{
-    return "Shared Clipboard";
-}
-
-static const char *getPidFilePath()
-{
-    return ".vboxclient-clipboard.pid";
-}
-
-static int init(struct VBCLSERVICE **pSelf)
-{
-    RT_NOREF(pSelf);
-
+/** @copydoc VBCLSERVICE::pfnInit */
+static int vbclShClInit(void)
+{
     int rc;
 
@@ -470 +455 @@
 }
 
-static int run(struct VBCLSERVICE **ppInterface, bool fDaemonised)
-{
-    RT_NOREF(ppInterface, fDaemonised);
+/** @copydoc VBCLSERVICE::pfnWorker */
+static int vbclShClWorker(bool volatile *pfShutdown)
+{
+    RT_NOREF(pfShutdown);
 
     /* Initialise the guest library. */
@@ -483 +469 @@
         {
 #endif
+            /* Let the main thread know that it can continue spawning services. */
+            RTThreadUserSignal(RTThreadSelf());
+
             rc = vboxClipboardMain();
 
@@ -502 +491 @@
 }
 
-static void cleanup(struct VBCLSERVICE **ppInterface)
-{
-    RT_NOREF(ppInterface);
-
+/** @copydoc VBCLSERVICE::pfnStop */
+static void vbclShClStop(void)
+{
+    /* Disconnect from the host service.
+     * This will also send a VBOX_SHCL_HOST_MSG_QUIT from the host so that we can break out from our message worker. */
+    VbglR3ClipboardDisconnect(g_Ctx.CmdCtx.idClient);
+    g_Ctx.CmdCtx.idClient = 0;
+}
+
+/** @copydoc VBCLSERVICE::pfnTerm */
+static int vbclShClTerm(void)
+{
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
     ShClTransferCtxDestroy(&g_Ctx.TransferCtx);
 #endif
-}
-
-struct VBCLSERVICE vbclClipboardInterface =
-{
-    getName,
-    getPidFilePath,
-    init,
-    run,
-    cleanup
+
+    return VINF_SUCCESS;
+}
+
+VBCLSERVICE g_SvcClipboard =
+{
+    "shcl",                      /* szName */
+    "Shared Clipboard",          /* pszDescription */
+    ".vboxclient-clipboard.pid", /* pszPidFilePath */
+    NULL,                        /* pszUsage */
+    NULL,                        /* pszOptions */
+    NULL,                        /* pfnOption */
+    vbclShClInit,                /* pfnInit */
+    vbclShClWorker,              /* pfnWorker */
+    vbclShClStop,                /* pfnStop*/
+    vbclShClTerm                 /* pfnTerm */
 };
 
-struct CLIPBOARDSERVICE
-{
-    struct VBCLSERVICE *pInterface;
-};
-
-struct VBCLSERVICE **VBClGetClipboardService(void)
-{
-    struct CLIPBOARDSERVICE *pService =
-        (struct CLIPBOARDSERVICE *)RTMemAlloc(sizeof(*pService));
-
-    if (!pService)
-        VBClLogFatalError("Out of memory\n");
-    pService->pInterface = &vbclClipboardInterface;
-    return &pService->pInterface;
-}