Changeset 79050 in vbox for trunk/src/VBox/Main

Timestamp:

Jun 8, 2019 3:05:03 AM (6 years ago)

Author:

vboxsync

Message:

Main/GuestImpl: Added OnGuestAdditionsStatusChanged event so the validation kit can more efficiently wait on GAs to come online. bugref:9151

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (3 diffs)
• include/AdditionsFacilityImpl.h (modified) (1 diff)
• include/GuestImpl.h (modified) (1 diff)
• src-client/AdditionsFacilityImpl.cpp (modified) (2 diffs)
• src-client/GuestImpl.cpp (modified) (7 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -23657 +23657 @@
       </desc>
     </const>
-    <const name="OnGuestMonitorInfoChanged" value="101">
+    <const name="OnGuestAdditionsStatusChanged" value="101">
+      <desc>
+        See <link to="IGuestAdditionsStatusChangedEvent">IGuestAdditionsStatusChangedEvent</link>.
+      </desc>
+    </const>
+    <const name="OnGuestMonitorInfoChanged" value="102">
       <desc>
         See <link to="IGuestMonitorInfoChangedEvent">IGuestMonitorInfoChangedEvent</link>.
       </desc>
     </const>
-    <!-- Last event marker -->
-    <const name="Last" value="102">
+    <!-- End event marker -->
+    <!-- @todo rename to 'End' as it is exclusive (we use 'last' to be inclusive). -->
+    <const name="Last" value="103">
       <desc>
         Must be last event, used for iterations and structures relying on numerical event values.
@@ -25760 +25766 @@
 
   <interface
+    name="IGuestAdditionsStatusChangedEvent" extends="IEvent"
+    uuid="fd1a34ad-0b74-4e2b-ed0f-46222de8a883"
+    wsmap="managed" autogen="VBoxEvent" id="OnGuestAdditionsStatusChanged">
+    <desc>The guest addition status changed.</desc>
+
+    <attribute name="facility" type="AdditionsFacilityType" dir="in">
+      <desc>Facility this event relates to.</desc>
+    </attribute>
+    <attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
+      <desc>The new facility status.</desc>
+    </attribute>
+    <attribute name="runLevel" type="AdditionsRunLevelType" readonly="yes">
+      <desc>The new run level.</desc>
+    </attribute>
+    <attribute name="timestamp" type="long long" readonly="yes">
+      <desc>The millisecond timestamp associated with the event.</desc>
+    </attribute>
+  </interface>
+
+  <interface
     name="IGuestMonitorInfoChangedEvent" extends="IEvent"
     uuid="0b3cdeb2-808e-11e9-b773-133d9330f849"
@@ -25769 +25795 @@
     </attribute>
   </interface>
-
 
   <!--

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

@@ -65 +65 @@
     AdditionsFacilityStatus_T i_getStatus() const;
     AdditionsFacilityType_T i_getType() const;
-    void i_update(AdditionsFacilityStatus_T a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
+    bool i_update(AdditionsFacilityStatus_T a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
 
 private:

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

@@ -90 +90 @@
     void i_setAdditionsInfo2(uint32_t a_uFullVersion, const char *a_pszName, uint32_t a_uRevision, uint32_t a_fFeatures);
     bool i_facilityIsActive(VBoxGuestFacilityType enmFacility);
-    void i_facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
+    bool i_facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
                           uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS);
     ComObjPtr<Console> i_getConsole(void) { return mParent; }

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

@@ -205 +205 @@
 /**
  * Method used by IGuest::facilityUpdate to make updates.
- */
-void AdditionsFacility::i_update(AdditionsFacilityStatus_T a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS)
-{
+ *
+ * @returns change indicator.
+ */
+bool AdditionsFacility::i_update(AdditionsFacilityStatus_T a_enmStatus, uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS)
+{
+    bool const fChanged = mData.mStates.size() == 0
+                       || mData.mStates.back().mStatus != a_enmStatus;
+
     FacilityState state;
     state.mStatus    = a_enmStatus;
@@ -216 +221 @@
     if (mData.mStates.size() > 10) /* Only keep the last 10 states. */
         mData.mStates.erase(mData.mStates.begin());
-}
-
+
+    return fChanged;
+}
+

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

@@ -864 +864 @@
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-
     /*
      * Note: The Guest Additions API (interface) version is deprecated
@@ -899 +898 @@
              * interface version.
              */
-            i_facilityUpdate(VBoxGuestFacilityType_Graphics, VBoxGuestFacilityStatus_Active,  0 /*fFlags*/, &TimeSpecTS);
+            i_facilityUpdate(VBoxGuestFacilityType_Graphics, VBoxGuestFacilityStatus_Active, 0 /*fFlags*/, &TimeSpecTS);
         }
     }
