Changeset 36178 in vbox for trunk/src

Timestamp:

Mar 7, 2011 9:45:24 AM (14 years ago)

Author:

vboxsync

Message:

Main/VBoxManage/Guest Additions: Added support for "TRANSIENT_RESET" guest properties which are only present until a VM reset.

Location:

trunk/src/VBox

Files:

• Additions/common/VBoxService/VBoxServicePropCache.cpp (modified) (2 diffs)
• Additions/common/VBoxService/VBoxServicePropCache.h (modified) (2 diffs)
• Main/include/ConsoleImpl.h (modified) (1 diff)
• Main/src-client/ConsoleImpl.cpp (modified) (5 diffs)
• Main/src-server/MachineImpl.cpp (modified) (3 diffs)

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

@@ -105 +105 @@
                  * gets deleted when the property cache did not have the chance to
                  * gracefully clean it up (due to a hard VM reset etc), so set this
-                 * guest property using the TRANSIENT flag.
+                 * guest property using the TRANSIENT and TRANSIENT_RESET flags.
                  */
-                rc = VbglR3GuestPropWrite(u32ClientId, pszName, pszValue, "TRANSIENT");
+                rc = VbglR3GuestPropWrite(u32ClientId, pszName, pszValue, "TRANSIENT,TRANSIENT_RESET");
+                if (rc == VERR_PARSE_ERROR)
+                {
+                    /* Host does not support the "TRANSIENT_RESET" flag, so only
+                     * use the "TRANSIENT" flag* -- better than nothing :-). */
+                    rc = VbglR3GuestPropWrite(u32ClientId, pszName, pszValue, "TRANSIENT");
+                }
             }
             else
@@ -377 +383 @@
             /*
              * When destroying the cache and we have a temporary value, remove the
-             * (eventually) set TRANSIENT flag from it so that it doesn't get deleted
+             * (eventually) set TRANSIENT_RESET flag from it so that it doesn't get deleted
              * by the host side in order to put the actual reset value in it.
              */

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

@@ -21 +21 @@
 #include "VBoxServiceInternal.h"
 
-#ifdef VBOX_WITH_GUEST_PROPS
+# ifdef VBOX_WITH_GUEST_PROPS
 
+/** Indicates wheter a guest property is temporary and either should
+ *  get deleted when
+ *  - a) the property cache gets destroyed, or
+ *  - b) the VM gets a hard reset / shutdown
+ *  or gets a default "reset" value (if specified via VBoxServicePropCacheUpdateEntry)
+ *  when the property cache gets properly destroyed.
+ */
 #define VBOXSERVICEPROPCACHEFLAG_TEMPORARY          RT_BIT(1)
+/** Indicates whether a property every time needs to be updated, regardless
+ *  if its real value changed or not. */
 #define VBOXSERVICEPROPCACHEFLAG_ALWAYS_UPDATE      RT_BIT(2)
 
@@ -32 +41 @@
 int VBoxServicePropCacheFlush(PVBOXSERVICEVEPROPCACHE pCache);
 void VBoxServicePropCacheDestroy(PVBOXSERVICEVEPROPCACHE pCache);
-#endif
+# endif /* VBOX_WITH_GUEST_PROPS */
 
-#endif
+#endif  /* ___VBoxServicePropCache_h */
 

trunk/src/VBox/Main/include/ConsoleImpl.h

@@ -619 +619 @@
                                                            ComSafeArrayOut(BSTR, aFlags));
 
-    bool enabledGuestPropertiesVRDP(void);
-    void updateGuestPropertiesVRDPLogon(uint32_t u32ClientId, const char *pszUser, const char *pszDomain);
-    void updateGuestPropertiesVRDPDisconnect(uint32_t u32ClientId);
+    void guestPropertiesHandleVMReset(void);
+    bool guestPropertiesVRDPEnabled(void);
+    void guestPropertiesVRDPUpdateLogon(uint32_t u32ClientId, const char *pszUser, const char *pszDomain);
+    void guestPropertiesVRDPUpdateDisconnect(uint32_t u32ClientId);
 #endif
 

trunk/src/VBox/Main/src-client/ConsoleImpl.cpp

@@ -673 +673 @@
 #ifdef VBOX_WITH_GUEST_PROPS
 
