Changeset 13376 in vbox

Timestamp:

Oct 17, 2008 2:20:28 PM (16 years ago)

Author:

vboxsync

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

38102

Message:

HostServices/GuestProperties: use an HGCM service extension instead of the callback type I added

Location:

trunk

Files:

• include/VBox/HostServices/GuestPropertySvc.h (modified) (2 diffs)
• src/VBox/HostServices/GuestProperties/service.cpp (modified) (7 diffs)

trunk/include/VBox/HostServices/GuestPropertySvc.h

@@ -206 +206 @@
      * The parameter format matches that of ENUM_PROPS.
      */
-    ENUM_PROPS_HOST = 6,
-    /**
-     * Register a callback with the service which will be called when a
-     * property is modified.  The callback is a function returning void and
-     * taking a pointer to a HOSTCALLBACKDATA structure.
-     */
-    REGISTER_CALLBACK = 7
-};
-
-typedef struct _HOSTCALLBACKDATA
-{
-    /** Callback structure header */
-    VBOXHGCMCALLBACKHDR hdr;
-    /** The name of the property that was changed */
-    const char *pcszName;
-    /** The new property value, or NULL if the property was deleted */
-    const char *pcszValue;
-    /** The timestamp of the modification */
-    uint64_t u64Timestamp;
-    /** The flags field of the modified property */
-    const char *pcszFlags;
-} HOSTCALLBACKDATA, *PHOSTCALLBACKDATA;
+    ENUM_PROPS_HOST = 6
+};
 
 /**
@@ -248 +228 @@
 
 /**
+ * Data structure to pass to the service extension callback.  We use this to
+ * notify the host of changes to properties.
+ */
+typedef struct _HOSTCALLBACKDATA
+{
+    /** Magic number to identify the structure */
+    uint32_t u32Magic;
+    /** The name of the property that was changed */
+    const char *pcszName;
+    /** The new property value, or NULL if the property was deleted */
+    const char *pcszValue;
+    /** The timestamp of the modification */
+    uint64_t u64Timestamp;
+    /** The flags field of the modified property */
+    const char *pcszFlags;
+} HOSTCALLBACKDATA, *PHOSTCALLBACKDATA;
+
+enum
+{
+    /** Magic number for sanity checking the HOSTCALLBACKDATA structure */
+    HOSTCALLBACKMAGIC = 0x69c87a78
+};
+
+/**
  * HGCM parameter structures.  Packing is explicitly defined as this is a wire format.
  */

trunk/src/VBox/HostServices/GuestProperties/service.cpp

@@ -91 +91 @@
     pParm->u.uint64 = u64;
 }
-
-/** Extract a callback pointer value from an HGCM parameter structure */
-static int VBoxHGCMParmPtrGet (VBOXHGCMSVCPARM *pParm,
-                               PFNVBOXHGCMCALLBACK *ppfnCallback,
-                               void **ppvData)
-{
-    if (pParm->type == VBOX_HGCM_SVC_PARM_CALLBACK)
-    {
-        *ppfnCallback = pParm->u.callback.pFunction;
-        *ppvData      = pParm->u.callback.pvData;
-        return VINF_SUCCESS;
-    }
-
-    return VERR_INVALID_PARAMETER;
-}
-
 
 namespace guestProp {
@@ -135 +119 @@
     /** Callback function supplied by the host for notification of updates
      * to properties */
-    PFNVBOXHGCMCALLBACK mpfnHostCallback;
+    PFNHGCMSVCEXT mpfnHostCallback;
     /** User data pointer to be supplied to the host callback function */
     void *mpvHostData;
@@ -207 +191 @@
         SELF *pSelf = reinterpret_cast<SELF *>(pvService);
         return pSelf->hostCall(u32Function, cParms, paParms);
+    }
+
+    /**
+     * @copydoc VBOXHGCMSVCHELPERS::pfnRegisterExtension
+     * Installs a host callback for notifications of property changes.
+     */
+    static DECLCALLBACK(int) svcRegisterExtension (void *pvService,
+                                                   PFNHGCMSVCEXT pfnExtension,
+                                                   void *pvExtension)
+    {
+        AssertLogRelReturn(VALID_PTR(pvService), VERR_INVALID_PARAMETER);
+        SELF *pSelf = reinterpret_cast<SELF *>(pvService);
+        // pSelf->mpfnHostCallback = pfnExtension;
+        pSelf->mpvHostData = pvExtension;
+        return VINF_SUCCESS;
     }
 private:
