Changeset 75737 in vbox for trunk/src/VBox/HostServices/GuestProperties

Timestamp:

Nov 26, 2018 3:44:41 PM (6 years ago)

Author:

vboxsync

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

126937

Message:

HGCM: Replace C++-style inline members on VBOXHGCMSVCPARM with simple functions.
bugref:9172: Shared folder performance tuning
Changes in bugref:9172 caused a build regression on Ubuntu 18.10 due to the
use of RT_ZERO on a structure containing an embedded VBOXHGCMSVCPARM, as
VBOXHGCMSVCPARM had member functions and was therefore not a simple plain-
old-data structure. Rather than just doing the sensible thing and zeroing
it in a different way, I converted the inline member getters and setters to
standard inline C functions, including fixing callers. Actually I had planned
this for some time, as the member function use seemed a bit gratuitous in
hindsight.

Location:

trunk/src/VBox/HostServices/GuestProperties

Files:

• service.cpp (modified) (14 diffs)
• testcase/tstGuestPropSvc.cpp (modified) (17 diffs)

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

@@ -528 +528 @@
      */
     if (   cParms != 4
-        || RT_FAILURE(paParms[0].getPointer((void **)&papszNames, &cbDummy))
-        || RT_FAILURE(paParms[1].getPointer((void **)&papszValues, &cbDummy))
-        || RT_FAILURE(paParms[2].getPointer((void **)&pau64Timestamps, &cbDummy))
-        || RT_FAILURE(paParms[3].getPointer((void **)&papszFlags, &cbDummy))
+        || RT_FAILURE(HGCMSvcGetPv(&paParms[0], (void **)&papszNames, &cbDummy))
+        || RT_FAILURE(HGCMSvcGetPv(&paParms[1], (void **)&papszValues, &cbDummy))
+        || RT_FAILURE(HGCMSvcGetPv(&paParms[2], (void **)&pau64Timestamps, &cbDummy))
+        || RT_FAILURE(HGCMSvcGetPv(&paParms[3], (void **)&papszFlags, &cbDummy))
         )
         rc = VERR_INVALID_PARAMETER;
@@ -624 +624 @@
     LogFlowThisFunc(("\n"));
     if (   cParms != 4  /* Hardcoded value as the next lines depend on it. */
-        || RT_FAILURE(paParms[0].getString(&pcszName, &cbName))  /* name */
-        || RT_FAILURE(paParms[1].getBuffer((void **)&pchBuf, &cbBuf))  /* buffer */
+        || RT_FAILURE(HGCMSvcGetCStr(&paParms[0], &pcszName, &cbName))  /* name */
+        || RT_FAILURE(HGCMSvcGetBuf(&paParms[1], (void **)&pchBuf, &cbBuf))  /* buffer */
        )
         rc = VERR_INVALID_PARAMETER;
@@ -652 +652 @@
             size_t const cbValue  = pProp->mValue.size() + 1;
             size_t const cbNeeded = cbValue + cbFlags;
-            paParms[3].setUInt32((uint32_t)cbNeeded);
+            HGCMSvcSetU32(&paParms[3], (uint32_t)cbNeeded);
             if (cbBuf >= cbNeeded)
             {
@@ -659 +659 @@
                 memcpy(pchBuf + cbValue, szFlags, cbFlags);
 
-                paParms[2].setUInt64(pProp->mTimestamp);
+                HGCMSvcSetU64(&paParms[2], pProp->mTimestamp);
 
                 /*
@@ -708 +708 @@
     if (   RT_SUCCESS(rc)
         && (   (cParms < 2) || (cParms > 3)  /* Hardcoded value as the next lines depend on it. */
-            || RT_FAILURE(paParms[0].getString(&pcszName, &cchName))  /* name */
-            || RT_FAILURE(paParms[1].getString(&pcszValue, &cchValue))  /* value */
+            || RT_FAILURE(HGCMSvcGetCStr(&paParms[0], &pcszName, &cchName))  /* name */
+            || RT_FAILURE(HGCMSvcGetCStr(&paParms[1], &pcszValue, &cchValue))  /* value */
             || (   (3 == cParms)
-                && RT_FAILURE(paParms[2].getString(&pcszFlags, &cchFlags)) /* flags */
+                && RT_FAILURE(HGCMSvcGetCStr(&paParms[2], &pcszFlags, &cchFlags)) /* flags */
                )
            )
