Changeset 69991 in vbox for trunk/src/VBox/Additions/common/VBoxService

Timestamp:

Dec 7, 2017 4:54:23 PM (7 years ago)

Author:

vboxsync

Message:

VBoxServiceTimeSync.cpp: Dropped the number from --timesync-set-on-restore and added --timesync-no-set-on-restore for disabling it. This should be safe since it wasn't possible to specify 0 and nobody needed to set it to 1 as that was the default.

Location:

trunk/src/VBox/Additions/common/VBoxService

Files:

• VBoxServiceTimeSync.cpp (modified) (5 diffs)
• VBoxServiceUtils.cpp (modified) (5 diffs)
• VBoxServiceUtils.h (modified) (1 diff)

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceTimeSync.cpp

@@ -207 +207 @@
             || rc == VERR_NOT_FOUND)
         {
-            char *pszValue;
-            rc = VGSvcReadProp(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-start",
-                               &pszValue, NULL /* ppszFlags */, NULL /* puTimestamp */);
+            rc = VGSvcCheckPropExist(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-start");
             if (RT_SUCCESS(rc))
-            {
                 g_fTimeSyncSetNext = true;
-                RTStrFree(pszValue);
-            }
         }
         if (   RT_SUCCESS(rc)
             || rc == VERR_NOT_FOUND)
         {
-            uint32_t uValue;
-            rc = VGSvcReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-on-restore",
-                                     &uValue, 0 /*uMin*/, 1 /*uMax*/);
+            rc = VGSvcCheckPropExist(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-on-restore");
             if (RT_SUCCESS(rc))
-                g_fTimeSyncSetOnRestore = uValue != 0;
+                g_fTimeSyncSetOnRestore = true;
+        }
+        if (   RT_SUCCESS(rc)
+            || rc == VERR_NOT_FOUND)
+        {
+            rc = VGSvcCheckPropExist(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-no-set-on-restore");
+            if (RT_SUCCESS(rc))
+                g_fTimeSyncSetOnRestore = false;
         }
         if (   RT_SUCCESS(rc)
@@ -274 +274 @@
 static DECLCALLBACK(int) vgsvcTimeSyncOption(const char **ppszShort, int argc, char **argv, int *pi)
 {
-    int rc = -1;
-    uint32_t value;
+    int rc = VINF_SUCCESS;
     if (ppszShort)
-        /* no short options */;
+        rc = -1 ;/* no short options */
     else if (!strcmp(argv[*pi], "--timesync-interval"))
         rc = VGSvcArgUInt32(argc, argv, "", pi, &g_TimeSyncInterval, 50, UINT32_MAX - 1);
@@ -289 +288 @@
         rc = VGSvcArgUInt32(argc, argv, "", pi, &g_TimeSyncSetThreshold, 0, 7*24*60*60*1000); /* a week */
     else if (!strcmp(argv[*pi], "--timesync-set-start"))
-    {
         g_fTimeSyncSetNext = true;
-        rc = VINF_SUCCESS;
-    }
     else if (!strcmp(argv[*pi], "--timesync-set-on-restore"))
-    {
-        rc = VGSvcArgUInt32(argc, argv, "", pi, &value, 1, 1);
-        if (RT_SUCCESS(rc))
-            g_fTimeSyncSetOnRestore = !!value;
-    }
+        g_fTimeSyncSetOnRestore = true;
+    else if (!strcmp(argv[*pi], "--timesync-no-set-on-restore"))
+        g_fTimeSyncSetOnRestore = false;
+    else
+        rc = -1;
 
     return rc;
@@ -733 +729 @@
     "              [--timesync-latency-factor <x>] [--timesync-max-latency <ms>]\n"
     "              [--timesync-set-threshold <ms>] [--timesync-set-start]\n"
-    "              [--timesync-set-on-restore 0|1]"
+    "              [--timesync-set-on-restore|--timesync-no-set-on-restore]"
     ,
     /* pszOptions. */
@@ -752 +748 @@
     "                            adjust it. The default is 20 min.\n"
     "    --timesync-set-start    Set the time when starting the time sync service.\n"
-    "    --timesync-set-on-restore 0|1\n"
-    "                            Immediately set the time when the VM was restored.\n"
-    "                            1 = set (default), 0 = don't set.\n"
+    "    --timesync-set-on-restore, --timesync-no-set-on-restore\n"
+    "                            Whether to immediately set the time when the VM is\n"
+    "                            restored or not.  Default: --timesync-set-on-restore\n"
     ,
     /* methods */

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceUtils.cpp

@@ -43 +43 @@
  * @param   pszPropName         The property name.
  * @param   ppszValue           Where to return the value.  This is always set
- *                              to NULL.  Free it using RTStrFree().
+ *                              to NULL.  Free it using RTStrFree().  Optional.
  * @param   ppszFlags           Where to return the value flags. Free it
  *                              using RTStrFree().  Optional.
@@ -52 +52 @@
 {
     AssertPtrReturn(pszPropName, VERR_INVALID_POINTER);
-    AssertPtrReturn(ppszValue, VERR_INVALID_POINTER);
 
     uint32_t    cbBuf = _1K;
@@ -58 +57 @@
     int         rc    = VINF_SUCCESS;  /* MSC can't figure out the loop */
 
-    *ppszValue = NULL;
+    if (ppszValue)
+        *ppszValue = NULL;
 
     for (unsigned cTries = 0; cTries < 10; cTries++)
@@ -93 +93 @@
 
         VGSvcVerbose(2, "Guest Property: Read '%s' = '%s', timestamp %RU64n\n", pszPropName, pszValue, uTimestamp);
-        *ppszValue = RTStrDup(pszValue);
-        if (!*ppszValue)
-        {
-            VGSvcError("Guest Property: RTStrDup failed for '%s'\n", pszValue);
-            rc = VERR_NO_MEMORY;
-            break;
+        if (ppszValue)
+        {
+            *ppszValue = RTStrDup(pszValue);
+            if (!*ppszValue)
+            {
+                VGSvcError("Guest Property: RTStrDup failed for '%s'\n", pszValue);
+                rc = VERR_NO_MEMORY;
+                break;
+            }
         }
 
@@ -139 +142 @@
     }
     return rc;
+}
+
+/**
+ * Checks if @a pszPropName exists.
+ *
+ * @returns VBox status code.
+ * @retval  VINF_SUCCESS if it exists.
+ * @retval  VERR_NOT_FOUND if not found.
+ *
+ * @param   u32ClientId         The HGCM client ID for the guest property session.
+ * @param   pszPropName         The property name.
+ */
+int VGSvcCheckPropExist(uint32_t u32ClientId, const char *pszPropName)
+{
+    return VGSvcReadProp(u32ClientId, pszPropName, NULL /*ppszValue*/, NULL /* ppszFlags */, NULL /* puTimestamp */);
 }
 

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceUtils.h

@@ -24 +24 @@
 int VGSvcReadProp(uint32_t u32ClientId, const char *pszPropName, char **ppszValue, char **ppszFlags, uint64_t *puTimestamp);
 int VGSvcReadPropUInt32(uint32_t u32ClientId, const char *pszPropName, uint32_t *pu32, uint32_t u32Min, uint32_t u32Max);
+int VGSvcCheckPropExist(uint32_t u32ClientId, const char *pszPropName);
 int VGSvcReadHostProp(uint32_t u32ClientId, const char *pszPropName, bool fReadOnly, char **ppszValue, char **ppszFlags,
                       uint64_t *puTimestamp);