7#ifndef PXR_IMAGING_HD_PERF_LOG_H
8#define PXR_IMAGING_HD_PERF_LOG_H
11#include "pxr/imaging/hd/api.h"
12#include "pxr/imaging/hd/version.h"
13#include "pxr/imaging/hd/debugCodes.h"
21#include "pxr/base/tf/hashmap.h"
26PXR_NAMESPACE_OPEN_SCOPE
40#define HD_TRACE_FUNCTION() TRACE_FUNCTION()
42#define HD_TRACE_SCOPE(tag) TRACE_SCOPE(tag)
46#define HD_PERF_CACHE_HIT(name, id) \
47 HdPerfLog::GetInstance().AddCacheHit(name, id);
48#define HD_PERF_CACHE_HIT_TAG(name, id, tag) \
49 HdPerfLog::GetInstance().AddCacheHit(name, id, tag);
53#define HD_PERF_CACHE_MISS(name, id) \
54 HdPerfLog::GetInstance().AddCacheMiss(name, id);
55#define HD_PERF_CACHE_MISS_TAG(name, id, tag) \
56 HdPerfLog::GetInstance().AddCacheMiss(name, id, tag);
60#define HD_PERF_COUNTER_INCR(name) \
61 HdPerfLog::GetInstance().IncrementCounter(name);
62#define HD_PERF_COUNTER_DECR(name) \
63 HdPerfLog::GetInstance().DecrementCounter(name);
64#define HD_PERF_COUNTER_SET(name, value) \
65 HdPerfLog::GetInstance().SetCounter(name, value);
66#define HD_PERF_COUNTER_ADD(name, value) \
67 HdPerfLog::GetInstance().AddCounter(name, value);
68#define HD_PERF_COUNTER_SUBTRACT(name, value) \
69 HdPerfLog::GetInstance().SubtractCounter(name, value);
102 void ResetCache(
TfToken const& name);
185 _CacheEntry() : _hits(0), _misses(0) { }
187 void AddHit() {++_hits;}
188 size_t GetHits() {
return _hits;}
190 void AddMiss() {++_misses;}
191 size_t GetMisses() {
return _misses;}
193 size_t GetTotal() {
return _hits+_misses;}
194 double GetHitRatio() {
return (
double)_hits / GetTotal();}
196 void Reset() { _hits = 0; _misses = 0; }
203 typedef TfHashMap<TfToken, _CacheEntry, TfToken::HashFunctor> _CacheMap;
207 typedef TfHashMap<TfToken, double, TfToken::HashFunctor> _CounterMap;
208 _CounterMap _counterMap;
211 std::vector<HdResourceRegistry *> _resourceRegistryVector;
216 typedef std::lock_guard<std::mutex> _Lock;
221PXR_NAMESPACE_CLOSE_SCOPE
Performance counter monitoring.
HD_API void ResetCounters()
Reset all conter values to 0.0.
void Disable()
Disable performance logging.
HD_API void DecrementCounter(TfToken const &name)
Decrements a named counter by 1.0.
HD_API void AddCacheMiss(TfToken const &name, SdfPath const &id, TfToken const &tag=TfToken())
Tracks a cache miss for the named cache, the id and tag are reported when debug logging is enabled.
HD_API void AddCounter(TfToken const &name, double value)
Adds value to a named counter.
HD_API void AddCacheHit(TfToken const &name, SdfPath const &id, TfToken const &tag=TfToken())
Tracks a cache hit for the named cache, the id and tag are reported when debug logging is enabled.
HD_API size_t GetCacheMisses(TfToken const &name)
Gets the number of hit misses for a cache performance counter.
HD_API void RemoveResourceRegistry(HdResourceRegistry *resourceRegistry)
Remove Resource Registry from the tracking.
HD_API std::vector< HdResourceRegistry * > const & GetResourceRegistryVector()
Returns a vector of resource registry.
HD_API double GetCounter(TfToken const &name)
Returns the current value of a named counter.
HD_API TfTokenVector GetCounterNames()
Returns a vector of all performance counter names.
void Enable()
Enable performance logging.
HD_API void SubtractCounter(TfToken const &name, double value)
Subtracts value to a named counter.
HD_API double GetCacheHitRatio(TfToken const &name)
Gets the hit ratio (numHits / totalRequests) of a cache performance counter.
HD_API size_t GetCacheHits(TfToken const &name)
Gets the number of hit hits for a cache performance counter.
HD_API TfTokenVector GetCacheNames()
Returns the names of all cache performance counters.
HD_API void SetCounter(TfToken const &name, double value)
Sets the value of a named counter.
HD_API void IncrementCounter(TfToken const &name)
Increments a named counter by 1.0.
HD_API void AddResourceRegistry(HdResourceRegistry *resourceRegistry)
Add a resource registry to the tracking.
A central registry for resources.
A path value used to locate objects in layers or scenegraphs.
Manage a single instance of an object (see.
static T & GetInstance()
Return a reference to an object of type T, creating it if necessary.
Token for efficient comparison, assignment, and hashing of known strings.
Manage a single instance of an object.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.