@@ -825 +825 @@
      */
     if (   (cParms == 1)  /* Hardcoded value as the next lines depend on it. */
-        && RT_SUCCESS(paParms[0].getString(&pcszName, &cbName))  /* name */
+        && RT_SUCCESS(HGCMSvcGetCStr(&paParms[0], &pcszName, &cbName))  /* name */
        )
         rc = validateName(pcszName, cbName);
@@ -954 +954 @@
     LogFlowThisFunc(("\n"));
     if (   (cParms != 3)  /* Hardcoded value as the next lines depend on it. */
-        || RT_FAILURE(paParms[0].getString(&pchPatterns, &cbPatterns))  /* patterns */
-        || RT_FAILURE(paParms[1].getBuffer((void **)&pchBuf, &cbBuf))  /* return buffer */
+        || RT_FAILURE(HGCMSvcGetCStr(&paParms[0], &pchPatterns, &cbPatterns))  /* patterns */
+        || RT_FAILURE(HGCMSvcGetBuf(&paParms[1], (void **)&pchBuf, &cbBuf))  /* return buffer */
        )
         rc = VERR_INVALID_PARAMETER;
@@ -989 +989 @@
         if (RT_SUCCESS(rc))
         {
-            paParms[2].setUInt32((uint32_t)(EnumData.cbNeeded + 4));
+            HGCMSvcSetU32(&paParms[2], (uint32_t)(EnumData.cbNeeded + 4));
             if (EnumData.cbLeft >= 4)
             {
@@ -1048 +1048 @@
     uint32_t cbBuf;
 
-    int rc = paParms[2].getBuffer((void **)&pchBuf, &cbBuf);
+    int rc = HGCMSvcGetBuf(&paParms[2], (void **)&pchBuf, &cbBuf);
     if (RT_SUCCESS(rc))
     {
@@ -1066 +1066 @@
             if (RT_SUCCESS(rc))
             {
-                paParms[1].setUInt64(u64Timestamp);
-                paParms[3].setUInt32((uint32_t)buffer.size());
+                HGCMSvcSetU64(&paParms[1], u64Timestamp);
+                HGCMSvcSetU32(&paParms[3], (uint32_t)buffer.size());
                 if (buffer.size() <= cbBuf)
                     buffer.copy(pchBuf, cbBuf);
@@ -1105 +1105 @@
     LogFlowThisFunc(("\n"));
     if (   cParms != 4  /* Hardcoded value as the next lines depend on it. */
-        || RT_FAILURE(paParms[0].getString(&pszPatterns, &cchPatterns))  /* patterns */
-        || RT_FAILURE(paParms[1].getUInt64(&u64Timestamp))  /* timestamp */
-        || RT_FAILURE(paParms[2].getBuffer((void **)&pchBuf, &cbBuf))  /* return buffer */
+        || RT_FAILURE(HGCMSvcGetStr(&paParms[0], &pszPatterns, &cchPatterns))  /* patterns */
+        || RT_FAILURE(HGCMSvcGetU64(&paParms[1], &u64Timestamp))  /* timestamp */
+        || RT_FAILURE(HGCMSvcGetBuf(&paParms[2], (void **)&pchBuf, &cbBuf))  /* return buffer */
        )
         rc = VERR_INVALID_PARAMETER;
@@ -1135 +1135 @@
                     const char *pszPatternsExisting;
                     uint32_t cchPatternsExisting;
-                    int rc3 = it->mParms[0].getString(&pszPatternsExisting, &cchPatternsExisting);
+                    int rc3 = HGCMSvcGetCStr(&it->mParms[0], &pszPatternsExisting, &cchPatternsExisting);
 
                     if (   RT_SUCCESS(rc3)
@@ -1213 +1213 @@
             const char *pszPatterns;
             uint32_t cchPatterns;
-            it->mParms[0].getString(&pszPatterns, &cchPatterns);
+            HGCMSvcGetCStr(&it->mParms[0], &pszPatterns, &cchPatterns);
             if (prop.Matches(pszPatterns))
             {
@@ -1529 +1529 @@
                 {
                     uint32_t fFlags;
-                    rc = paParms[0].getUInt32(&fFlags);
+                    rc = HGCMSvcGetU32(&paParms[0], &fFlags);
                     if (RT_SUCCESS(rc))
                         mfGlobalFlags = fFlags;

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

@@ -225 +225 @@
 
     VBOXHGCMSVCPARM aParms[4];
-    aParms[0].setPointer((void *)g_apcszNameBlock, 0);
-    aParms[1].setPointer((void *)g_apcszValueBlock, 0);
-    aParms[2].setPointer((void *)g_au64TimestampBlock, 0);
-    aParms[3].setPointer((void *)g_apcszFlagsBlock, 0);
+    HGCMSvcSetPv(&aParms[0], (void *)g_apcszNameBlock, 0);
+    HGCMSvcSetPv(&aParms[1], (void *)g_apcszValueBlock, 0);
+    HGCMSvcSetPv(&aParms[2], (void *)g_au64TimestampBlock, 0);
+    HGCMSvcSetPv(&aParms[3], (void *)g_apcszFlagsBlock, 0);
     RTTESTI_CHECK_RC(ptable->pfnHostCall(ptable->pvService, GUEST_PROP_FN_HOST_SET_PROPS, 4, &aParms[0]), VINF_SUCCESS);
 }
@@ -337 +337 @@
 
         /* Check that we get buffer overflow with a too small buffer. */
-        aParms[0].setPointer((void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cchPatterns);
-        aParms[1].setPointer((void *)abBuffer, g_aEnumStrings[i].cbBuffer - 1);
+        HGCMSvcSetPv(&aParms[0], (void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cchPatterns);
+        HGCMSvcSetPv(&aParms[1], (void *)abBuffer, g_aEnumStrings[i].cbBuffer - 1);
         memset(abBuffer, 0x55, sizeof(abBuffer));
         int rc2 = ptable->pfnHostCall(ptable->pvService, GUEST_PROP_FN_HOST_ENUM_PROPS, 3, aParms);
@@ -344 +344 @@
         {
             uint32_t cbNeeded;
-            RTTESTI_CHECK_RC(rc2 = aParms[2].getUInt32(&cbNeeded), VINF_SUCCESS);
+            RTTESTI_CHECK_RC(rc2 = HGCMSvcGetU32(&aParms[2], &cbNeeded), VINF_SUCCESS);
             if (RT_SUCCESS(rc2))
                 RTTESTI_CHECK_MSG(cbNeeded == g_aEnumStrings[i].cbBuffer,
@@ -353 +353 @@
 
         /* Make a successfull call. */
-        aParms[0].setPointer((void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cchPatterns);
-        aParms[1].setPointer((void *)abBuffer, g_aEnumStrings[i].cbBuffer);
+        HGCMSvcSetPv(&aParms[0], (void *)g_aEnumStrings[i].pszPatterns, g_aEnumStrings[i].cchPatterns);
+        HGCMSvcSetPv(&aParms[1], (void *)abBuffer, g_aEnumStrings[i].cbBuffer);
         memset(abBuffer, 0x55, sizeof(abBuffer));
         rc2 = ptable->pfnHostCall(ptable->pvService, GUEST_PROP_FN_HOST_ENUM_PROPS, 3, aParms);
@@ -416 +416 @@
     RTStrPrintf(szValue, sizeof(szValue), "%s", pcszValue);
     RTStrPrintf(szFlags, sizeof(szFlags), "%s", pcszFlags);
-    aParms[0].setString(szName);
-    aParms[1].setString(szValue);
-    aParms[2].setString(szFlags);
+    HGCMSvcSetStr(&aParms[0], szName);
+    HGCMSvcSetStr(&aParms[1], szValue);
+    HGCMSvcSetStr(&aParms[2], szFlags);
     if (isHost)
         callHandle.rc = pTable->pfnHostCall(pTable->pvService, command,
@@ -505 +505 @@
         command = GUEST_PROP_FN_HOST_DEL_PROP;
     VBOXHGCMSVCPARM aParms[1];
-    aParms[0].setString(pcszName);
+    HGCMSvcSetStr(&aParms[0], pcszName);
     if (isHost)
         callHandle.rc = pTable->pfnHostCall(pTable->pvService, command, 1, aParms);
@@ -606 +606 @@
         RTTESTI_CHECK_RETV(s_aGetProperties[i].cchValue < sizeof(szBuffer));
 
-        aParms[0].setString(s_aGetProperties[i].pcszName);
+        HGCMSvcSetStr(&aParms[0], s_aGetProperties[i].pcszName);
         memset(szBuffer, 0x55, sizeof(szBuffer));
-        aParms[1].setPointer(szBuffer, sizeof(szBuffer));
+        HGCMSvcSetPv(&aParms[1], szBuffer, sizeof(szBuffer));
         int rc2 = pTable->pfnHostCall(pTable->pvService, GUEST_PROP_FN_HOST_GET_PROP, 4, aParms);
 
@@ -630 +630 @@
 
             uint32_t u32ValueLen = UINT32_MAX;
-            RTTESTI_CHECK_RC(rc2 = aParms[3].getUInt32(&u32ValueLen), VINF_SUCCESS);
+            RTTESTI_CHECK_RC(rc2 = HGCMSvcGetU32(&aParms[3], &u32ValueLen), VINF_SUCCESS);
             if (RT_SUCCESS(rc2))
             {
@@ -643 +643 @@
             {
                 uint64_t u64Timestamp = UINT64_MAX;
-                RTTESTI_CHECK_RC(rc2 = aParms[2].getUInt64(&u64Timestamp), VINF_SUCCESS);
+                RTTESTI_CHECK_RC(rc2 = HGCMSvcGetU64(&aParms[2], &u64Timestamp), VINF_SUCCESS);
                 if (u64Timestamp != s_aGetProperties[i].u64Timestamp)
                     RTTestIFailed("Bad timestamp %llu for property '%s', expected %llu.",
@@ -700 +700 @@
         memset(pvBuf, 0x55, cbBuf);
 
-        aParms[0].setPointer((void *)s_szPattern, sizeof(s_szPattern));
-        aParms[1].setUInt64(1);
-        aParms[2].setPointer(pvBuf, cbBuf);
+        HGCMSvcSetPv(&aParms[0], (void *)s_szPattern, sizeof(s_szPattern));
+        HGCMSvcSetU64(&aParms[1], 1);
+        HGCMSvcSetPv(&aParms[2], pvBuf, cbBuf);
         pTable->pfnCall(pTable->pvService, &callHandle, 0, NULL, GUEST_PROP_FN_GET_NOTIFICATION, 4, aParms, 0);
 
         if (   callHandle.rc != VERR_BUFFER_OVERFLOW
-            || RT_FAILURE(aParms[3].getUInt32(&cbRetNeeded))
+            || RT_FAILURE(HGCMSvcGetU32(&aParms[3], &cbRetNeeded))
             || cbRetNeeded != g_aGetNotifications[0].cbBuffer
            )
@@ -726 +726 @@
         memset(pvBuf, 0x55, cbBuf);
 
-        aParms[0].setPointer((void *)s_szPattern, sizeof(s_szPattern));
-        aParms[1].setUInt64(u64Timestamp);
-        aParms[2].setPointer(pvBuf, cbBuf);
+        HGCMSvcSetPv(&aParms[0], (void *)s_szPattern, sizeof(s_szPattern));
+        HGCMSvcSetU64(&aParms[1], u64Timestamp);
+        HGCMSvcSetPv(&aParms[2], pvBuf, cbBuf);
         pTable->pfnCall(pTable->pvService, &callHandle, 0, NULL, GUEST_PROP_FN_GET_NOTIFICATION, 4, aParms, 0);
         if (   RT_FAILURE(callHandle.rc)
             || (i == 0 && callHandle.rc != VWRN_NOT_FOUND)
-            || RT_FAILURE(aParms[1].getUInt64(&u64Timestamp))
-            || RT_FAILURE(aParms[3].getUInt32(&cbRetNeeded))
+            || RT_FAILURE(HGCMSvcGetU64(&aParms[1], &u64Timestamp))
+            || RT_FAILURE(HGCMSvcGetU32(&aParms[3], &cbRetNeeded))
             || cbRetNeeded != g_aGetNotifications[i].cbBuffer
             || memcmp(pvBuf, g_aGetNotifications[i].pchBuffer, cbRetNeeded) != 0
@@ -764 +764 @@
     static char s_szPattern[] = "";
 
-    g_AsyncNotification.aParms[0].setPointer((void *)s_szPattern, sizeof(s_szPattern));
-    g_AsyncNotification.aParms[1].setUInt64(0);
-    g_AsyncNotification.aParms[2].setPointer((void *)g_AsyncNotification.abBuffer,
+    HGCMSvcSetPv(&g_AsyncNotification.aParms[0], (void *)s_szPattern, sizeof(s_szPattern));
+    HGCMSvcSetU64(&g_AsyncNotification.aParms[1], 0);
+    HGCMSvcSetPv(&g_AsyncNotification.aParms[2], (void *)g_AsyncNotification.abBuffer,
                                              sizeof(g_AsyncNotification.abBuffer));
     g_AsyncNotification.callHandle.rc = VINF_HGCM_ASYNC_EXECUTE;
@@ -786 +786 @@
     uint32_t u32Size;
     if (   g_AsyncNotification.callHandle.rc != VINF_SUCCESS
-        || RT_FAILURE(g_AsyncNotification.aParms[1].getUInt64(&u64Timestamp))
-        || RT_FAILURE(g_AsyncNotification.aParms[3].getUInt32(&u32Size))
+        || RT_FAILURE(HGCMSvcGetU64(&g_AsyncNotification.aParms[1], &u64Timestamp))
+        || RT_FAILURE(HGCMSvcGetU32(&g_AsyncNotification.aParms[3], &u32Size))
         || u32Size != g_aGetNotifications[0].cbBuffer
         || memcmp(g_AsyncNotification.abBuffer, g_aGetNotifications[0].pchBuffer, u32Size) != 0
@@ -834 +834 @@
 {
     VBOXHGCMSVCPARM paParm;
-    paParm.setUInt32(fFlags);
+    HGCMSvcSetU32(&paParm, fFlags);
     int rc = pTable->pfnHostCall(pTable->pvService, GUEST_PROP_FN_HOST_SET_GLOBAL_FLAGS, 1, &paParm);
     if (RT_FAILURE(rc))
@@ -1018 +1018 @@
 
             VBOXHGCMSVCPARM aParms[4];
-            aParms[0].setString(s_szProp);
-            aParms[1].setPointer(pvBuf, cbBuf);
+            HGCMSvcSetStr(&aParms[0], s_szProp);
+            HGCMSvcSetPv(&aParms[1], pvBuf, cbBuf);
             svcTable.pfnHostCall(svcTable.pvService, GUEST_PROP_FN_HOST_GET_PROP, RT_ELEMENTS(aParms), aParms);
 
@@ -1054 +1054 @@
 
             VBOXHGCMSVCPARM aParms[3];
-            aParms[0].setString("*");
-            aParms[1].setPointer(pvBuf, cbBuf);
+            HGCMSvcSetStr(&aParms[0], "*");
+            HGCMSvcSetPv(&aParms[1], pvBuf, cbBuf);
             svcTable.pfnHostCall(svcTable.pvService, GUEST_PROP_FN_HOST_ENUM_PROPS, RT_ELEMENTS(aParms), aParms);
 
@@ -1123 +1123 @@
             VBOXHGCMSVCPARM aParms[4];
             char            szBuffer[256];
-            aParms[0].setPointer(szProp, (uint32_t)cchProp + 1);
-            aParms[1].setPointer(szBuffer, sizeof(szBuffer));
+            HGCMSvcSetPv(&aParms[0], szProp, (uint32_t)cchProp + 1);
+            HGCMSvcSetPv(&aParms[1], szBuffer, sizeof(szBuffer));
             RTTESTI_CHECK_RC_BREAK(svcTable.pfnHostCall(svcTable.pvService, GUEST_PROP_FN_HOST_GET_PROP, 4, aParms), VINF_SUCCESS);
         }