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

Timestamp:

Dec 5, 2018 12:08:09 PM (6 years ago)

Author:

vboxsync

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

127186

Message:

HGCM,GuestProps: Added HGCM service notifications for VM power-on, VM resume, VM suspend, VM reset and VM power-off. Made use of the first two in guest properties to wake up guest programs waiting on any of the host version properties. Also moved inserting sysprep and host version properties to the services as that's a better home than ConsoleImpl/VMMDevInterface in my opinion.

File:

• trunk/src/VBox/HostServices/GuestProperties/service.cpp (modified) (15 diffs)

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

@@ -45 +45 @@
 #include <iprt/asm.h>
 #include <iprt/assert.h>
+#include <iprt/buildconfig.h>
 #include <iprt/cpp/autores.h>
 #include <iprt/cpp/utils.h>
@@ -54 +55 @@
 #include <iprt/time.h>
 #include <VBox/vmm/dbgf.h>
+#include <VBox/version.h>
 
 #include <string>
@@ -97 +99 @@
              uint32_t u32Flags)
         : mName(name), mValue(value), mTimestamp(u64Timestamp),
-          mFlags(u32Flags) {}
+          mFlags(u32Flags)
+    {}
 
     /** Does the property name match one of a set of patterns? */
@@ -195 +198 @@
      * values: {(mPrevTimestamp - mcTimestampAdjustments), ..., mPrevTimestamp} */
     uint64_t mcTimestampAdjustments;
+    /** For helping setting host version properties _after_ restoring VMs. */
+    bool m_fSetHostVersionProps;
 
     /**
@@ -311 +316 @@
         , mPrevTimestamp(0)
         , mcTimestampAdjustments(0)
+        , m_fSetHostVersionProps(false)
 #ifdef ASYNC_HOST_NOTIFY
         , mhThreadNotifyHost(NIL_RTTHREAD)
@@ -409 +415 @@
     }
 
+    void setHostVersionProps();
+    static DECLCALLBACK(void) svcNotify(void *pvService, HGCMNOTIFYEVENT enmEvent);
+
     int initialize();
 
@@ -419 +428 @@
     int getProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
     int setProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool isGuest);
+    int setPropertyInternal(const char *pcszName, const char *pcszValue, uint32_t fFlags, uint64_t nsTimestamp, bool fIsGuest);
     int delProperty(uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool isGuest);
     int enumProps(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
@@ -749 +759 @@
 
     /*
+     * Hand it over to the internal setter method.
+     */
+    rc = setPropertyInternal(pcszName, pcszValue, fFlags, u64TimeNano, isGuest);
+
+    LogFlowThisFunc(("%s=%s, rc=%Rrc\n", pcszName, pcszValue, rc));
+    return rc;
+}
+
+/**
+ * Internal property setter.
+ *
+ * @returns VBox status code.
+ * @param   pcszName            The property name.
+ * @param   pcszValue           The new value.
+ * @param   fFlags              The flags.
+ * @param   nsTimestamp         The timestamp.
+ * @param   fIsGuest            Is it the guest calling.
+ * @throws  std::bad_alloc  if an out of memory condition occurs
+ * @thread  HGCM
+ */
+int Service::setPropertyInternal(const char *pcszName, const char *pcszValue, uint32_t fFlags, uint64_t nsTimestamp, bool fIsGuest)
+{
+    /*
      * If the property already exists, check its flags to see if we are allowed
      * to change it.
      */
     Property *pProp = getPropertyInternal(pcszName);
-    rc = checkPermission(pProp ? pProp->mFlags : GUEST_PROP_F_NILFLAG, isGuest);
+    int rc = checkPermission(pProp ? pProp->mFlags : GUEST_PROP_F_NILFLAG, fIsGuest);
     /*
      * Handle names which are read-only for the guest.
@@ -759 +792 @@
     if (rc == VINF_SUCCESS && checkHostReserved(pcszName))
     {
-        if (isGuest)
+        if (fIsGuest)
             rc = VERR_PERMISSION_DENIED;
         else
@@ -772 +805 @@
         {
             pProp->mValue = pcszValue;
-            pProp->mTimestamp = u64TimeNano;
+            pProp->mTimestamp = nsTimestamp;
             pProp->mFlags = fFlags;
         }
@@ -780 +813 @@
             {
                 /* Create a new string space record. */
-                pProp = new Property(pcszName, pcszValue, u64TimeNano, fFlags);
+                pProp = new Property(pcszName, pcszValue, nsTimestamp, fFlags);
                 AssertPtr(pProp);
 
@@ -804 +837 @@
          * Send a notification to the guest and host and return.
          */
-        // if (isGuest)  /* Notify the host even for properties that the host
+        // if (fIsGuest) /* Notify the host even for properties that the host
         //                * changed.  Less efficient, but ensures consistency. */
-        int rc2 = doNotifications(pcszName, u64TimeNano);
+        int rc2 = doNotifications(pcszName, nsTimestamp);
         if (RT_SUCCESS(rc))
             rc = rc2;
@@ -1564 +1597 @@
 }
 
