Changeset 13971

Timestamp:

11/07/08 17:07:57 (2 months ago)

Author:

vboxsync

Message:

HostServices/GuestProperties?: added blocking waits for notifications

Files:

• trunk/include/VBox/HostServices/GuestPropertySvc.h (modified) (2 diffs)
• trunk/src/VBox/HostServices/GuestProperties/service.cpp (modified) (13 diffs)
• trunk/src/VBox/HostServices/GuestProperties/testcase/tstGuestPropSvc.cpp (modified) (4 diffs)

trunk/include/VBox/HostServices/GuestPropertySvc.h

@@ -431 +431 @@
- * On success, VINF_SUCCESS will be returned and the buffer will contain
- * details of a property notification.  If no new notification is available,
-a timestamp of zero will be returned
+the call will block until one is
- * If the last notification could not be found by timestamp, VWRN_NOT_FOUND
- * will be returned and the oldest available notification will be returned.
-i
+I
- * returned.
- * If the buffer supplied was not large enough to hold the notification,
- * VERR_BUFFER_OVERFLOW will be returned and the size parameter will contain
- * the size of the buffer needed.
+ *
+ * The protocol for a guest to obtain notifications is to call
+ * GET_NOTIFICATION in a loop.  On the first call, the ingoing timestamp
+ * parameter should be set to zero.  On subsequent calls, it should be set to
+ * the outgoing timestamp from the previous call. 
- */
-typedef struct _GetNotification
@@ -452 +457 @@
-     *
-     * The timestamp of the change being notified of (OUT uint64_t)
-
-
+
-     */
-    HGCMFunctionParameter timestamp;
-
-    /**
-. if any
+, if any,
-     * This call returns three null-terminated strings which will be placed
-     * one after another: name, value and flags.  For a delete notification,

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

@@ -60 +60 @@
-#include <string>
-#include <list>
+#include <vector>
-
-namespace guestProp {
@@ -104 +105 @@
-    /** The list of property changes for guest notifications */
-    PropertyList mGuestNotifications;
+    /** Structure for holding an uncompleted guest call */
+    struct GuestCall
+    {
+        /** The call handle */
+        VBOXHGCMCALLHANDLE mHandle;
+        /** The function that was requested */
+        uint32_t mFunction;
+        /** The number of parameters */
+        uint32_t mcParms;
+        /** The parameters themselves */
+        VBOXHGCMSVCPARM *mParms;
+
+        /** The standard constructor */
+        GuestCall() : mFunction(0), mcParms(0) {}
+        /** The normal contructor */
+        GuestCall(VBOXHGCMCALLHANDLE aHandle, uint32_t aFunction,
+                  uint32_t acParms, VBOXHGCMSVCPARM aParms[])
+                  : mHandle(aHandle), mFunction(aFunction), mcParms(acParms),
+                  mParms(aParms) {}
+    };
+    typedef std::vector <GuestCall> CallVector;
+    /** The list of outstanding guest notification calls */
+    CallVector mGuestWaiters;
-    /** @todo we should have classes for thread and request handler thread */
-    /** Queue of outstanding property change notifications */
@@ -213 +237 @@
-    int delProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool isGuest);
-    int enumProps(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
-
+
+
-    void doNotifications(const char *pszProperty, uint64_t u64Timestamp);
-    static DECLCALLBACK(int) reqNotify(PFNHGCMSVCEXT pfnCallback,
@@ -748 +773 @@
- * @param   cParms  the number of HGCM parameters supplied
- * @param   paParms the array of HGCM parameters
+ * @param   canWait can this request be enqueued
- * @thread  HGCM
-
-
+
+
+
+
-{
-    int rc = VINF_SUCCESS;
@@ -817 +845 @@
-
-    /*
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    else if (RT_SUCCESS(rc))
-
-
-
+
+
+
+
-    return rc;
-}
@@ -847 +890 @@
-
-    AssertPtrReturnVoid(pszProperty);
+    /* Ensure that our timestamp is different to the last one. */
+    if (   !mGuestNotifications.empty()
+        && u64Timestamp == mGuestNotifications.back().mTimestamp)
+        ++u64Timestamp;
+
+    /*
+     * Try to find the property.
+     */
-    PropertyList::const_iterator it;
-    bool found = false;
@@ -856 +907 @@
-                break;
-            }
+
-    /*
-     * First case: if the property exists then send its current value
@@ -874 +926 @@
-                             (PFNRT)Service::reqNotify, 7, mpfnHostCallback,
-                             mpvHostData, pszName, pszValue,
-it->m
-it->m
+u64
+u64
-#endif /* VBOX_GUEST_PROP_TEST_NOTHREAD not defined */
-    }
-    if (found)
-    {
-
+
+
-        if (RT_SUCCESS(rc))
-        {
@@ -886 +939 @@
-            {
-                mGuestNotifications.push_back(*it);
+                while (mGuestWaiters.size() > 0)
+                {
+                    GuestCall call = mGuestWaiters.back();
+                    int rc2 = getNotification(call.mHandle, call.mcParms,
+                                              call.mParms, false);
+                    mpHelpers->pfnCallComplete (call.mHandle, rc2);
+                    mGuestWaiters.pop_back();
+                }
-            }
-            catch (std::bad_alloc)
@@ -980 +1041 @@
-{
-    int rc = VINF_SUCCESS;
-    bool fCallSync = true;
-
-    LogFlowFunc(("u32ClientID = %d, fn = %d, cParms = %d, pparms = %d\n",
-                 u32ClientID, eFunction, cParms, paParms));
@@ -1022 +1081 @@
-            case GET_NOTIFICATION:
-                LogFlowFunc(("GET_NOTIFICATION\n"));
-Parms, paParms
+allHandle, cParms, paParms, true
-                break;
-
@@ -1033 +1092 @@
-        rc = VERR_NO_MEMORY;
-    }
-if (fCallSync)
-{
-    LogFlowFunc(("rc = %Rrc\n", rc));
+LogFlowFunc(("rc = %Rrc\n", rc));
+if (rc != VINF_HGCM_ASYNC_EXECUTE)
+{
-        mpHelpers->pfnCallComplete (callHandle, rc);
-    }
@@ -1176 +1235 @@
-                ptable->pfnCall               = Service::svcCall;
-                ptable->pfnHostCall           = Service::svcHostCall;
- by definition, so the
-normal 
+, so the normal
+
-                ptable->pfnRegisterExtension  = Service::svcRegisterExtension;
-

trunk/src/VBox/HostServices/GuestProperties/testcase/tstGuestPropSvc.cpp

@@ -735 +735 @@
-    }
-
-    /* Test when no new events are available */
-    pTable->pfnCall(pTable->pvService, &callHandle, 0, NULL,
-                    GET_NOTIFICATION, 3, paParms);
-    if (   RT_FAILURE(callHandle.rc)
-        || RT_FAILURE(paParms[0].getUInt64 (&u64Timestamp))
-        || u64Timestamp != 0
-       )
-    {
-        RTPrintf("Failed to signal properly that no new notifications are available.\n");
-        rc = VERR_UNRESOLVED_ERROR;
-    }
-
-    /* Test a query with an unknown timestamp */
-    paParms[0].setUInt64 (1);
@@ -775 +763 @@
- * @note    prints its own diagnostic information to stdout.
- */
-
+
+
-{
-    int rc = VINF_SUCCESS;
-
-
-
-
+
+
-    uint64_t u64Timestamp = 0;
-    uint32_t u32Size = 0;
-    VBOXHGCMSVCPARM paParms[3];
-
-    paParms[0].setUInt64 (u64Timestamp);
-
-
+
+
+
-                    GET_NOTIFICATION, 3, paParms);
-
-
-
-
-
-
+
+
+
-        rc = VERR_UNRESOLVED_ERROR;
-    }
@@ -805 +789 @@
-    VBOXHGCMSVCFNTABLE svcTable;
-    VBOXHGCMSVCHELPERS svcHelpers;
+    /* Paramters for the asynchronous guest notification call */
+    VBOXHGCMSVCPARM aParm[3];
+    char chBuffer[MAX_NAME_LEN + MAX_VALUE_LEN + MAX_FLAGS_LEN];
+    VBOXHGCMCALLHANDLE_TYPEDEF callHandleStruct;
+
-    initTable(&svcTable, &svcHelpers);
-    RTR3Init();
@@ -819 +808 @@
-    if (RT_FAILURE(testEnumPropsHost(&svcTable)))
-        return 1;
-
+
+
+
-        return 1;
-    if (RT_FAILURE(testSetProp(&svcTable)))
-        return 1;
+    RTPrintf("Checking the data returned by the asynchronous notification call.\n");
+    /* Our previous notification call should have completed by now. */
+    uint64_t u64Timestamp;
+    uint32_t u32Size;
+    if (   callHandleStruct.rc != VINF_SUCCESS
+        || RT_FAILURE(aParm[0].getUInt64 (&u64Timestamp))
+        || RT_FAILURE(aParm[2].getUInt32 (&u32Size))
+        || u32Size != getNotifications[0].cchBuffer
+        || memcmp(chBuffer, getNotifications[0].pchBuffer, u32Size) != 0
+       )
+    {
+        RTPrintf("Asynchronous GET_NOTIFICATION call did not complete as expected, rc=%Rrc\n",
+                 callHandleStruct.rc);
+        return 1;
+    }
-    if (RT_FAILURE(testDelProp(&svcTable)))
-        return 1;