@@ -931 +930 @@
     mData.mOSType = aOsType;
     mData.mOSTypeId = Global::OSTypeId(aOsType);
+
+    /*
+     * Always fire an event here.
+     */
+    AdditionsRunLevelType_T const enmRunLevel = mData.mAdditionsRunLevel;
+    alock.release();
+    fireGuestAdditionsStatusChangedEvent(mEventSource, AdditionsFacilityType_None, AdditionsFacilityStatus_Active,
+                                         enmRunLevel, RTTimeSpecGetMilli(&TimeSpecTS));
 }
 
@@ -989 +996 @@
 }
 
-void Guest::i_facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
+bool Guest::i_facilityUpdate(VBoxGuestFacilityType a_enmFacility, VBoxGuestFacilityStatus a_enmStatus,
                              uint32_t a_fFlags, PCRTTIMESPEC a_pTimeSpecTS)
 {
-    AssertReturnVoid(   a_enmFacility < VBoxGuestFacilityType_All
-                     && a_enmFacility > VBoxGuestFacilityType_Unknown);
-
+    AssertReturn(   a_enmFacility < VBoxGuestFacilityType_All
+                 && a_enmFacility > VBoxGuestFacilityType_Unknown, false);
+
+    bool fChanged;
     FacilityMapIter it = mData.mFacilityMap.find((AdditionsFacilityType_T)a_enmFacility);
     if (it != mData.mFacilityMap.end())
     {
         AdditionsFacility *pFac = it->second;
-        pFac->i_update((AdditionsFacilityStatus_T)a_enmStatus, a_fFlags, a_pTimeSpecTS);
+        fChanged = pFac->i_update((AdditionsFacilityStatus_T)a_enmStatus, a_fFlags, a_pTimeSpecTS);
     }
     else
@@ -1007 +1015 @@
             /* The easy way out for now. We could automatically destroy
                inactive facilities like VMMDev does if we like... */
-            AssertFailedReturnVoid();
+            AssertFailedReturn(false);
         }
 
         ComObjPtr<AdditionsFacility> ptrFac;
         ptrFac.createObject();
-        AssertReturnVoid(!ptrFac.isNull());
+        AssertReturn(!ptrFac.isNull(), false);
 
         HRESULT hrc = ptrFac->init(this, (AdditionsFacilityType_T)a_enmFacility, (AdditionsFacilityStatus_T)a_enmStatus,
                                    a_fFlags, a_pTimeSpecTS);
-        if (SUCCEEDED(hrc))
-            mData.mFacilityMap.insert(std::make_pair((AdditionsFacilityType_T)a_enmFacility, ptrFac));
-    }
+        AssertComRCReturn(hrc, false);
+        mData.mFacilityMap.insert(std::make_pair((AdditionsFacilityType_T)a_enmFacility, ptrFac));
+        fChanged = true;
+    }
+    return fChanged;
 }
 
@@ -1074 +1084 @@
      * Set a specific facility status.
      */
+    bool fFireEvent = false;
     if (a_enmFacility == VBoxGuestFacilityType_All)
         for (FacilityMapIter it = mData.mFacilityMap.begin(); it != mData.mFacilityMap.end(); ++it)
-            i_facilityUpdate((VBoxGuestFacilityType)it->first, a_enmStatus, a_fFlags, a_pTimeSpecTS);
+            fFireEvent |= i_facilityUpdate((VBoxGuestFacilityType)it->first, a_enmStatus, a_fFlags, a_pTimeSpecTS);
     else /* Update one facility only. */
-        i_facilityUpdate(a_enmFacility, a_enmStatus, a_fFlags, a_pTimeSpecTS);
+        fFireEvent = i_facilityUpdate(a_enmFacility, a_enmStatus, a_fFlags, a_pTimeSpecTS);
 
     /*
      * Recalc the runlevel.
      */
+    AdditionsRunLevelType_T const enmOldRunLevel = mData.mAdditionsRunLevel;
     if (i_facilityIsActive(VBoxGuestFacilityType_VBoxTrayClient))
         mData.mAdditionsRunLevel = AdditionsRunLevelType_Desktop;
@@ -1091 +1103 @@
     else
         mData.mAdditionsRunLevel = AdditionsRunLevelType_None;
+
+    /*
+     * Fire event if something actually changed.
+     */
+    AdditionsRunLevelType_T const enmNewRunLevel = mData.mAdditionsRunLevel;
+    if (fFireEvent || enmNewRunLevel != enmOldRunLevel)
+    {
+        alock.release();
+        fireGuestAdditionsStatusChangedEvent(mEventSource, (AdditionsFacilityType_T)a_enmFacility,
+                                             (AdditionsFacilityStatus_T)a_enmStatus, enmNewRunLevel,
+                                             RTTimeSpecGetMilli(a_pTimeSpecTS));
+    }
 }