Changeset 30583 in vbox for trunk/src

Timestamp:

Jul 2, 2010 4:39:53 PM (15 years ago)

Author:

vboxsync

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

63308

Message:

Webservice: avoid calling QueryInterface for every object lookup when interface UUIDs can be more easily compared (this avoids constantly creating and deleting temporary stubs in XPCOM)

Location:

trunk/src/VBox/Main/webservice

Files:

• vboxweb.cpp (modified) (10 diffs)
• vboxweb.h (modified) (10 diffs)

trunk/src/VBox/Main/webservice/vboxweb.cpp

@@ -1168 +1168 @@
             }
 
-            _pISession = new ManagedObjectRef(*this, g_pcszISession, session);
+            _pISession = new ManagedObjectRef(*this, g_pcszISession, session, com::Guid(COM_IIDOF(ISession)));
 
             if (g_fVerbose)
@@ -1197 +1197 @@
  * @return The existing ManagedObjectRef that represents the COM object, or NULL if there's none yet.
  */
-ManagedObjectRef* WebServiceSession::findRefFromPtr(const ComPtr<IUnknown> &pcu)
+ManagedObjectRef* WebServiceSession::findRefFromPtr(const IUnknown *pObject)
 {
     Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
 
-    IUnknown *p = pcu;
-    uintptr_t ulp = (uintptr_t)p;
-    ManagedObjectRef *pRef;
+    uintptr_t ulp = (uintptr_t)pObject;
     // WEBDEBUG(("   %s: looking up 0x%lX\n", __FUNCTION__, ulp));
     ManagedObjectsMapByPtr::iterator it = _pp->_mapManagedObjectsByPtr.find(ulp);
     if (it != _pp->_mapManagedObjectsByPtr.end())
     {
-        pRef = it->second;
+        ManagedObjectRef *pRef = it->second;
         WSDLT_ID id = pRef->toWSDL();
         WEBDEBUG(("   %s: found existing ref %s (%s) for COM obj 0x%lX\n", __FUNCTION__, id.c_str(), pRef->getInterfaceName(), ulp));
-    }
-    else
-        pRef = NULL;
-    return pRef;
+        return pRef;
+    }
+
+    return NULL;
 }
 
@@ -1266 +1264 @@
 }
 
-/**
- *
- */
-void WebServiceSession::DumpRefs()
-{
-    WEBDEBUG(("   dumping object refs:\n"));
-    ManagedObjectsIteratorById
-        iter = _pp->_mapManagedObjectsById.begin(),
-        end = _pp->_mapManagedObjectsById.end();
-    for (;
-        iter != end;
-        ++iter)
-    {
-        ManagedObjectRef *pRef = iter->second;
-        uint64_t id = pRef->getID();
-        void *p = pRef->getComPtr();
-        WEBDEBUG(("     objid %llX: comptr 0x%lX\n", id, p));
-    }
-}
 
 /****************************************************************************
@@ -1309 +1288 @@
  *      instance already exists for a given COM pointer.
  *
+ *  This constructor calls AddRef() on the given COM object, and
+ *  the destructor will call Release().
+ *
  *  This does _not_ check whether another instance already
  *  exists in the hash. This gets called only from the
@@ -1320 +1302 @@
 ManagedObjectRef::ManagedObjectRef(WebServiceSession &session,
                                    const char *pcszInterface,
-                                   const ComPtr<IUnknown> &pc)
+                                   IUnknown *pObject,
+                                   const com::Guid &guidInterface)
     : _session(session),
-      _pObj(pc),
+      _pvObj(pObject),
+      _guidInterface(guidInterface),
       _pcszInterface(pcszInterface)
 {
-    ComPtr<IUnknown> pcUnknown(pc);
-    _ulp = (uintptr_t)(IUnknown*)pcUnknown;
+    Assert(pObject);
+    pObject->AddRef();
+    _ulp = (uintptr_t)pObject;
 
     Assert(g_pSessionsLockHandle->isWriteLockOnCurrentThread());
@@ -1347 +1332 @@
 /**
  * Destructor; removes the instance from the global hash of
- * managed objects.
+ * managed objects. Calls Release() on the contained COM object.
  *
  * Preconditions: Caller must have locked g_pSessionsLockHandle.
@@ -1356 +1341 @@
     ULONG64 cTotal = --g_cManagedObjects;
 
-    WEBDEBUG(("   * %s: deleting MOR for ID %llX (%s); now %lld objects total\n", __FUNCTION__, _id, _pcszInterface, cTotal));
+    Assert(_pvObj);
+
+    uint32_t cRefs = ((IUnknown*)_pvObj)->Release();
+    WEBDEBUG(("   * %s: deleting MOR for ID %llX (%s; COM refcount now %RI32); now %lld objects total\n", __FUNCTION__, _id, _pcszInterface, cRefs, cTotal));
 
     // if we're being destroyed from the session's destructor,
@@ -1424 +1412 @@
         }
 
-        WEBDEBUG(("   %s(): sessid %llX, objid %llX\n", __FUNCTION__, sessid, objid));
         SessionsMapIterator it = g_mapSessions.find(sessid);
         if (it == g_mapSessions.end())
@@ -1597 +1584 @@
             // that it will be implicitly be included in all future requests of this
             // webservice client
-            ManagedObjectRef *pRef = new ManagedObjectRef(*pSession, g_pcszIVirtualBox, g_pVirtualBox);
+            ManagedObjectRef *pRef = new ManagedObjectRef(*pSession, g_pcszIVirtualBox, g_pVirtualBox, COM_IIDOF(IVirtualBox));
             resp->returnval = pRef->toWSDL();
             WEBDEBUG(("VirtualBox object ref is %s\n", resp->returnval.c_str()));
@@ -1672 +1659 @@
     return SOAP_OK;
 }
+

trunk/src/VBox/Main/webservice/vboxweb.h

@@ -121 +121 @@
                          const char *pcszPassword);
 
-        ManagedObjectRef* findRefFromPtr(const ComPtr<IUnknown> &pcu);
+        ManagedObjectRef* findRefFromPtr(const IUnknown *pObject);
 
         uint64_t getID() const
@@ -157 +157 @@
         WebServiceSession           &_session;
 
-        // value:
-        ComPtr<IUnknown>            _pObj;
+        void                        *_pvObj;                // COM object
+        com::Guid                   _guidInterface;         // and the interface for which it was created
+
         const char                  *_pcszInterface;
 
@@ -171 +172 @@
         ManagedObjectRef(WebServiceSession &session,
                          const char *pcszInterface,
-                         const ComPtr<IUnknown> &obj);
+                         IUnknown *pObject,
+                         const com::Guid &guidInterface);
         ~ManagedObjectRef();
 
@@ -179 +181 @@
         }
 
-        ComPtr<IUnknown> getComPtr()
-        {
-            return _pObj;
+        /**
+         * Returns the contained COM pointer and the UUID of the COM interface
+         * which it supports.
+         * @param
+         * @return
+         */
+        const com::Guid& getPtr(void** pp)
+        {
+            *pp = _pvObj;
+            return _guidInterface;
         }
 
