/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- * * The contents of this file are subject to the Netscape Public * License Version 1.1 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.mozilla.org/NPL/ * * Software distributed under the License is distributed on an "AS * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or * implied. See the License for the specific language governing * rights and limitations under the License. * * The Original Code is Mozilla Communicator client code. * * The Initial Developer of the Original Code is Netscape Communications * Corporation. Portions created by Netscape are * Copyright (C) 1998 Netscape Communications Corporation. All * Rights Reserved. * * Contributor(s): */ #ifndef nsTraceRefcnt_h___ #define nsTraceRefcnt_h___ #include "nsCom.h" #include // Normaly, the implementation of NS_LOG_ADDREF and NS_LOG_RELEASE // will use a stack crawl to determine who called Addref/Release on an // xpcom object. If your platform can't implement a stack crawling // function, then define this to symbol. When the symbol is defined // then the NS_LOG_ADDREF_CALL and NS_LOG_RELEASE_CALL will expand // differently. #undef NS_LOSING_ARCHITECTURE // By default refcnt logging is not part of the build. #undef NS_BUILD_REFCNT_LOGGING #if (defined(DEBUG) || defined(FORCE_BUILD_REFCNT_LOGGING)) // Make refcnt logging part of the build. This doesn't mean that // actual logging will occur (that requires a seperate enable; see // nsTraceRefcnt.h for more information). #define NS_BUILD_REFCNT_LOGGING 1 #endif // If NO_BUILD_REFCNT_LOGGING is defined then disable refcnt logging // in the build. This overrides FORCE_BUILD_REFCNT_LOGGING. #if defined(NO_BUILD_REFCNT_LOGGING) #undef NS_BUILD_REFCNT_LOGGING #endif #ifdef NS_BUILD_REFCNT_LOGGING #define NS_LOG_ADDREF(_p, _rc, _type, _size) \ nsTraceRefcnt::LogAddRef((_p), (_rc), (_type), (PRUint32) (_size)) #define NS_LOG_RELEASE(_p, _rc, _type) \ nsTraceRefcnt::LogRelease((_p), (_rc), (_type)) #ifdef NS_LOSING_ARCHITECTURE #define NS_LOG_ADDREF_CALL(_p,_rc,_file,_line) \ nsTraceRefcnt::LogAddRefCall((_p), (_rc), (_file), (_line)) #define NS_LOG_RELEASE_CALL(_p,_rc,_file,_line) \ nsTraceRefcnt::LogReleaseCall((_p), (_rc), (_file), (_line)) #define NS_LOG_NEW_XPCOM(_p,_type,_size,_file,_line) \ nsTraceRefcnt::LogNewXPCOM((_p),(_type),(PRUint32)(_size),(_file),(_line)) #define NS_LOG_DELETE_XPCOM(_p,_file,_line) \ nsTraceRefcnt::LogDeleteXPCOM((_p),(_file),(_line)) #else #define NS_LOG_ADDREF_CALL(_p,_rc,_file,_line) _rc #define NS_LOG_RELEASE_CALL(_p,_rc,_file,_line) _rc #define NS_LOG_NEW_XPCOM(_p,_type,_size,_file,_line) #define NS_LOG_DELETE_XPCOM(_p,_file,_line) #endif #define MOZ_DECL_CTOR_COUNTER(_type) #define MOZ_COUNT_CTOR(_type) \ PR_BEGIN_MACRO \ nsTraceRefcnt::LogCtor((void*)this, #_type, sizeof(*this)); \ PR_END_MACRO #define MOZ_COUNT_DTOR(_type) \ PR_BEGIN_MACRO \ nsTraceRefcnt::LogDtor((void*)this, #_type, sizeof(*this)); \ PR_END_MACRO #else /* !NS_BUILD_REFCNT_LOGGING */ #define NS_LOG_ADDREF(_p, _rc, _type, _size) #define NS_LOG_RELEASE(_p, _rc, _type) #define NS_LOG_NEW_XPCOM(_p,_type,_size,_file,_line) #define NS_LOG_DELETE_XPCOM(_p,_file,_line) #define NS_LOG_ADDREF_CALL(_p,_rc,_file,_line) _rc #define NS_LOG_RELEASE_CALL(_p,_rc,_file,_line) _rc #define MOZ_DECL_CTOR_COUNTER(_type) #define MOZ_COUNT_CTOR(_type) #define MOZ_COUNT_DTOR(_type) #endif /* NS_BUILD_REFCNT_LOGGING */ //---------------------------------------------------------------------- struct nsTraceRefcntStats { nsrefcnt mAddRefs; nsrefcnt mReleases; nsrefcnt mCreates; nsrefcnt mDestroys; double mRefsOutstandingTotal; double mRefsOutstandingVariance; double mObjsOutstandingTotal; double mObjsOutstandingVariance; }; // Function type used by GatherStatistics. For each type that data has // been gathered for, this function is called with the counts of the // various operations that have been logged. The function can return // PR_FALSE if the gathering should stop. // // aCurrentStats is the current value of the counters. aPrevStats is // the previous value of the counters which is established by the // nsTraceRefcnt::SnapshotStatistics call. typedef PRBool (PR_CALLBACK *nsTraceRefcntStatFunc) (const char* aTypeName, PRUint32 aInstanceSize, nsTraceRefcntStats* aCurrentStats, nsTraceRefcntStats* aPrevStats, void *aClosure); /** * Note: The implementations for these methods are no-ops in a build * where NS_BUILD_REFCNT_LOGGING is disabled. */ class nsTraceRefcnt { public: static NS_COM void LogAddRef(void* aPtr, nsrefcnt aNewRefCnt, const char* aTypeName, PRUint32 aInstanceSize); static NS_COM void LogRelease(void* aPtr, nsrefcnt aNewRefCnt, const char* aTypeName); static NS_COM void LogNewXPCOM(void* aPtr, const char* aTypeName, PRUint32 aInstanceSize, const char* aFile, int aLine); static NS_COM void LogDeleteXPCOM(void* aPtr, const char* aFile, int aLine); static NS_COM nsrefcnt LogAddRefCall(void* aPtr, nsrefcnt aNewRefcnt, const char* aFile, int aLine); static NS_COM nsrefcnt LogReleaseCall(void* aPtr, nsrefcnt aNewRefcnt, const char* aFile, int aLine); static NS_COM void LogCtor(void* aPtr, const char* aTypeName, PRUint32 aInstanceSize); static NS_COM void LogDtor(void* aPtr, const char* aTypeName, PRUint32 aInstanceSize); enum StatisticsType { ALL_STATS, NEW_STATS }; static NS_COM nsresult DumpStatistics(StatisticsType type = ALL_STATS, FILE* out = 0); static NS_COM void ResetStatistics(void); static NS_COM void GatherStatistics(nsTraceRefcntStatFunc aFunc, void* aClosure); static NS_COM void LoadLibrarySymbols(const char* aLibraryName, void* aLibrayHandle); static NS_COM void DemangleSymbol(const char * aSymbol, char * aBuffer, int aBufLen); static NS_COM void WalkTheStack(FILE* aStream); }; #endif /* nsTraceRefcnt_h___ */