@@ -218 +217 @@
     int enumProps(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     void notifyHost(const char *pszProperty);
-    static DECLCALLBACK(int) reqNotify(PFNVBOXHGCMCALLBACK pfnCallback,
+    static DECLCALLBACK(int) reqNotify(PFNHGCMSVCEXT pfnCallback,
                                        void *pvData, char *pszName,
                                        char *pszValue, uint32_t u32TimeHigh,
@@ -882 +881 @@
  * @thread  request thread
  */
-int Service::reqNotify(PFNVBOXHGCMCALLBACK pfnCallback, void *pvData,
+int Service::reqNotify(PFNHGCMSVCEXT pfnCallback, void *pvData,
                        char *pszName, char *pszValue, uint32_t u32TimeHigh,
                        uint32_t u32TimeLow, char *pszFlags)
 {
     HOSTCALLBACKDATA HostCallbackData;
-    HostCallbackData.hdr.u32Magic = VBOXHGCMCALLBACKMAGIC;
-    HostCallbackData.hdr.cbStruct = sizeof(HostCallbackData);
-    HostCallbackData.hdr.pvData   = pvData;
+    HostCallbackData.u32Magic     = HOSTCALLBACKMAGIC;
     HostCallbackData.pcszName     = pszName;
     HostCallbackData.pcszValue    = pszValue;
     HostCallbackData.u64Timestamp = RT_MAKE_U64(u32TimeLow, u32TimeHigh);
     HostCallbackData.pcszFlags    = pszFlags;
-    pfnCallback(&HostCallbackData.hdr);
+    AssertRC(pfnCallback(pvData, 0, reinterpret_cast<void *>(&HostCallbackData),
+                         sizeof(HostCallbackData)));
     RTStrFree(pszName);
     RTStrFree(pszValue);
@@ -1037 +1035 @@
             LogFlowFunc(("ENUM_PROPS\n"));
             rc = enumProps(cParms, paParms);
-            break;
-        case REGISTER_CALLBACK:
-            if ((1 != cParms) || (paParms[0].type != VBOX_HGCM_SVC_PARM_CALLBACK))
-                rc = VERR_INVALID_PARAMETER;
-            else
-            {
-                PFNVBOXHGCMCALLBACK pfnCallback = NULL;
-                void *pvData = NULL;
-                rc = VBoxHGCMParmPtrGet (&paParms[0], &pfnCallback, &pvData);
-                mpfnHostCallback = pfnCallback;
-                mpvHostData = pvData;
-            }
             break;
         default:
@@ -1121 +1107 @@
                 ptable->cbClient = 0;
 
-                ptable->pfnUnload     = Service::svcUnload;
-                ptable->pfnConnect    = Service::svcConnectDisconnect;
-                ptable->pfnDisconnect = Service::svcConnectDisconnect;
-                ptable->pfnCall       = Service::svcCall;
-                ptable->pfnHostCall   = Service::svcHostCall;
-                ptable->pfnSaveState  = NULL;  /* The service is stateless by definition, so the */
-                ptable->pfnLoadState  = NULL;  /* normal construction done before restoring suffices */
-                ptable->pfnRegisterExtension  = NULL;
+                ptable->pfnUnload             = Service::svcUnload;
+                ptable->pfnConnect            = Service::svcConnectDisconnect;
+                ptable->pfnDisconnect         = Service::svcConnectDisconnect;
+                ptable->pfnCall               = Service::svcCall;
+                ptable->pfnHostCall           = Service::svcHostCall;
+                ptable->pfnSaveState          = NULL;  /* The service is stateless by definition, so the */
+                ptable->pfnLoadState          = NULL;  /* normal construction done before restoring suffices */
+                ptable->pfnRegisterExtension  = Service::svcRegisterExtension;
 
                 /* Service specific initialization. */