Changeset 31572 in vbox

Timestamp:

Aug 11, 2010 2:08:41 PM (14 years ago)

Author:

vboxsync

Message:

events: vacation-time idea of reusable events (for perfomance-critical operations)

Location:

trunk/src/VBox/Main

Files:

• EventImpl.cpp (modified) (1 diff)
• idl/VirtualBox.xidl (modified) (3 diffs)
• idl/comimpl.xsl (modified) (10 diffs)
• include/EventImpl.h (modified) (2 diffs)

trunk/src/VBox/Main/EventImpl.cpp

@@ -684 +684 @@
         case VBoxEventType_Any:
             return TRUE;
+        case VBoxEventType_Vetoable:
+            return     (what == VBoxEventType_OnExtraDataCanChange)
+                    || (what == VBoxEventType_OnCanShowWindow);
         case VBoxEventType_MachineEvent:
             return     (what == VBoxEventType_OnMachineStateChanged)

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

@@ -13671 +13671 @@
     <const name="Any" value="1">
       <desc>
-        Wildcard for all events. Events of this type are never delivered, and only used in
+        Wildcard for all events.
+        Events of this type are never delivered, and only used in
         registerListener() call to simplify registration.
       </desc>
     </const>
 
-    <const name="MachineEvent" value="2">
+    <const name="Vetoable" value="2">
+      <desc>
+        Wildcard for all vetoable events. Events of this type are never delivered, and only
+        used in registerListener() call to simplify registration.
+      </desc>
+    </const>
+
+    <const name="MachineEvent" value="3">
       <desc>
         Wildcard for all machine events. Events of this type are never delivered, and only used in
@@ -13683 +13691 @@
     </const>
 
-    <const name="SnapshotEvent" value="3">
+    <const name="SnapshotEvent" value="4">
       <desc>
         Wildcard for all snapshot events. Events of this type are never delivered, and only used in
@@ -13690 +13698 @@
     </const>
 
-    <const name="InputEvent" value="4">
+    <const name="InputEvent" value="5">
       <desc>
         Wildcard for all input device (keyboard, mouse) events.

trunk/src/VBox/Main/idl/comimpl.xsl

@@ -240 +240 @@
   <xsl:choose>
     <xsl:when test="$extends='IEvent'">
+    </xsl:when>
+    <xsl:when test="$extends='IReusableEvent'">
     </xsl:when>
     <xsl:when test="//interface[@name=$extends]">
@@ -428 +430 @@
       <xsl:value-of select="   '    // skipping IEvent attributes &#10;'" />
     </xsl:when>
+    <xsl:when test="$extends='IReusableEvent'">
+      <xsl:value-of select="   '    // skipping IReusableEvent attributes &#10;'" />
+    </xsl:when>
+     <xsl:when test="$extends='IVetoEvent'">
+      <xsl:value-of select="   '    // skipping IVetoEvent attributes &#10;'" />
+    </xsl:when>
     <xsl:when test="//interface[@name=$extends]">
       <xsl:call-template name="genAttrCode">
@@ -446 +454 @@
   <xsl:param name="implName" />
   <xsl:param name="isVeto" />
+  <xsl:param name="isReusable" />
 
   <xsl:value-of select="concat('class ATL_NO_VTABLE ',$implName,
@@ -519 +528 @@
 ]]></xsl:text>
     </xsl:when>
