Changeset 14104

Timestamp:

11/11/08 20:16:32 (2 months ago)

Author:

vboxsync

Message:

HostServices/GuestProperties?: fixed the GET_NOTIFICATION protocol

Files:

• trunk/include/VBox/HostServices/GuestPropertySvc.h (modified) (2 diffs)
• trunk/src/VBox/HostServices/GuestProperties/service.cpp (modified) (14 diffs)
• trunk/src/VBox/HostServices/GuestProperties/testcase/Makefile.kmk (modified) (1 diff)
• trunk/src/VBox/HostServices/GuestProperties/testcase/tstGuestPropSvc.cpp (modified) (12 diffs)

trunk/include/VBox/HostServices/GuestPropertySvc.h

@@ -426 +426 @@
-
-/**
-
-
+
+
+
- * On success, VINF_SUCCESS will be returned and the buffer will contain
-
-
+
+
+
- * If the last notification could not be found by timestamp, VWRN_NOT_FOUND
- * will be returned and the oldest available notification will be returned.
-no timestamp is specified, the oldest available notification will be
-returned
+a zero timestamp is specified, the call will always wait for a new
+notification to arrive
- * If the buffer supplied was not large enough to hold the notification,
- * VERR_BUFFER_OVERFLOW will be returned and the size parameter will contain
@@ -446 +448 @@
-typedef struct _GetNotification
-{
-
-
+
+
+
+
+
+
+
+
-    /**
-     * The timestamp of the last change seen (IN uint64_t)

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

@@ -60 +60 @@
-#include <string>
-#include <list>
-#include <vector>
-
-namespace guestProp {
@@ -112 +111 @@
-        /** The function that was requested */
-        uint32_t mFunction;
-
-
-
+
-        VBOXHGCMSVCPARM *mParms;
+        /** The default return value, used for passing warnings */
+        int mRc;
-
-        /** The standard constructor */
-, mcParms(0)
+
-        /** The normal contructor */
-        GuestCall(VBOXHGCMCALLHANDLE aHandle, uint32_t aFunction,
-uint32_t acParms, VBOXHGCMSVCPARM aParms[]
-cParms(ac
-mParms(aParms
+VBOXHGCMSVCPARM aParms[], int aRc
+Parms(a
+  mRc(aRc
-    };
-vector <GuestCall> CallVector
+list <GuestCall> CallList
-    /** The list of outstanding guest notification calls */
-Vector
+List
-    /** @todo we should have classes for thread and request handler thread */
-    /** Queue of outstanding property change notifications */
@@ -238 +237 @@
-    int enumProps(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
-    int getNotification(VBOXHGCMCALLHANDLE callHandle, uint32_t cParms,
-
+
+
+
+
-    void doNotifications(const char *pszProperty, uint64_t u64Timestamp);
-    static DECLCALLBACK(int) reqNotify(PFNHGCMSVCEXT pfnCallback,
@@ -439 +441 @@
-    char *pchBuf;
-    uint32_t cchName, cchBuf;
-size
+uint32
-    char szFlags[MAX_FLAGS_LEN];
-    uint32_t fFlags;
-
-    /*
@@ -734 +735 @@
-            char szFlags[MAX_FLAGS_LEN];
-            char szTimestamp[256];
-size
+uint32
-            buffer += it->mName;
-            buffer += '\0';
@@ -768 +769 @@
-
-/**
+ * Get the next property change notification from the queue of saved
+ * notification based on the timestamp of the last notification seen.
+ * Notifications will only be reported if the property name matches the
+ * pattern given.
+ *
+ * @returns iprt status value
+ * @returns VWRN_NOT_FOUND if the last notification was not found in the queue
+ * @param   pszPatterns   the patterns to match the property name against
+ * @param   u64Timestamp  the timestamp of the last notification
+ * @param   pProp         where to return the property found.  If none is
+ *                        found this will be set to nil.
+ * @thread  HGCM
+ */
+int Service::getOldNotification(const char *pszPatterns, uint64_t u64Timestamp,
+                                Property *pProp)
+{
+    AssertPtrReturn(pszPatterns, VERR_INVALID_POINTER);
+    AssertReturn(u64Timestamp != 0, VERR_INVALID_PARAMETER);  /* Zero means wait for a new notification. */
+    AssertPtrReturn(pProp, VERR_INVALID_POINTER);
+    int rc = VINF_SUCCESS;
+    bool warn = false;
+
+    /* We count backwards, as the guest should normally be querying the
+     * most recent events. */
+    PropertyList::reverse_iterator it = mGuestNotifications.rbegin();
+    for (; it->mTimestamp != u64Timestamp && it != mGuestNotifications.rend();
+         ++it) {}
+    /* Warn if the timestamp was not found. */
+    if (it->mTimestamp != u64Timestamp)
+        warn = true;
+    /* Now look for an event matching the patterns supplied.  The base()
+     * member conveniently points to the following element. */
+    PropertyList::iterator base = it.base();
+    for (;    pszPatterns[0] != '\0'
+           && !RTStrSimplePatternMultiMatch(pszPatterns, RTSTR_MAX,
+                                            base->mName.c_str(), RTSTR_MAX,
+                                            NULL)
+           && base != mGuestNotifications.end(); ++base) {}
+    if (RT_SUCCESS(rc) && base != mGuestNotifications.end())
+        *pProp = *base;
+    else if (RT_SUCCESS(rc))
+        *pProp = Property();
+    if (warn)
+        rc = VWRN_NOT_FOUND;
+    return rc;
+}
+
+int Service::getNotificationWriteOut(VBOXHGCMSVCPARM paParms[], Property prop)
+{
+    int rc = VINF_SUCCESS;
+    /* Format the data to write to the buffer. */
+    std::string buffer;
+    uint64_t u64Timestamp;
+    char *pchBuf;
+    uint32_t cchBuf;
+    rc = paParms[2].getPointer((void **) &pchBuf, &cchBuf);
+    if (RT_SUCCESS(rc))
+    {
+        char szFlags[MAX_FLAGS_LEN];
+        rc = writeFlags(prop.mFlags, szFlags);
+        if (RT_SUCCESS(rc))
+        {
+            buffer += prop.mName;
+            buffer += '\0';
+            buffer += prop.mValue;
+            buffer += '\0';
+            buffer += szFlags;
+            buffer += '\0';
+            u64Timestamp = prop.mTimestamp;
+        }
+    }
+    /* Write out the data. */
+    if (RT_SUCCESS(rc))
+    {
+        paParms[1].setUInt64(u64Timestamp);
+        paParms[3].setUInt32(buffer.size());
+        if (buffer.size() <= cchBuf)
+            buffer.copy(pchBuf, cchBuf);
+        else
+            rc = VERR_BUFFER_OVERFLOW;
+    }
+    return rc;
+}
+
+/**
- * Get the next guest notification.
- *
@@ -773 +859 @@
- * @param   cParms  the number of HGCM parameters supplied
- * @param   paParms the array of HGCM parameters
- * @param   canWait can this request be enqueued
- * @thread  HGCM
- if canWait==true
+
- */
-int Service::getNotification(VBOXHGCMCALLHANDLE callHandle, uint32_t cParms,
-, bool canWait
-
-
-
-
+
+
+
+szPatterns, *p
+Patterns = 0, cch
-    uint64_t u64Timestamp;
-    bool warn = false;
-
-    /*
@@ -790 +874 @@
-     */
-    LogFlowThisFunc(("\n"));
-
-
-
+
+
+
+
+
-        || cchBuf < 1
-       )
@@ -800 +886 @@
-     * Find the change to notify of.
-     */
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    if (RT_SUCCESS(rc) && u64Timestamp != 0)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-        rc = VINF_HGCM_ASYNC_EXECUTE;
-    }
-
-
-
-
+
+
+
+
+
-    }
-    return rc;
@@ -885 +918 @@
-void Service::doNotifications(const char *pszProperty, uint64_t u64Timestamp)
-{
-    char szFlags[MAX_FLAGS_LEN];
-    char *pszName = NULL, *pszValue = NULL, *pszFlags = NULL;
-    int rc = VINF_SUCCESS;
@@ -898 +930 @@
-     * Try to find the property.
-     */
-List::const_iterator it
+ prop
-    bool found = false;
-    if (RT_SUCCESS(rc))
-
+
+
-            if (it->mName.compare(pszProperty) == 0)
-            {
-                found = true;
-break
+prop = *it
-            }
-
@@ -914 +947 @@
-    {
-#ifndef VBOX_GUEST_PROP_TEST_NOTHREAD
+        char szFlags[MAX_FLAGS_LEN];
-        /* Send out a host notification */
-it->
+prop.
-        if (RT_SUCCESS(rc))
-            rc = RTStrDupEx(&pszName, pszProperty);
-        if (RT_SUCCESS(rc))
-it->
+prop.
-        if (RT_SUCCESS(rc))
-            rc = RTStrDupEx(&pszFlags, szFlags);
@@ -932 +966 @@
-    if (found)
-    {
-Add the change to the queue for guest notifications and release
-waiter
+Release waiters if applicable and add the change to the queue for
+guest notification
-        if (RT_SUCCESS(rc))
-        {
-            try
-            {
-mGuestNotifications.push_back(*it
-while (mGuestWaiters.size() > 0
+for (CallList::iterator it = mGuestWaiters.begin(
+     it != mGuestWaiters.end(); ++it
-                {
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                }
+                mGuestNotifications.push_back(prop);
-            }
-            catch (std::bad_alloc)
@@ -1081 +1126 @@
-            case GET_NOTIFICATION:
-                LogFlowFunc(("GET_NOTIFICATION\n"));
-, true
+
-                break;
-

trunk/src/VBox/HostServices/GuestProperties/testcase/Makefile.kmk

@@ -34 +34 @@
-tstGuestPropSvc_SOURCES  = tstGuestPropSvc.cpp ../service.cpp
-tstGuestPropSvc_LIBS     = $(LIB_RUNTIME)
+# For now!
+tstGuestPropSvc_CXXFLAGS.win = -EHsc
-
-# Set this in LocalConfig.kmk if you are working on the guest property service

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

@@ -241 +241 @@
-
-/** Result string sizes for zeroth enumeration test */
-size
+uint32
-{
-    sizeof("test/name/\0test/value/\0""0\0"),
@@ -254 +254 @@
- * the - 1 at the end is because of the hidden zero terminator
- */
-size
+uint32
-sizeof("test/name/\0test/value/\0""0\0\0"
-"test name\0test value\0""999\0TRANSIENT, READONLY\0"
@@ -269 +269 @@
-
-/** Result string sizes for first and second enumeration test */
-size
+uint32
-{
-    sizeof("TEST NAME\0TEST VALUE\0""999999\0RDONLYHOST"),
@@ -280 +280 @@
- * the - 1 at the end is because of the hidden zero terminator
- */
-size
+uint32
-sizeof("TEST NAME\0TEST VALUE\0""999999\0RDONLYHOST\0"
-"/test/name\0/test/value\0""999999999999\0RDONLYGUEST\0\0\0\0\0") - 1;
@@ -289 +289 @@
-    const char *pcszPatterns;
-    /** The size of the pattern string */
-size
+uint32
-    /** The expected enumeration output strings */
-    const char **ppcchResult;
-    /** The size of the output strings */
-size
+uint32
-    /** The size of the buffer needed for the enumeration */
-size
+uint32
-}
-enumStrings[] =
@@ -693 +693 @@
-    VBOXHGCMCALLHANDLE_TYPEDEF callHandle = { VINF_SUCCESS };
-    char chBuffer[MAX_NAME_LEN + MAX_VALUE_LEN + MAX_FLAGS_LEN];
+    static char szPattern[] = "";
-
-    RTPrintf("Testing the GET_NOTIFICATION call.\n");
- = 0
+
-    uint32_t u32Size = 0;
-3
+4
-
-    /* Test "buffer too small" */
-
-
+
+
+
+
-    pTable->pfnCall(pTable->pvService, &callHandle, 0, NULL,
-3
+4
-    if (   callHandle.rc != VERR_BUFFER_OVERFLOW
-2
+3
-        || u32Size != getNotifications[0].cchBuffer
-       )
@@ -714 +717 @@
-    }
-
-
+
+
+
-    for (unsigned i = 0; RT_SUCCESS(rc) && (getNotifications[i].pchBuffer != NULL);
-         ++i)
-    {
-
-
+
+
+
-        pTable->pfnCall(pTable->pvService, &callHandle, 0, NULL,
-3
+4
-        if (   RT_FAILURE(callHandle.rc)
-
-
+
+
+
-            || u32Size != getNotifications[i].cchBuffer
-            || memcmp(chBuffer, getNotifications[i].pchBuffer, u32Size) != 0
@@ -734 +741 @@
-        }
-    }
-
-    /* Test a query with an unknown timestamp */
-    paParms[0].setUInt64 (1);
-    paParms[1].setPointer ((void *) chBuffer, sizeof(chBuffer));
-    if (RT_SUCCESS(rc))
-        pTable->pfnCall(pTable->pvService, &callHandle, 0, NULL,
-                        GET_NOTIFICATION, 3, paParms);
-    if (   RT_SUCCESS(rc)
-        && (   callHandle.rc != VWRN_NOT_FOUND
-            || RT_FAILURE(callHandle.rc)
-            || RT_FAILURE(paParms[0].getUInt64 (&u64Timestamp))
-            || RT_FAILURE(paParms[2].getUInt32 (&u32Size))
-            || u32Size != getNotifications[0].cchBuffer
-            || memcmp(chBuffer, getNotifications[0].pchBuffer, u32Size) != 0
-           )
-       )
-    {
-        RTPrintf("Problem getting notification for property '%s' with unknown timestamp, rc=%Rrc.\n",
-                 getNotifications[0].pchBuffer, callHandle.rc);
-        rc = VERR_UNRESOLVED_ERROR;
-    }
-    return rc;
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
- * @returns iprt status value to indicate whether the test went as expected.
- * @note    prints its own diagnostic information to stdout.
- */
-
-
+
-{
-    int rc = VINF_SUCCESS;
@@ -771 +767 @@
-    uint64_t u64Timestamp = 0;
-    uint32_t u32Size = 0;
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        rc = VERR_UNRESOLVED_ERROR;
-    }
@@ -789 +817 @@
-    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);
@@ -808 +832 @@
-    if (RT_FAILURE(testEnumPropsHost(&svcTable)))
-        return 1;
-
-
-
+
+
-        return 1;
-    if (RT_FAILURE(testSetProp(&svcTable)))
@@ -816 +839 @@
-    RTPrintf("Checking the data returned by the asynchronous notification call.\n");
-    /* Our previous notification call should have completed by now. */
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-    if (RT_FAILURE(testDelProp(&svcTable)))
-        return 1;