Changeset 100538 in vbox for trunk/src/VBox

Timestamp:

Jul 12, 2023 8:53:20 AM (20 months ago)

Author:

vboxsync

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

158349

Message:

Shared Clipboard: Use a dedicated worker thread wrapper for transfer threads, so that we have more control for the thread creation / destruction. bugref:9437

Location:

trunk/src/VBox/GuestHost/SharedClipboard

Files:

• ClipboardDataObjectImpl-win.cpp (modified) (1 diff)
• clipboard-transfers.cpp (modified) (7 diffs)

trunk/src/VBox/GuestHost/SharedClipboard/ClipboardDataObjectImpl-win.cpp

@@ -465 +465 @@
  */
 /* static */
-DECLCALLBACK(int) SharedClipboardWinDataObject::readThread(RTTHREAD ThreadSelf, void *pvUser)
-{
-    RT_NOREF(ThreadSelf);
+DECLCALLBACK(int) SharedClipboardWinDataObject::readThread(PSHCLTRANSFER pTransfer, void *pvUser)
+{
+    RT_NOREF(pTransfer);
 
     LogFlowFuncEnter();
 
     SharedClipboardWinDataObject *pThis = (SharedClipboardWinDataObject *)pvUser;
-
-    PSHCLTRANSFER pTransfer = pThis->m_pTransfer;
-    AssertPtr(pTransfer);
-
-    pTransfer->Thread.fStarted = true;
-    pTransfer->Thread.fStop    = false;
-
-    RTThreadUserSignal(RTThreadSelf());
 
     LogRel2(("Shared Clipboard: Calculating transfer ...\n"));

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

@@ -54 +54 @@
 static void shClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks);
 static int shClTransferSetStatus(PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS enmStatus);
-static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser);
+static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser);
 static int shClTransferThreadDestroy(PSHCLTRANSFER pTransfer, RTMSINTERVAL uTimeoutMs);
 
@@ -2111 +2111 @@
  * @param   pvUser              Pointer to user-provided data. Optional.
  */
-int ShClTransferRun(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser)
+int ShClTransferRun(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser)
 {
     AssertPtrReturn(pTransfer,     VERR_INVALID_POINTER);
@@ -2161 +2161 @@
 
 /**
+ * Internal struct for keeping a transfer thread context.
+ */
+typedef struct _SHCLTRANSFERTHREADCTX
+{
+    /** Pointer to transfer. */
+    PSHCLTRANSFER         pTransfer;
+    /** User-supplied context data. Can be NULL if not being used. */
+    void                 *pvUser;
+    /** Pointer to thread function to use. */
+    PFNSHCLTRANSFERTHREAD pfnThread;
+} SHCLTRANSFERTHREADCTX;
+/** Pointer to internal struct for keeping a transfer thread context. */
+typedef SHCLTRANSFERTHREADCTX *PSHCLTRANSFERTHREADCTX;
+
+/**
+ * Worker thread for a transfer.
+ *
+ * @returns VBox status code.
+ * @param   ThreadSelf          Thread self handle. Not being used.
+ * @param   pvUser              Context data of type PSHCLTRANSFERTHREADCTX.
+ */
+static DECLCALLBACK(int) shClTransferThreadWorker(RTTHREAD ThreadSelf, void *pvUser)
+{
+    RT_NOREF(ThreadSelf);
+
+    LogFlowFuncEnter();
+
+    PSHCLTRANSFERTHREADCTX pCtx      = (PSHCLTRANSFERTHREADCTX)pvUser;
+    PSHCLTRANSFER          pTransfer = pCtx->pTransfer;
+
+    shClTransferLock(pTransfer);
+
+    pTransfer->Thread.fStarted = true;
+    pTransfer->Thread.fStop    = false;
+
+    shClTransferUnlock(pTransfer);
+
+    RTThreadUserSignal(RTThreadSelf());
+
+    int rc = pCtx->pfnThread(pTransfer, pCtx->pvUser);
+
+    if (pTransfer->Callbacks.pfnOnCompleted)
+        pTransfer->Callbacks.pfnOnCompleted(&pTransfer->CallbackCtx, rc);
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+/**
  * Creates a thread for a clipboard transfer.
  *
@@ -2168 +2217 @@
  * @param   pvUser              Pointer to user-provided data.
  */
-static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser)
+static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNSHCLTRANSFERTHREAD pfnThreadFunc, void *pvUser)
 
 {
@@ -2182 +2231 @@
                     ("Transfer thread already started"), VERR_WRONG_ORDER);
 
+    SHCLTRANSFERTHREADCTX Ctx = { pTransfer, pvUser, pfnThreadFunc };
+
     /* Spawn a worker thread, so that we don't block the window thread for too long. */
-    int rc = RTThreadCreate(&pTransfer->Thread.hThread, pfnThreadFunc,
-                            pvUser, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
+    int rc = RTThreadCreate(&pTransfer->Thread.hThread, shClTransferThreadWorker,
+                            &Ctx, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
                             "shclptx");
     if (RT_SUCCESS(rc))
@@ -2214 +2265 @@
  * @returns VBox status code.
  * @param   pTransfer           Clipboard transfer to destroy thread for.
- * @param   uTimeoutMs          Timeout (in ms) to wait for thread creation.
+ * @param   uTimeoutMs          Timeout (in ms) to wait for thread destruction.
  */
 static int shClTransferThreadDestroy(PSHCLTRANSFER pTransfer, RTMSINTERVAL uTimeoutMs)
@@ -2235 +2286 @@
     shClTransferUnlock(pTransfer); /* Leave lock while waiting. */
 
-    int rcThread = VERR_WRONG_ORDER;
+    int rcThread = VERR_IPE_UNINITIALIZED_STATUS;
     int rc = RTThreadWait(pTransfer->Thread.hThread, uTimeoutMs, &rcThread);