+
+/**
+ * Sets the VBoxVer, VBoxVerExt and VBoxRev properties.
+ */
+void Service::setHostVersionProps()
+{
+    uint64_t nsTimestamp = getCurrentTimestamp();
+
+    /* Set the raw VBox version string as a guest property. Used for host/guest
+     * version comparison. */
+    setPropertyInternal("/VirtualBox/HostInfo/VBoxVer", VBOX_VERSION_STRING_RAW,
+                        GUEST_PROP_F_TRANSIENT | GUEST_PROP_F_RDONLYGUEST, nsTimestamp, false /*fIsGuest*/);
+
+    /* Set the full VBox version string as a guest property. Can contain vendor-specific
+     * information/branding and/or pre-release tags. */
+    setPropertyInternal("/VirtualBox/HostInfo/VBoxVerExt", VBOX_VERSION_STRING,
+                        GUEST_PROP_F_TRANSIENT | GUEST_PROP_F_RDONLYGUEST, nsTimestamp, false /*fIsGuest*/);
+
+    /* Set the VBox SVN revision as a guest property */
+    setPropertyInternal("/VirtualBox/HostInfo/VBoxRev", RTBldCfgRevisionStr(),
+                        GUEST_PROP_F_TRANSIENT | GUEST_PROP_F_RDONLYGUEST, nsTimestamp, false /*fIsGuest*/);
+}
+
+
+/**
+ * @interface_method_impl{VBOXHGCMSVCFNTABLE,pfnNotify}
+ */
+/*static*/ DECLCALLBACK(void) Service::svcNotify(void *pvService, HGCMNOTIFYEVENT enmEvent)
+{
+    SELF *pThis = reinterpret_cast<SELF *>(pvService);
+    AssertPtrReturnVoid(pThis);
+
+    /* Make sure the host version properties have been touched and are
+       up-to-date after a restore: */
+    if (   !pThis->m_fSetHostVersionProps
+        && (enmEvent == HGCMNOTIFYEVENT_RESUME || enmEvent == HGCMNOTIFYEVENT_POWER_ON))
+    {
+        pThis->setHostVersionProps();
+        pThis->m_fSetHostVersionProps = true;
+    }
+
+    /** @todo add suspend/resume property? */
+    /** @todo add reset counter? */
+}
+
+
 #ifdef ASYNC_HOST_NOTIFY
 
@@ -1602 +1681 @@
 int Service::initialize()
 {
+    /*
+     * Insert standard host properties.
+     */
+    try
+    {
+        /* The host version will but updated again on power on or resume
+           (after restore), however we need the properties now for restored
+           guest notification/wait calls. */
+        setHostVersionProps();
+
+        /* Sysprep execution by VBoxService (host is allowed to change these). */
+        uint64_t nsTimestamp = getCurrentTimestamp();
+        setPropertyInternal("/VirtualBox/HostGuest/SysprepExec", "", GUEST_PROP_F_TRANSIENT | GUEST_PROP_F_RDONLYGUEST,
+                            nsTimestamp, false /*fIsGuest*/);
+        setPropertyInternal("/VirtualBox/HostGuest/SysprepArgs", "", GUEST_PROP_F_TRANSIENT | GUEST_PROP_F_RDONLYGUEST,
+                            nsTimestamp, false /*fIsGuest*/);
+    }
+    catch (std::bad_alloc &)
+    {
+        return VERR_NO_MEMORY;
+    }
+
 #ifdef ASYNC_HOST_NOTIFY
     /* The host notification thread and queue. */
@@ -1728 +1829 @@
                 ptable->pfnLoadState          = NULL;  /* construction done before restoring suffices */
                 ptable->pfnRegisterExtension  = Service::svcRegisterExtension;
+                ptable->pfnNotify             = Service::svcNotify;
                 ptable->pvService             = pService;