The Tor Browser: xpcom/reflect/xptinfo/src/xptiInterfaceInfo.cpp@b8a032363ba2 (annotated)

xpcom/reflect/xptinfo/src/xptiInterfaceInfo.cpp@b8a032363ba2 (annotated)

xpcom/reflect/xptinfo/src/xptiInterfaceInfo.cpp

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 /* Implementation of xptiInterfaceEntry and xptiInterfaceInfo. */
 #include "xptiprivate.h"
 #include "mozilla/XPTInterfaceInfoManager.h"
 using namespace mozilla;
 /***************************************************************************/
 // Debug Instrumentation...
 #ifdef SHOW_INFO_COUNT_STATS
 static int DEBUG_TotalInfos = 0;
 static int DEBUG_CurrentInfos = 0;
 static int DEBUG_MaxInfos = 0;
 static int DEBUG_ReentrantMonitorEntryCount = 0;
 #define LOG_INFO_CREATE(t)                                                  \
     DEBUG_TotalInfos++;                                                     \
     DEBUG_CurrentInfos++;                                                   \
     if(DEBUG_MaxInfos < DEBUG_CurrentInfos)                                 \
         DEBUG_MaxInfos = DEBUG_CurrentInfos /* no ';' */
 #define LOG_INFO_DESTROY(t)                                                 \
     DEBUG_CurrentInfos-- /* no ';' */
 #define LOG_INFO_MONITOR_ENTRY                                              \
     DEBUG_ReentrantMonitorEntryCount++ /* no ';' */
 #else /* SHOW_INFO_COUNT_STATS */
 #define LOG_INFO_CREATE(t)     ((void)0)
 #define LOG_INFO_DESTROY(t)    ((void)0)
 #define LOG_INFO_MONITOR_ENTRY ((void)0)
 #endif /* SHOW_INFO_COUNT_STATS */
 /* static */ xptiInterfaceEntry*
 xptiInterfaceEntry::Create(const char* name, const nsID& iid,
                            XPTInterfaceDescriptor* aDescriptor,
                            xptiTypelibGuts* aTypelib)
 {
     int namelen = strlen(name);
     return new (XPT_MALLOC(gXPTIStructArena,
                            sizeof(xptiInterfaceEntry) + namelen))
         xptiInterfaceEntry(name, namelen, iid, aDescriptor, aTypelib);
 }
 xptiInterfaceEntry::xptiInterfaceEntry(const char* name,
                                        size_t nameLength,
                                        const nsID& iid,
                                        XPTInterfaceDescriptor* aDescriptor,
                                        xptiTypelibGuts* aTypelib)
     : mIID(iid)
     , mDescriptor(aDescriptor)
     , mMethodBaseIndex(0)
     , mConstantBaseIndex(0)
     , mTypelib(aTypelib)
     , mParent(nullptr)
     , mInfo(nullptr)
     , mFlags(0)
 {
     memcpy(mName, name, nameLength);
     SetResolvedState(PARTIALLY_RESOLVED);
 }
 bool
 xptiInterfaceEntry::Resolve()
 {
     MutexAutoLock lock(XPTInterfaceInfoManager::GetResolveLock());
     return ResolveLocked();
 }
 bool
 xptiInterfaceEntry::ResolveLocked()
 {
     int resolvedState = GetResolveState();
     if(resolvedState == FULLY_RESOLVED)
         return true;
     if(resolvedState == RESOLVE_FAILED)
         return false;
     NS_ASSERTION(GetResolveState() == PARTIALLY_RESOLVED, "bad state!");
     // Finish out resolution by finding parent and Resolving it so
     // we can set the info we get from it.
     uint16_t parent_index = mDescriptor->parent_interface;
     if(parent_index)
     {
         xptiInterfaceEntry* parent =
             mTypelib->GetEntryAt(parent_index - 1);
         if(!parent || !parent->EnsureResolvedLocked())
         {
             SetResolvedState(RESOLVE_FAILED);
             return false;
         }
         mParent = parent;
         mMethodBaseIndex =
             parent->mMethodBaseIndex +
             parent->mDescriptor->num_methods;
         mConstantBaseIndex =
             parent->mConstantBaseIndex +
             parent->mDescriptor->num_constants;
     }
     LOG_RESOLVE(("+ complete resolve of %s\n", mName));
     SetResolvedState(FULLY_RESOLVED);
     return true;
 }
 /**************************************************/
 // These non-virtual methods handle the delegated nsIInterfaceInfo methods.
 nsresult
 xptiInterfaceEntry::GetName(char **name)
 {
     // It is not necessary to Resolve because this info is read from manifest.
     *name = (char*) nsMemory::Clone(mName, strlen(mName)+1);
     return *name ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
 }
 nsresult
 xptiInterfaceEntry::GetIID(nsIID **iid)
 {
     // It is not necessary to Resolve because this info is read from manifest.
     *iid = (nsIID*) nsMemory::Clone(&mIID, sizeof(nsIID));
     return *iid ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
 }
 nsresult
 xptiInterfaceEntry::IsScriptable(bool* result)
 {
     // It is not necessary to Resolve because this info is read from manifest.
     *result = GetScriptableFlag();
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::IsFunction(bool* result)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     *result = XPT_ID_IS_FUNCTION(mDescriptor->flags);
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetMethodCount(uint16_t* count)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     *count = mMethodBaseIndex +
              mDescriptor->num_methods;
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetConstantCount(uint16_t* count)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     *count = mConstantBaseIndex +
              mDescriptor->num_constants;
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetMethodInfo(uint16_t index, const nsXPTMethodInfo** info)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     if(index < mMethodBaseIndex)
         return mParent->GetMethodInfo(index, info);
     if(index >= mMethodBaseIndex +
                 mDescriptor->num_methods)
     {
         NS_ERROR("bad param");
         *info = nullptr;
         return NS_ERROR_INVALID_ARG;
     }
     // else...
     *info = reinterpret_cast<nsXPTMethodInfo*>
        (&mDescriptor->method_descriptors[index - mMethodBaseIndex]);
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetMethodInfoForName(const char* methodName, uint16_t *index,
                                          const nsXPTMethodInfo** result)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     // This is a slow algorithm, but this is not expected to be called much.
     for(uint16_t i = 0; i < mDescriptor->num_methods; ++i)
     {
         const nsXPTMethodInfo* info;
         info = reinterpret_cast<nsXPTMethodInfo*>
                                (&mDescriptor->
                                         method_descriptors[i]);
         if (PL_strcmp(methodName, info->GetName()) == 0) {
             *index = i + mMethodBaseIndex;
             *result = info;
             return NS_OK;
         }
     }
     if(mParent)
         return mParent->GetMethodInfoForName(methodName, index, result);
     else
     {
         *index = 0;
         *result = 0;
         return NS_ERROR_INVALID_ARG;
     }
 }
 nsresult
 xptiInterfaceEntry::GetConstant(uint16_t index, const nsXPTConstant** constant)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     if(index < mConstantBaseIndex)
         return mParent->GetConstant(index, constant);
     if(index >= mConstantBaseIndex +
                 mDescriptor->num_constants)
     {
         NS_PRECONDITION(0, "bad param");
         *constant = nullptr;
         return NS_ERROR_INVALID_ARG;
     }
     // else...
     *constant =
         reinterpret_cast<nsXPTConstant*>
                         (&mDescriptor->
                                 const_descriptors[index -
                                     mConstantBaseIndex]);
     return NS_OK;
 }
 // this is a private helper
 nsresult
 xptiInterfaceEntry::GetEntryForParam(uint16_t methodIndex,
                                      const nsXPTParamInfo * param,
                                      xptiInterfaceEntry** entry)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     if(methodIndex < mMethodBaseIndex)
         return mParent->GetEntryForParam(methodIndex, param, entry);
     if(methodIndex >= mMethodBaseIndex +
                       mDescriptor->num_methods)
     {
         NS_ERROR("bad param");
         return NS_ERROR_INVALID_ARG;
     }
     const XPTTypeDescriptor *td = &param->type;
     while (XPT_TDP_TAG(td->prefix) == TD_ARRAY) {
         td = &mDescriptor->additional_types[td->type.additional_type];
     }
     if(XPT_TDP_TAG(td->prefix) != TD_INTERFACE_TYPE) {
         NS_ERROR("not an interface");
         return NS_ERROR_INVALID_ARG;
     }
     xptiInterfaceEntry* theEntry = mTypelib->
         GetEntryAt(td->type.iface - 1);
     // This can happen if a declared interface is not available at runtime.
     if(!theEntry)
     {
         NS_WARNING("Declared InterfaceInfo not found");
         *entry = nullptr;
         return NS_ERROR_FAILURE;
     }
     *entry = theEntry;
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetInfoForParam(uint16_t methodIndex,
                                     const nsXPTParamInfo *param,
                                     nsIInterfaceInfo** info)
 {
     xptiInterfaceEntry* entry;
     nsresult rv = GetEntryForParam(methodIndex, param, &entry);
     if(NS_FAILED(rv))
         return rv;
     *info = entry->InterfaceInfo().take();
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetIIDForParam(uint16_t methodIndex,
                                    const nsXPTParamInfo* param, nsIID** iid)
 {
     xptiInterfaceEntry* entry;
     nsresult rv = GetEntryForParam(methodIndex, param, &entry);
     if(NS_FAILED(rv))
         return rv;
     return entry->GetIID(iid);
 }
 nsresult
 xptiInterfaceEntry::GetIIDForParamNoAlloc(uint16_t methodIndex,
                                           const nsXPTParamInfo * param,
                                           nsIID *iid)
 {
     xptiInterfaceEntry* entry;
     nsresult rv = GetEntryForParam(methodIndex, param, &entry);
     if(NS_FAILED(rv))
         return rv;
     *iid = entry->mIID;
     return NS_OK;
 }
 // this is a private helper
 nsresult
 xptiInterfaceEntry::GetTypeInArray(const nsXPTParamInfo* param,
                                   uint16_t dimension,
                                   const XPTTypeDescriptor** type)
 {
     NS_ASSERTION(IsFullyResolved(), "bad state");
     const XPTTypeDescriptor *td = &param->type;
     const XPTTypeDescriptor *additional_types =
                 mDescriptor->additional_types;
     for (uint16_t i = 0; i < dimension; i++) {
         if(XPT_TDP_TAG(td->prefix) != TD_ARRAY) {
             NS_ERROR("bad dimension");
             return NS_ERROR_INVALID_ARG;
         }
         td = &additional_types[td->type.additional_type];
     }
     *type = td;
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetTypeForParam(uint16_t methodIndex,
                                     const nsXPTParamInfo* param,
                                     uint16_t dimension,
                                     nsXPTType* type)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     if(methodIndex < mMethodBaseIndex)
         return mParent->
             GetTypeForParam(methodIndex, param, dimension, type);
     if(methodIndex >= mMethodBaseIndex +
                       mDescriptor->num_methods)
     {
         NS_ERROR("bad index");
         return NS_ERROR_INVALID_ARG;
     }
     const XPTTypeDescriptor *td;
     if(dimension) {
         nsresult rv = GetTypeInArray(param, dimension, &td);
         if(NS_FAILED(rv))
             return rv;
     }
     else
         td = &param->type;
     *type = nsXPTType(td->prefix);
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetSizeIsArgNumberForParam(uint16_t methodIndex,
                                                const nsXPTParamInfo* param,
                                                uint16_t dimension,
                                                uint8_t* argnum)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     if(methodIndex < mMethodBaseIndex)
         return mParent->
             GetSizeIsArgNumberForParam(methodIndex, param, dimension, argnum);
     if(methodIndex >= mMethodBaseIndex +
                       mDescriptor->num_methods)
     {
         NS_ERROR("bad index");
         return NS_ERROR_INVALID_ARG;
     }
     const XPTTypeDescriptor *td;
     if(dimension) {
         nsresult rv = GetTypeInArray(param, dimension, &td);
         if(NS_FAILED(rv))
             return rv;
     }
     else
         td = &param->type;
     // verify that this is a type that has size_is
     switch (XPT_TDP_TAG(td->prefix)) {
       case TD_ARRAY:
       case TD_PSTRING_SIZE_IS:
       case TD_PWSTRING_SIZE_IS:
         break;
       default:
         NS_ERROR("not a size_is");
         return NS_ERROR_INVALID_ARG;
     }
     *argnum = td->argnum;
     return NS_OK;
 }
 nsresult
 xptiInterfaceEntry::GetInterfaceIsArgNumberForParam(uint16_t methodIndex,
                                                     const nsXPTParamInfo* param,
                                                     uint8_t* argnum)
 {
     if(!EnsureResolved())
         return NS_ERROR_UNEXPECTED;
     if(methodIndex < mMethodBaseIndex)
         return mParent->
             GetInterfaceIsArgNumberForParam(methodIndex, param, argnum);
     if(methodIndex >= mMethodBaseIndex +
                       mDescriptor->num_methods)
     {
         NS_ERROR("bad index");
         return NS_ERROR_INVALID_ARG;
     }
     const XPTTypeDescriptor *td = &param->type;
     while (XPT_TDP_TAG(td->prefix) == TD_ARRAY) {
         td = &mDescriptor->
                                 additional_types[td->type.additional_type];
     }
     if(XPT_TDP_TAG(td->prefix) != TD_INTERFACE_IS_TYPE) {
         NS_ERROR("not an iid_is");
         return NS_ERROR_INVALID_ARG;
     }
     *argnum = td->argnum;
     return NS_OK;
 }
 /* bool isIID (in nsIIDPtr IID); */
 nsresult
 xptiInterfaceEntry::IsIID(const nsIID * IID, bool *_retval)
 {
     // It is not necessary to Resolve because this info is read from manifest.
     *_retval = mIID.Equals(*IID);
     return NS_OK;
 }
 /* void getNameShared ([shared, retval] out string name); */
 nsresult
 xptiInterfaceEntry::GetNameShared(const char **name)
 {
     // It is not necessary to Resolve because this info is read from manifest.
     *name = mName;
     return NS_OK;
 }
 /* void getIIDShared ([shared, retval] out nsIIDPtrShared iid); */
 nsresult
 xptiInterfaceEntry::GetIIDShared(const nsIID * *iid)
 {
     // It is not necessary to Resolve because this info is read from manifest.
     *iid = &mIID;
     return NS_OK;
 }
 /* bool hasAncestor (in nsIIDPtr iid); */
 nsresult
 xptiInterfaceEntry::HasAncestor(const nsIID * iid, bool *_retval)
 {
     *_retval = false;
     for(xptiInterfaceEntry* current = this;
         current;
         current = current->mParent)
     {
         if(current->mIID.Equals(*iid))
         {
             *_retval = true;
             break;
         }
         if(!current->EnsureResolved())
             return NS_ERROR_UNEXPECTED;
     }
     return NS_OK;
 }
 /***************************************************/
 already_AddRefed<xptiInterfaceInfo>
 xptiInterfaceEntry::InterfaceInfo()
 {
 #ifdef DEBUG
     XPTInterfaceInfoManager::GetSingleton()->mWorkingSet.mTableReentrantMonitor.
         AssertCurrentThreadIn();
 #endif
     LOG_INFO_MONITOR_ENTRY;
     if(!mInfo)
     {
         mInfo = new xptiInterfaceInfo(this);
     }
     nsRefPtr<xptiInterfaceInfo> info = mInfo;
     return info.forget();
 }
 void
 xptiInterfaceEntry::LockedInvalidateInterfaceInfo()
 {
     if(mInfo)
     {
         mInfo->Invalidate();
         mInfo = nullptr;
     }
 }
 bool
 xptiInterfaceInfo::BuildParent()
 {
     mozilla::ReentrantMonitorAutoEnter monitor(XPTInterfaceInfoManager::GetSingleton()->
                                     mWorkingSet.mTableReentrantMonitor);
     NS_ASSERTION(mEntry &&
                  mEntry->IsFullyResolved() &&
                  !mParent &&
                  mEntry->Parent(),
                 "bad BuildParent call");
     mParent = mEntry->Parent()->InterfaceInfo().take();
     return true;
 }
 /***************************************************************************/
 NS_IMPL_QUERY_INTERFACE(xptiInterfaceInfo, nsIInterfaceInfo)
 xptiInterfaceInfo::xptiInterfaceInfo(xptiInterfaceEntry* entry)
     : mEntry(entry), mParent(nullptr)
 {
     LOG_INFO_CREATE(this);
 }
 xptiInterfaceInfo::~xptiInterfaceInfo()
 {
     LOG_INFO_DESTROY(this);
     NS_IF_RELEASE(mParent);
     NS_ASSERTION(!mEntry, "bad state in dtor");
 }
 MozExternalRefCountType
 xptiInterfaceInfo::AddRef(void)
 {
     nsrefcnt cnt = ++mRefCnt;
     NS_LOG_ADDREF(this, cnt, "xptiInterfaceInfo", sizeof(*this));
     return cnt;
 }
 MozExternalRefCountType
 xptiInterfaceInfo::Release(void)
 {
     xptiInterfaceEntry* entry = mEntry;
     nsrefcnt cnt = --mRefCnt;
     NS_LOG_RELEASE(this, cnt, "xptiInterfaceInfo");
     if(!cnt)
     {
         mozilla::ReentrantMonitorAutoEnter monitor(XPTInterfaceInfoManager::
                                           GetSingleton()->mWorkingSet.
                                           mTableReentrantMonitor);
         LOG_INFO_MONITOR_ENTRY;
         // If InterfaceInfo added and *released* a reference before we
         // acquired the monitor then 'this' might already be dead. In that
         // case we would not want to try to access any instance data. We
         // would want to bail immediately. If 'this' is already dead then the
         // entry will no longer have a pointer to 'this'. So, we can protect
         // ourselves from danger without more aggressive locking.
         if(entry && !entry->InterfaceInfoEquals(this))
             return 0;
         // If InterfaceInfo added a reference before we acquired the monitor
         // then we want to bail out of here without destorying the object.
         if(mRefCnt)
             return 1;
         if(mEntry)
         {
             mEntry->LockedInterfaceInfoDeathNotification();
             mEntry = nullptr;
         }
         delete this;
         return 0;
     }
     return cnt;
 }
 /***************************************************************************/

The Tor Browser / annotate

xpcom/reflect/xptinfo/src/xptiInterfaceInfo.cpp@b8a032363ba2 (annotated)

xpcom/reflect/xptinfo/src/xptiInterfaceInfo.cpp