Changeset 100619 in vbox

Timestamp:

Jul 18, 2023 8:06:24 AM (20 months ago)

Author:

vboxsync

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

158450

Message:

Shared Clipboard: Made the Main host service dispatcher a bit more flexible so that it returns VERR_NOT_SUPPORTED if certain commands are not being handled. See comment(s) for details. bugref:9437

Location:

trunk/src/VBox

Files:

• HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h (modified) (1 diff)
• HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp (modified) (3 diffs)
• Main/src-client/GuestShClPrivate.cpp (modified) (4 diffs)

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h

@@ -265 +265 @@
 typedef struct _SHCLEXTSTATE
 {
-    /** Pointer to the actual service extension handle. */
+    /** Pointer to the actual service extension handle.
+     *
+     * Must return VERR_NOT_SUPPORTED if the extension didn't handle the requested function.
+     * This will invoke the regular backend then.
+     */
     PFNHGCMSVCEXT  pfnExtension;
     /** Opaque pointer to extension-provided data. Don't touch. */

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp

@@ -1617 +1617 @@
                 SHCLEXTPARMS parms;
                 RT_ZERO(parms);
+
                 parms.u.ReportFormats.uFormats = fFormats;
 
-                g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE, &parms, sizeof(parms));
+                rc = g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_FORMAT_ANNOUNCE, &parms, sizeof(parms));
             }
             else
+                rc = VERR_NOT_SUPPORTED;
+
+            /* Let the backend implementation know if the extension above didn't handle the format(s). */
+            if (rc == VERR_NOT_SUPPORTED)
             {
 #ifdef LOG_ENABLED
@@ -1783 +1788 @@
     }
     else
+        rc = VERR_NOT_SUPPORTED;
+
+    /* Try reading from the backend if the extension above didn't handle the read. */
+    if (rc == VERR_NOT_SUPPORTED)
     {
         rc = ShClBackendReadData(&g_ShClBackend, pClient, &cmdCtx, uFormat, pvData, cbData, &cbActual);
@@ -1949 +1958 @@
         SHCLEXTPARMS parms;
         RT_ZERO(parms);
+
         parms.u.ReadWriteData.uFormat = uFormat;
         parms.u.ReadWriteData.pvData  = pvData;
         parms.u.ReadWriteData.cbData  = cbData;
 
-        g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_DATA_WRITE, &parms, sizeof(parms));
-        rc = VINF_SUCCESS;
+        rc = g_ExtState.pfnExtension(g_ExtState.pvExtension, VBOX_CLIPBOARD_EXT_FN_DATA_WRITE, &parms, sizeof(parms));
     }
     else
-    {
-        /* Let the backend implementation know. */
+        rc = VERR_NOT_SUPPORTED;
+
+    /* Let the backend implementation know if the extension above didn't handle the write. */
+    if (rc == VERR_NOT_SUPPORTED)
+    {
         rc = ShClBackendWriteData(&g_ShClBackend, pClient, &cmdCtx, uFormat, pvData, cbData);
         if (RT_FAILURE(rc))

trunk/src/VBox/Main/src-client/GuestShClPrivate.cpp

@@ -221 +221 @@
  *
  * @returns VBox status code.
+ * @retval  VERR_NOT_SUPPORTED if the extension didn't handle the requested function. This will invoke the regular backend then.
  * @param   pvExtension         Pointer to service extension.
  * @param   u32Function         Callback HGCM message ID.
@@ -239 +240 @@
     /* pParms might be NULL, depending on the message. */
 
-    int vrc = VINF_SUCCESS;
+    int vrc;
 
     switch (u32Function)
@@ -250 +251 @@
 
         default:
+            vrc = VERR_NOT_SUPPORTED;
             break;
     }
@@ -255 +257 @@
     PSHCLSVCEXT const pExt = &pThis->m_SvcExtVRDP; /* Currently we have one extension only. */
 
-    if (pExt->pfnExt)
-    {
-        int vrc2 = pExt->pfnExt(pExt->pvExt, u32Function, pvParms, cbParms);
-        if (RT_SUCCESS(vrc))
-            vrc = vrc2;
-    }
+    if (pExt->pfnExt) /* Overwrite rc if we have an extension present. */
+        vrc = pExt->pfnExt(pExt->pvExt, u32Function, pvParms, cbParms);
 
     LogFlowFuncLeaveRC(vrc);