Changeset 13293

Timestamp:

10/15/08 18:19:36 (3 months ago)

Author:

vboxsync

Message:

HostServices/GuestProperties? and Main: support property flags - the values are not yet checked

Files:

• trunk/include/VBox/HostServices/GuestPropertySvc.h (modified) (2 diffs)
• trunk/src/VBox/HostServices/GuestProperties/service.cpp (modified) (14 diffs)
• trunk/src/VBox/Main/ConsoleImpl.cpp (modified) (2 diffs)
• trunk/src/VBox/Main/ConsoleImpl2.cpp (modified) (1 diff)
• trunk/src/VBox/Main/MachineImpl.cpp (modified) (1 diff)

trunk/include/VBox/HostServices/GuestPropertySvc.h

@@ -35 +35 @@
-#include <VBox/VBoxGuest.h>
-#include <VBox/hgcmsvc.h>
+#include <VBox/log.h>
+#include <iprt/assert.h>
+
+#include <string.h>
+
+#ifdef RT_OS_WINDOWS
+# define strncasecmp strnicmp
+#endif
-
-/** Everything defined in this file lives in this namespace. */
-namespace guestProp {
+
+/******************************************************************************
+* Typedefs, constants and inlines                                             *
+******************************************************************************/
+
+/** Maximum length for property names */
+enum { MAX_NAME_LEN = 64 };
+/** Maximum length for property values */
+enum { MAX_VALUE_LEN = 128 };
+/** Maximum number of properties per guest */
+enum { MAX_PROPS = 256 };
+
+/**
+ * The guest property flag values which are currently accepted.
+ */
+enum ePropFlags
+{
+    NILFLAG    = 0,
+    TRANSIENT  = RT_BIT(1),
+    HOSTWRITE  = RT_BIT(2),
+    GUESTWRITE = RT_BIT(3),
+    READONLY   = RT_BIT(4)
+};
+
+/**
+ * A structure to map the guest property flag values to names. I know it is
+ * ugly to have constants inline, but it has to be accessible in different
+ * modules and it does not seem reasonable to put it into its own library.
+ */
+const struct
+{
+    /** The flag value */
+    uint32_t fFlag;
+    /** And the name of the flag */
+    const char *pcszName;
+} flagNames[] =
+{
+    { TRANSIENT,  "TRANSIENT" },
+    { HOSTWRITE,  "HOSTWRITE" },
+    { GUESTWRITE, "GUESTWRITE" },
+    { READONLY,   "READONLY" },
+    { NILFLAG,    NULL }
+};
+
+/** Maximum length for the property flags field */
+enum { MAX_FLAGS_LEN =   sizeof(flagNames[0]) + 2  /* + 2 for ", " */
+                       + sizeof(flagNames[1]) + 2
+                       + sizeof(flagNames[2]) + 2
+                       + sizeof(flagNames[3])
+     };
+
+/**
+ * Parse a guest properties flags string for the flags in flagNames.
+ * @returns  IPRT status code
+ * @returns  VERR_INVALID_PARAM if the flag string is not valid
+ * @param    pcszFlags  the flag string to parse
+ * @param    pfFlags    where to store the parse result.  May not be NULL.
+ * @note     This function is also inline because it must be accessible from
+ *           several modules and it does not seem reasonable to put it into
+ *           its own library.
+ */
+DECLINLINE(int) validateFlags(const char *pcszFlags, uint32_t *pfFlags)
+{
+    const char *pcszNext = pcszFlags;
+    int rc = VINF_SUCCESS;
+    uint32_t fFlags = 0;
+    AssertLogRelReturn(VALID_PTR(pfFlags), VERR_INVALID_POINTER);
+    AssertLogRelReturn(VALID_PTR(pcszFlags), VERR_INVALID_POINTER);
+    while (' ' == *pcszNext)
+        ++pcszNext;
+    while ((*pcszNext != '\0') && RT_SUCCESS(rc))
+    {
+        int i = 0;
+        for (; flagNames[i].fFlag != NILFLAG; ++i)
+            if (strncasecmp(pcszNext, flagNames[i].pcszName,
+                            strlen(flagNames[i].pcszName)) == 0)
+                break;
+        if (NILFLAG == flagNames[i].fFlag)
+            rc = VERR_INVALID_PARAMETER;
+        else
+        {
+            fFlags |= flagNames[i].fFlag;
+            pcszNext += strlen(flagNames[i].pcszName);
+        }
+        while (' ' == *pcszNext)
+            ++pcszNext;
+        if (',' == *pcszNext)
+            ++pcszNext;
+        while (' ' == *pcszNext)
+            ++pcszNext;
+    }
+    if (RT_SUCCESS(rc))
+        *pfFlags = fFlags;
+    return rc;
+}
+
+/**
+ * Write out flags to a string.
+ * @returns  IPRT status code
+ * @param    fFlags    the flags to write out
+ * @param    pszFlags  where to write the flags string.  This must point to
+ *                     a buffer of size (at least) MAX_FLAGS_LEN + 1.
+ */
+DECLINLINE(int) writeFlags(uint32_t fFlags, char *pszFlags)
+{
+    char *pszNext = pszFlags;
+    int rc = VINF_SUCCESS;
+    AssertLogRelReturn(VALID_PTR(pszFlags), VERR_INVALID_POINTER);
+    int i = 0;
+    for (; flagNames[i].fFlag != NILFLAG; ++i)
+    {
+        if (fFlags & flagNames[i].fFlag)
+        {
+            strcpy(pszNext, flagNames[i].pcszName);
+            pszNext += strlen(flagNames[i].pcszName);
+            fFlags &= ~flagNames[i].fFlag;
+            if ((flagNames[i + 1].fFlag != NILFLAG) && (fFlags != NILFLAG))
+            {
+                strcpy(pszNext, ", ");
+                pszNext += 2;
+            }
+        }
+    }
+    *pszNext = '\0';
+    if (fFlags != NILFLAG)
+        rc = VERR_INVALID_PARAMETER;  /* But pszFlags will still be set right. */
+    return rc;
+}
-
-/*
@@ -111 +247 @@
-};
-
-/** Maximum length for property names */
-enum { MAX_NAME_LEN = 64 };
-/** Maximum length for property values */
-enum { MAX_VALUE_LEN = 128 };
-/** Maximum length for the property flags field */
-enum { MAX_FLAGS_LEN = 128 };
-/** Maximum number of properties per guest */
-enum { MAX_PROPS = 256 };
-
-/**
- * HGCM parameter structures.  Packing is explicitly defined as this is a wire format.

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

@@ -327 +327 @@
-
-    LogFlowThisFunc(("\n"));
+    AssertReturn(VALID_PTR(mpValueNode), VERR_WRONG_ORDER);  /* a.k.a. VERR_NOT_INITIALIZED */
-    if (   (cParms != 3)  /* Hardcoded value as the next lines depend on it. */
-        || (paParms[0].type != VBOX_HGCM_SVC_PARM_PTR)   /* name */
@@ -373 +374 @@
-    uint32_t cchName, cchBuf;
-    size_t cchValue, cchFlags, cchBufActual;
+    char szFlags[MAX_FLAGS_LEN + 1];
+    uint32_t fFlags;
-
-    /*
@@ -378 +381 @@
-     */
-    LogFlowThisFunc(("\n"));
+    AssertReturn(VALID_PTR(mpValueNode), VERR_WRONG_ORDER);  /* a.k.a. VERR_NOT_INITIALIZED */
-    if (   (cParms != 4)  /* Hardcoded value as the next lines depend on it. */
-        || (paParms[0].type != VBOX_HGCM_SVC_PARM_PTR)    /* name */
@@ -389 +393 @@
-    if (RT_SUCCESS(rc))
-        rc = validateName(pszName, cchName);
-    /* Get the value size */
-    if (RT_SUCCESS(rc))
-        rc = CFGMR3QuerySize(mpValueNode, pszName, &cchValue);
-
-    /*
-     * Read and set the values we will return
-     */
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-    /* Check that the buffer is big enough */
-    if (RT_SUCCESS(rc))
@@ -411 +419 @@
-    if (RT_SUCCESS(rc))
-        rc = CFGMR3QueryString(mpValueNode, pszName, pchBuf, cchBuf);
-
-
-
-
-
-
+
+
+
-    /* Timestamp */
-    uint64_t u64Timestamp = 0;
- && (mpTimestampNode != NULL)
+
-        CFGMR3QueryU64(mpTimestampNode, pszName, &u64Timestamp);
-    VBoxHGCMParmUInt64Set(&paParms[2], u64Timestamp);
@@ -449 +454 @@
-{
-    int rc = VINF_SUCCESS;
-
-
+
+
+
-
-    LogFlowThisFunc(("\n"));
+    AssertReturn(VALID_PTR(mpValueNode), VERR_WRONG_ORDER);  /* a.k.a. VERR_NOT_INITIALIZED */
-    /*
-     * First of all, make sure that we won't exceed the maximum number of properties.
@@ -485 +492 @@
-    if (RT_SUCCESS(rc))
-        rc = validateValue(pszValue, cchValue);
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-    /*
@@ -500 +519 @@
-        RTTIMESPEC time;
-        CFGMR3RemoveValue(mpValueNode, pszName);
-
-
-
-
+
+
-        rc = CFGMR3InsertString(mpValueNode, pszName, pszValue);
-        if (RT_SUCCESS(rc))
-            rc = CFGMR3InsertInteger(mpTimestampNode, pszName,
-                                     RTTimeSpecGetNano(RTTimeNow(&time)));
-
-
-
-
+
+
+
+
+
-        {
-
-
-
-
+
+
+
-        }
-    }
@@ -549 +566 @@
-
-    LogFlowThisFunc(("\n"));
+    AssertReturn(VALID_PTR(mpValueNode), VERR_WRONG_ORDER);  /* a.k.a. VERR_NOT_INITIALIZED */
-    if (   (cParms != 1)  /* Hardcoded value as the next lines depend on it. */
-        || (paParms[0].type != VBOX_HGCM_SVC_PARM_PTR)   /* name */
@@ -676 +694 @@
-    uint32_t cchPatterns = 0, cchBuf = 0;
-    LogFlowThisFunc(("\n"));
+    AssertReturn(VALID_PTR(mpValueNode), VERR_WRONG_ORDER);  /* a.k.a. VERR_NOT_INITIALIZED */
-    if (   (cParms != 3)  /* Hardcoded value as the next lines depend on it. */
-        || (paParms[0].type != VBOX_HGCM_SVC_PARM_PTR)   /* patterns */
@@ -722 +741 @@
-                iTmpBuf += strlen(&TmpBuf[iTmpBuf]) + 1;
-                uint64_t u64Timestamp = 0;
-
-
+
-                iTmpBuf += RTStrFormatNumber(&TmpBuf[iTmpBuf], u64Timestamp,
-                                             10, 0, 0, 0) + 1;
-                /* Get flags */
-TmpBuf[iTmpBuf] = '\0';  /* In case there are none. */
-if (mpFlagsNode != NULL)
-    CFGMR3QueryString(mpFlagsNode, pszName, &TmpBuf[iTmpBuf],
-                      cchTmpBuf - iTmpBuf);  /* Ignore failure */
+uint32_t fFlags = NILFLAG;
+CFGMR3QueryU32(mpFlagsNode, pszName, &fFlags);
+TmpBuf[iTmpBuf] = '\0';  /* Bad (== in)sanity, will be fixed. */
+writeFlags(fFlags, &TmpBuf[iTmpBuf]);
-                iTmpBuf += strlen(&TmpBuf[iTmpBuf]) + 1;
-            }
@@ -767 +785 @@
-    char szValue[MAX_VALUE_LEN];
-    uint64_t u64Timestamp = 0;
-
+
+
-    char *pszName = NULL, *pszValue = NULL, *pszFlags = NULL;
-
+    AssertPtr(mpValueNode);
-    if (NULL == mpfnHostCallback)
-        return;  /* Nothing to do. */
@@ -779 +799 @@
-    if (rc != VERR_CFGM_VALUE_NOT_FOUND)
-    {
- && (mpTimestampNode != NULL)
+
-            rc = CFGMR3QueryU64(mpTimestampNode, pszProperty, &u64Timestamp);
-
-
-
+
+
+
+
-        if (RT_SUCCESS(rc))
-            rc = RTStrDupEx(&pszName, pszProperty);
- && (mpTimestampNode != NULL)
+
-            rc = RTStrDupEx(&pszValue, szValue);
- && (mpFlagsNode != NULL)
+
-            rc = RTStrDupEx(&pszFlags, szFlags);
-        if (RT_SUCCESS(rc))
@@ -934 +955 @@
-            LogFlowFunc(("SET_CFGM_NODE\n"));
-
-
-
+
+
+
+
+
-                rc = VERR_INVALID_PARAMETER;
-            }
-            else if (   paParms[0].type != VBOX_HGCM_SVC_PARM_PTR   /* pValue */
-                     || ((cParms > 1) && (paParms[1].type != VBOX_HGCM_SVC_PARM_PTR))   /* pTimestamp */
-                     || ((cParms > 2) && (paParms[2].type != VBOX_HGCM_SVC_PARM_PTR))   /* pFlags */
-                    )
-            {
-                rc = VERR_INVALID_PARAMETER;
-            }
-            else
-            {
-Node
+Value = NULL, pTimestamp = NULL, pFlags
-                uint32_t cbDummy;
-
-Nod
+Valu
-                if (RT_SUCCESS(rc))
-
-
+
+
+
+
-                {
-
-
-
-
-
-
-
+
+
+
-                }
-            }

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -4494 +4494 @@
-        char szPropFlags[MAX_FLAGS_LEN + 1];
-        ULONG64 u64Timestamp = 0;  /* default */
-        szPropFlags[0] = '\0';  /* default */
-        vrc = CFGMR3GetValueName (pValue, szPropName, sizeof(szPropName));
-        if (RT_SUCCESS(vrc))
@@ -4500 +4499 @@
-        if (RT_SUCCESS(vrc))
-        {
-
+
+
+
-            CFGMR3QueryU64 (pTimestamps, szPropName, &u64Timestamp);
-            Bstr(szPropName).cloneTo(&names[iProp]);

trunk/src/VBox/Main/ConsoleImpl2.cpp

@@ -1813 +1813 @@
-            for (size_t i = 0; i < cProps; ++i)
-            {
-
-
-
+
+
+
+
+
+
+
+
-            }
-

trunk/src/VBox/Main/MachineImpl.cpp

@@ -2804 +2804 @@
-        return E_INVALIDARG;
-
-    /* For now there are no valid flags, so check this. */
-    if (aFlags != NULL)
-        for (size_t i = 0; aFlags[i] != '\0'; ++i)
-            if (aFlags[i] != ' ')
-                return E_INVALIDARG;
-
-    AutoCaller autoCaller (this);
-    CheckComRCReturnRC (autoCaller.rc());