/**
* Reads a guest property as a 32-bit value.
*
* @returns VBox status code, fully bitched.
*
* @param u32ClientId The HGCM client ID for the guest property session.
* @param pszPropName The property name.
* @param pu32 Where to store the 32-bit value.
*
*/
int VBoxServiceReadPropUInt32(uint32_t u32ClientId, const char *pszPropName,
uint32_t *pu32, uint32_t u32Min, uint32_t u32Max)
{
char *pszValue;
int rc = VBoxServiceReadProp(u32ClientId, pszPropName, &pszValue,
NULL /* ppszFlags */, NULL /* puTimestamp */);
if (RT_SUCCESS(rc))
{
char *pszNext;
rc = RTStrToUInt32Ex(pszValue, &pszNext, 0, pu32);
if ( RT_SUCCESS(rc)
&& (*pu32 < u32Min || *pu32 > u32Max))
{
rc = VBoxServiceError("The guest property value %s = %RU32 is out of range [%RU32..%RU32].\n",
pszPropName, *pu32, u32Min, u32Max);
}
RTStrFree(pszValue);
}
return rc;
}
/**
* Reads a guest property from the host side.
*
* @returns VBox status code, fully bitched.
*
* @param u32ClientId The HGCM client ID for the guest property session.
* @param pszPropName The property name.
* @param fReadOnly Whether or not this property needs to be read only
* by the guest side. Otherwise VERR_ACCESS_DENIED will
* be returned.
* @param ppszValue Where to return the value. This is always set
* to NULL. Free it using RTStrFree().
* @param ppszFlags Where to return the value flags. Free it
* using RTStrFree(). Optional.
* @param puTimestamp Where to return the timestamp. This is only set
* on success. Optional.
*/
int VBoxServiceReadHostProp(uint32_t u32ClientId, const char *pszPropName, bool fReadOnly,
char **ppszValue, char **ppszFlags, uint64_t *puTimestamp)
{
AssertPtrReturn(ppszValue, VERR_INVALID_PARAMETER);
char *pszValue = NULL;
char *pszFlags = NULL;
int rc = VBoxServiceReadProp(u32ClientId, pszPropName, &pszValue, &pszFlags, puTimestamp);
if (RT_SUCCESS(rc))
{
/* Check security bits. */
if ( fReadOnly /* Do we except a guest read-only property */
&& !RTStrStr(pszFlags, "RDONLYGUEST"))
{
/* If we want a property which is read-only on the guest
* and it is *not* marked as such, deny access! */
rc = VERR_ACCESS_DENIED;
}
if (RT_SUCCESS(rc))
{
*ppszValue = pszValue;
if (ppszFlags)
*ppszFlags = pszFlags;
else if (pszFlags)
RTStrFree(pszFlags);
}
else
{
if (pszValue)
RTStrFree(pszValue);
if (pszFlags)
RTStrFree(pszFlags);
}
}
return rc;
}
/** @copydoc VBOXSERVICE::pfnPreInit */
static DECLCALLBACK(int) VBoxServiceTimeSyncPreInit(void)
{
#ifdef VBOX_WITH_GUEST_PROPS
/** @todo Merge this function with VBoxServiceTimeSyncOption() to generalize
* the "command line args override guest property values" behavior. */
/*
* Read the service options from the VM's guest properties.
* Note that these options can be overridden by the command line options later.
*/
uint32_t uGuestPropSvcClientID;
int rc = VbglR3GuestPropConnect(&uGuestPropSvcClientID);
if (RT_FAILURE(rc))
{
if (rc == VERR_HGCM_SERVICE_NOT_FOUND) /* Host service is not available. */
{
VBoxServiceVerbose(0, "VMInfo: Guest property service is not available, skipping\n");
rc = VINF_SUCCESS;
}
else
VBoxServiceError("Failed to connect to the guest property service! Error: %Rrc\n", rc);
}
else
{
rc = VBoxServiceReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-interval",
&g_TimeSyncInterval, 50, UINT32_MAX - 1);
if ( RT_SUCCESS(rc)
|| rc == VERR_NOT_FOUND)
{
rc = VBoxServiceReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-min-adjust",
&g_TimeSyncMinAdjust, 0, 3600000);
}
if ( RT_SUCCESS(rc)
|| rc == VERR_NOT_FOUND)
{
rc = VBoxServiceReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-latency-factor",
&g_TimeSyncLatencyFactor, 1, 1024);
}
if ( RT_SUCCESS(rc)
|| rc == VERR_NOT_FOUND)
{
rc = VBoxServiceReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-max-latency",
&g_TimeSyncMaxLatency, 1, 3600000);
}
if ( RT_SUCCESS(rc)
|| rc == VERR_NOT_FOUND)
{
rc = VBoxServiceReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-threshold",
&g_TimeSyncSetThreshold, 0, 7*24*60*60*1000 /* a week */);
}
if ( RT_SUCCESS(rc)
|| rc == VERR_NOT_FOUND)
{
char *pszValue;
rc = VBoxServiceReadProp(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-start",
&pszValue, NULL /* ppszFlags */, NULL /* puTimestamp */);
if (RT_SUCCESS(rc))
{
g_fTimeSyncSetNext = true;
RTStrFree(pszValue);
}
}
if ( RT_SUCCESS(rc)
|| rc == VERR_NOT_FOUND)
{
uint32_t value;
rc = VBoxServiceReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--timesync-set-on-restore",
&value, 1, 1);
if (RT_SUCCESS(rc))
g_fTimeSyncSetOnRestore = !!value;
}
VbglR3GuestPropDisconnect(uGuestPropSvcClientID);
}
if (rc == VERR_NOT_FOUND) /* If a value is not found, don't be sad! */
rc = VINF_SUCCESS;
return rc;
#else
/* Nothing to do here yet. */
return VINF_SUCCESS;
#endif
}
