24#ifndef PXR_BASE_TF_REF_PTR_TRACKER_H
25#define PXR_BASE_TF_REF_PTR_TRACKER_H
31#include "pxr/base/tf/api.h"
33#include "pxr/base/tf/hashmap.h"
40PXR_NAMESPACE_OPEN_SCOPE
100 enum TraceType { Add, Assign };
187 void _AddTrace(
const void* owner,
const TfRefBase* obj, TraceType = Add);
190 void _RemoveTraces(
const void* owner);
193 typedef std::mutex _Mutex;
194 typedef std::lock_guard<std::mutex> _Lock;
195 mutable _Mutex _mutex;
200 friend class Tf_RefPtrTrackerUtil;
207class Tf_RefPtrTrackerUtil {
212 TfRefPtrTracker::GetInstance()._Watch(obj);
216 static void Unwatch(
const TfRefBase* obj)
218 TfRefPtrTracker::GetInstance()._Unwatch(obj);
223 static void AddTrace(
const void* owner,
const TfRefBase* obj,
224 TfRefPtrTracker::TraceType type = TfRefPtrTracker::Add)
226 TfRefPtrTracker::GetInstance()._AddTrace(owner, obj, type);
230 static void RemoveTraces(
const void* owner)
232 TfRefPtrTracker::GetInstance()._RemoveTraces(owner);
236#define TF_DECLARE_REFPTR_TRACK(T) \
237inline void Tf_RefPtrTracker_FirstRef(const void*, T* obj); \
238inline void Tf_RefPtrTracker_LastRef(const void*, T* obj); \
239inline void Tf_RefPtrTracker_New(const void* owner, T* obj); \
240inline void Tf_RefPtrTracker_Delete(const void* owner, T* obj); \
241inline void Tf_RefPtrTracker_Assign(const void* owner, T* obj, T* oldObj);
243#define TF_DEFINE_REFPTR_TRACK(T, COND) \
244inline void Tf_RefPtrTracker_FirstRef(const void*, T* obj) { \
245 if (obj && COND(obj)) Tf_RefPtrTrackerUtil::Watch(obj); \
247inline void Tf_RefPtrTracker_LastRef(const void*, T* obj) { \
248 Tf_RefPtrTrackerUtil::Unwatch(obj); \
250inline void Tf_RefPtrTracker_New(const void* owner, T* obj) { \
251 Tf_RefPtrTrackerUtil::AddTrace(owner, obj); \
253inline void Tf_RefPtrTracker_Delete(const void* owner, T* obj) { \
254 Tf_RefPtrTrackerUtil::RemoveTraces(owner); \
256inline void Tf_RefPtrTracker_Assign(const void* owner, T* obj, T* oldObj) { \
257 if (oldObj != obj) { \
258 Tf_RefPtrTrackerUtil::AddTrace(owner, obj, TfRefPtrTracker::Assign);\
262PXR_NAMESPACE_CLOSE_SCOPE
Enable a concrete base class for use with TfRefPtr.
Reference-counted smart pointer utility class.
Provides tracking of TfRefPtr objects to particular objects.
const TfRefBase * obj
The object being pointed to.
TF_API OwnerTraces GetAllTraces() const
Returns traces for all owners. Returns a copy for thread safety.
TF_API void ReportAllWatchedCounts(std::ostream &stream) const
Writes all watched objects and the number of owners of each to stream.
TF_API void ReportAllTraces(std::ostream &stream) const
Writes all traces to stream.
TF_API size_t GetStackTraceMaxDepth() const
Returns the maximum stack trace depth.
TfHashMap< const void *, Trace, TfHash > OwnerTraces
Maps a TfRefPtr address to the most recent trace for it.
std::vector< uintptr_t > trace
The stack trace when the TfRefPtr was created or assigned to.
TfHashMap< const TfRefBase *, size_t, TfHash > WatchedCounts
Maps a TfRefBase object pointer to the number of TfRefPtr objects using it.
TF_API WatchedCounts GetWatchedCounts() const
Returns the watched objects and the number of owners of each.
TF_API void ReportTracesForWatched(std::ostream &stream, const TfRefBase *watched) const
Writes traces for all owners of watched.
TraceType type
Whether the TfRefPtr was created or assigned to.
TF_API void SetStackTraceMaxDepth(size_t)
Sets the maximum stack trace depth.
static bool WatchAll(const void *)
Handy function to pass as second argument to TF_DEFINE_REFPTR_TRACK.
static bool WatchNone(const void *)
Handy function to pass as second argument to TF_DEFINE_REFPTR_TRACK.
Manage a single instance of an object (see.
static T & GetInstance()
Return a reference to an object of type T, creating it if necessary.
Enable a concrete base class for use with TfWeakPtr.
Manage a single instance of an object.