-bool Console::enabledGuestPropertiesVRDP(void)
+/**
+ * Handles guest properties on a VM reset.
+ * At the moment we only delete properties which have the flag
+ * "TRARESET".
+ */
+void Console::guestPropertiesHandleVMReset(void)
+{
+    com::SafeArray<BSTR>   arrNames;
+    com::SafeArray<BSTR>   arrValues;
+    com::SafeArray<LONG64> arrTimestamps;
+    com::SafeArray<BSTR>   arrFlags;
+    HRESULT hrc = enumerateGuestProperties(Bstr("*").raw(),
+                                           ComSafeArrayAsOutParam(arrNames),
+                                           ComSafeArrayAsOutParam(arrValues),
+                                           ComSafeArrayAsOutParam(arrTimestamps),
+                                           ComSafeArrayAsOutParam(arrFlags));
+    if (SUCCEEDED(hrc))
+    {
+        for (size_t i = 0; i < arrFlags.size(); i++)
+        {
+            /* Delete all properties which have the flag "TRARESET". */
+            if (Utf8Str(arrFlags[i]).contains("TRANSIENT_RESET", Utf8Str::CaseInsensitive))
+            {
+                hrc = mMachine->SetGuestProperty(arrNames[i], Bstr("").raw() /* Value */,
+                                                 Bstr("").raw() /* Flags */);
+                if (FAILED(hrc))
+                    LogRel(("RESET: Could not delete transient property \"%ls\", rc=%Rhrc\n",
+                            arrNames[i], hrc));
+            }
+        }
+    }
+    else
+        LogRel(("RESET: Unable to enumerate guest properties, rc=%Rhrc\n", hrc));
+}
+
+bool Console::guestPropertiesVRDPEnabled(void)
 {
     Bstr value;
     HRESULT hrc = mMachine->GetExtraData(Bstr("VBoxInternal2/EnableGuestPropertiesVRDP").raw(),
                                          value.asOutParam());
-    if (hrc == S_OK)
-    {
-        if (value == "1")
-        {
-            return true;
-        }
-    }
+    if (   hrc   == S_OK
+        && value == "1")
+        return true;
     return false;
 }
 
-void Console::updateGuestPropertiesVRDPLogon(uint32_t u32ClientId, const char *pszUser, const char *pszDomain)
-{
-    if (!enabledGuestPropertiesVRDP())
-    {
+void Console::guestPropertiesVRDPUpdateLogon(uint32_t u32ClientId, const char *pszUser, const char *pszDomain)
+{
+    if (!guestPropertiesVRDPEnabled())
         return;
-    }
 
     char szPropNm[256];
@@ -725 +754 @@
 }
 
-void Console::updateGuestPropertiesVRDPDisconnect(uint32_t u32ClientId)
-{
-    if (!enabledGuestPropertiesVRDP())
+void Console::guestPropertiesVRDPUpdateDisconnect(uint32_t u32ClientId)
+{
+    if (!guestPropertiesVRDPEnabled())
         return;
 
@@ -961 +990 @@
 
 #ifdef VBOX_WITH_GUEST_PROPS
-    updateGuestPropertiesVRDPLogon(u32ClientId, pszUser, pszDomain);
+    guestPropertiesVRDPUpdateLogon(u32ClientId, pszUser, pszDomain);
 #endif /* VBOX_WITH_GUEST_PROPS */
 
@@ -1096 +1125 @@
 
 #ifdef VBOX_WITH_GUEST_PROPS
-    updateGuestPropertiesVRDPDisconnect(u32ClientId);
+    guestPropertiesVRDPUpdateDisconnect(u32ClientId);
 #endif /* VBOX_WITH_GUEST_PROPS */
 
@@ -6768 +6797 @@
                     break;
             }
+            break;
+        }
+
+        case VMSTATE_RESETTING:
+        {
+    #ifdef VBOX_WITH_GUEST_PROPS
+            /* Do not take any read/write locks here! */
+            that->guestPropertiesHandleVMReset();
+    #endif
             break;
         }

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -5009 +5009 @@
                       /** @todo Fix when adding DeleteGuestProperty(),
                                    see defect. */
-                      *aValue ? aValue : NULL, aFlags, true /* isSetter */,
+                      *aValue ? aValue : NULL, *aFlags ? aFlags : NULL,
+                      true /* isSetter */,
                       &dummy, &dummy64, &dummy);
     }
@@ -8652 +8653 @@
                     || mData->mMachineState == MachineState_Aborted
                     || mData->mMachineState == MachineState_Teleported)
-                && property.mFlags & guestProp::TRANSIENT)
+                && (   property.mFlags & guestProp::TRANSIENT
+                    || property.mFlags & guestProp::TRANSIENT_RESET))
                 continue;
             settings::GuestProperty prop;
@@ -12217 +12219 @@
             for (it = mHWData->mGuestProperties.begin();
                  it != mHWData->mGuestProperties.end(); ++it)
-                if (it->mFlags & guestProp::TRANSIENT)
+                if (   (it->mFlags & guestProp::TRANSIENT)
+                    || (it->mFlags & guestProp::TRANSIENT_RESET))
                 {
                     fNeedsSaving = true;