@@ -202 +211 @@
 /**
  * Template function that resolves a managed object reference to a COM pointer
- * of the template class T. Gets called from tons of generated code in
+ * of the template class T. Gets called only from tons of generated code in
  * methodmaps.cpp.
  *
@@ -236 +245 @@
         if (fNullAllowed && pRef == NULL)
         {
+            WEBDEBUG(("   %s(): returning NULL object as permitted\n", __FUNCTION__));
             pComPtr.setNull();
             return 0;
         }
 
-        // pRef->getComPtr returns a ComPtr<IUnknown>; by casting it to
-        // ComPtr<T>, we implicitly do a COM queryInterface() call
-        if (pComPtr = pRef->getComPtr())
+        const com::Guid &guidCaller = COM_IIDOF(T);
+
+        // pRef->getPtr returns a void*
+        void *p;
+        const com::Guid &guidInterface = pRef->getPtr(&p);
+
+        if (guidInterface == guidCaller)
+        {
+            // same interface: then no QueryInterface needed
+            WEBDEBUG(("   %s(): returning pointer 0x%lX for original interface %s\n", __FUNCTION__, p, pRef->getInterfaceName()));
+            pComPtr = (T*)p;            // calls AddRef() once
             return 0;
+        }
+
+        // QueryInterface tests whether p actually supports the templated T interface
+        T *pT;
+        ((IUnknown*)p)->QueryInterface(guidCaller, (void**)&pT);      // this adds a reference count
+        if (pT)
+        {
+            // assign to caller's ComPtr<T>; use asOutParam() to avoid adding another reference
+            WEBDEBUG(("   %s(): returning pointer 0x%lX for queried interface %RTuuid\n", __FUNCTION__, p, guidCaller.raw()));
+            *(pComPtr.asOutParam()) = pT;
+            return 0;
+        }
 
         WEBDEBUG(("    Interface not supported for object reference %s, which is of class %s\n", id.c_str(), pRef->getInterfaceName()));
@@ -254 +284 @@
 
 /**
- * Template function that creates a new managed object for the given COM
- * pointer of the template class T. If a reference already exists for the
- * given pointer, then that reference's ID is returned instead.
+ * Creates a new managed object for the given COM pointer. If a reference already exists
+ * for the given pointer, then that reference's ID is returned instead.
  *
  * @param idParent managed object reference of calling object; used to extract session ID
@@ -265 +294 @@
 WSDLT_ID createOrFindRefFromComPtr(const WSDLT_ID &idParent,
                                    const char *pcszInterface,
-                                   const ComPtr<T> &pc)
+                                   ComPtr<T> &pc)
 {
     // NULL comptr should return NULL MOR
     if (pc.isNull())
     {
-        WEBDEBUG(("   createOrFindRefFromComPtr(): returning empty MOR for NULL %s pointer\n", pcszInterface));
+        WEBDEBUG(("   createOrFindRefFromComPtr(): returning empty MOR for NULL COM pointer\n"));
         return "";
     }
@@ -278 +307 @@
     if ((pSession = WebServiceSession::findSessionFromRef(idParent)))
     {
-        // WEBDEBUG(("\n-- found session for %s\n", idParent.c_str()));
         ManagedObjectRef *pRef;
-        if (    ((pRef = pSession->findRefFromPtr(pc)))
-             || ((pRef = new ManagedObjectRef(*pSession, pcszInterface, pc)))
+        ComPtr<IUnknown> pUnknown = pc;       // this calls QueryInterface(IUnknown)
+        if (    ((pRef = pSession->findRefFromPtr(pUnknown)))
+             || ((pRef = new ManagedObjectRef(*pSession,
+                                              pcszInterface,
+                                              pUnknown,              // IUnknown *pObject
+                                              COM_IIDOF(T))))
            )
             return pRef->toWSDL();
@@ -290 +322 @@
     return "";
 }
-