+    <xsl:when test="$isReusable='yes'">
+      <xsl:text>
+<![CDATA[
+    HRESULT init(IEventSource* aSource, VBoxEventType_T aType, BOOL aWaitable = FALSE)
+    {
+        mGeneration = 1;
+        return mEvent->init(aSource, aType, aWaitable);
+    }
+    STDMETHOD(COMGETTER(Generation)) (ULONG *aGeneration)
+    {
+      *aGeneration = mGeneration;
+      return S_OK;
+    }
+    STDMETHOD(Reuse) ()
+    {
+       ASMAtomicIncU32(&mGeneration);
+       return S_OK;
+    }
+private:
+    volatile ULONG              mGeneration;
+    ComObjPtr<VBoxEvent>        mEvent;
+]]></xsl:text>
+    </xsl:when>
     <xsl:otherwise>
 <xsl:text><![CDATA[
@@ -548 +580 @@
 <xsl:template name="genSwitchCase">
   <xsl:param name="implName" />
+  <xsl:param name="reinit" />
   <xsl:variable name="waitable">
     <xsl:choose>
@@ -560 +593 @@
   <xsl:value-of select="concat('         case VBoxEventType_', @id, ':&#10;')"/>
   <xsl:value-of select="       '         {&#10;'"/>
-  <xsl:value-of select="concat('              ComObjPtr&lt;', $implName, '&gt; obj;&#10;')"/>
-  <xsl:value-of select="       '              obj.createObject();&#10;'"/>
-  <xsl:value-of select="concat('              obj->init(aSource, aType, ', $waitable, ');&#10;')"/>
+  <xsl:choose>
+    <xsl:when test="$reinit='yes'">
+      <xsl:value-of select="concat('              ComPtr&lt;', $implName, '&gt; obj;&#10;')"/>
+      <xsl:value-of select="       '              obj = mEvent;&#10;'"/>
+      <xsl:value-of select="       '              Assert(obj);&#10;'"/>
+      <xsl:value-of select="       '              obj->Reuse();&#10;'"/>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:value-of select="concat('              ComObjPtr&lt;', $implName, '&gt; obj;&#10;')"/>
+      <xsl:value-of select="       '              obj.createObject();&#10;'"/>
+      <xsl:value-of select="concat('              obj->init(aSource, aType, ', $waitable, ');&#10;')"/>
+    </xsl:otherwise>
+  </xsl:choose>
   <xsl:call-template name="genAttrInitCode">
     <xsl:with-param name="name" select="@name" />
     <xsl:with-param name="obj" select="'obj'" />
   </xsl:call-template>
-  <xsl:value-of select="       '              obj.queryInterfaceTo(mEvent.asOutParam());&#10;'"/>
+  <xsl:if test="not($reinit='yes')">
+    <xsl:value-of select="       '              obj.queryInterfaceTo(mEvent.asOutParam());&#10;'"/>
+  </xsl:if>
   <xsl:value-of select="       '              break;&#10;'"/>
   <xsl:value-of select="       '         }&#10;'"/>
@@ -590 +635 @@
     <xsl:call-template name="genSwitchCase">
       <xsl:with-param name="implName" select="$implName" />
+      <xsl:with-param name="reinit" select="'no'" />
     </xsl:call-template>
   </xsl:for-each>
@@ -595 +641 @@
   <xsl:text><![CDATA[
          default:
-            if (1) AssertFailed();
+            AssertFailed();
+    }
+    va_end(args);
+
+    return S_OK;
+}
+]]></xsl:text>
+
+ <xsl:text><![CDATA[
+HRESULT VBoxEventDesc::reinit(VBoxEventType_T aType, ...)
+{
+    va_list args;
+
+    va_start(args, aType);
+    switch (aType)
+    {
+]]></xsl:text>
+
+  <xsl:for-each select="//interface[@autogen=$G_kind and @extends='IReusableEvent']">
+    <xsl:variable name="implName">
+      <xsl:value-of select="substring(@name, 2)" />
+    </xsl:variable>
+    <xsl:call-template name="genSwitchCase">
+      <xsl:with-param name="implName" select="$implName" />
+      <xsl:with-param name="reinit" select="'yes'" />
+    </xsl:call-template>
+  </xsl:for-each>
+
+  <xsl:text><![CDATA[
+         default:
+            AssertFailed();
     }
     va_end(args);
@@ -613 +689 @@
 <xsl:text><![CDATA[
   #include <VBox/com/array.h>
+  #include <iprt/asm.h>
   #include "EventImpl.h"
 ]]></xsl:text>
@@ -631 +708 @@
           </xsl:if>
         </xsl:variable>
+        <xsl:variable name="isReusable">
+          <xsl:if test="@extends='IReusableEvent'">
+            <xsl:value-of select="'yes'" />
+          </xsl:if>
+        </xsl:variable>
         <xsl:call-template name="genEventImpl">
           <xsl:with-param name="implName" select="$implName" />
           <xsl:with-param name="isVeto" select="$isVeto" />
+          <xsl:with-param name="isReusable" select="$isReusable" />
         </xsl:call-template>
       </xsl:when>

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

@@ -180 +180 @@
 public:
  VBoxEventDesc()
- : mEvent(0)
+ : mEvent(0), mEventSource(0)
  {}
  ~VBoxEventDesc()
@@ -191 +191 @@
   */
  HRESULT init(IEventSource* aSource, VBoxEventType_T aType, ...);
+
+ /**
+  * Function similar to the above, but assumes that init() for this type already called once,
+  * so no need to allocate memory, and only reinit fields. Assumes event is subtype of
+  * IReusableEvent, asserts otherwise.
+  */
+ HRESULT reinit(VBoxEventType_T aType, ...);
+
 
  void getEvent(IEvent ** aEvent)