anki-3d-engine/AnKi/Core/StatsSet.h

// Copyright (C) 2009-present, Panagiotis Christopoulos Charitos and contributors.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#pragma once

#include <AnKi/Core/Common.h>
#include <AnKi/Util/Singleton.h>
#include <AnKi/Util/Enum.h>
#include <AnKi/Util/Thread.h>
#include <AnKi/Util/String.h>

namespace anki {

/// @addtogroup core
/// @{

/// Define a global stat variable.
#define ANKI_SVAR(name, category, descr, ...) inline StatCounter g_svar##name(category, descr, StatFlag::kNone | __VA_ARGS__);

enum class StatFlag : U16
{
	kNone = 0,

	kZeroEveryFrame = 1 << 0,
	kMainThreadUpdates = 1 << 1, ///< Can only be updated from the main thread.
	kFloat = 1 << 2,

	kShowAverage = 1 << 3,
	kSecond = (1 << 4) | kFloat,
	kMilisecond = (1 << 5) | kFloat,
	kNanoSeconds = 1 << 6,
	kBytes = 1 << 7,
};
ANKI_ENUM_ALLOW_NUMERIC_OPERATIONS(StatFlag)

enum class StatCategory : U8
{
	kTime,
	kCpuMem,
	kGpuMem,
	kGpuMisc,
	kRenderer,
	kGr,
	kScene,
	kMisc,

	kCount,
};

inline constexpr Array<CString, U32(StatCategory::kCount)> kStatCategoryTexts = {"Time",     "CPU memory", "GPU memory", "GPU misc",
																				 "Renderer", "GFX API",    "Scene",      "Misc"};

/// A stats counter.
class StatCounter
{
	friend class StatsSet;

public:
	/// Construct.
	/// @param name Name of the counter. The object will share ownership of the pointer.
	StatCounter(StatCategory category, const Char* name, StatFlag flags = StatFlag::kNone);

	template<std::integral T>
	U64 increment(T value)
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!(m_flags & StatFlag::kFloat));
		checkThread();
		U64 orig;
		if(!!(m_flags & StatFlag::kMainThreadUpdates))
		{
			orig = m_u;
			m_u += value;
		}
		else
		{
			orig = m_atomic.fetchAdd(value);
		}
		return orig;
#else
		(void)value;
		return 0;
#endif
	}

	template<std::floating_point T>
	F64 increment(T value)
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!!(m_flags & StatFlag::kFloat));
		checkThread();
		F64 orig;
		if(!!(m_flags & StatFlag::kMainThreadUpdates))
		{
			orig = m_f;
			m_f += value;
		}
		else
		{
			LockGuard lock(m_floatLock);
			orig = m_f;
			m_f += value;
		}
		return orig;
#else
		(void)value;
		return 0.0;
#endif
	}

	template<std::integral T>
	U64 decrement(T value)
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!(m_flags & StatFlag::kFloat));
		checkThread();
		U64 orig;
		if(!!(m_flags & StatFlag::kMainThreadUpdates))
		{
			orig = m_u;
			m_u -= value;
		}
		else
		{
			orig = m_atomic.fetchSub(value);
		}
		ANKI_ASSERT(orig >= value);
		return orig;
#else
		(void)value;
		return 0;
#endif
	}

	template<std::integral T>
	U64 set(T value)
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!(m_flags & StatFlag::kFloat));
		checkThread();
		U64 orig;
		if(!!(m_flags & StatFlag::kMainThreadUpdates))
		{
			orig = m_u;
			m_u = value;
		}
		else
		{
			orig = m_atomic.exchange(value);
		}
		return orig;
#else
		(void)value;
		return 0;
#endif
	}

	template<std::floating_point T>
	F64 set(T value)
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!!(m_flags & StatFlag::kFloat));
		checkThread();
		F64 orig;
		if(!!(m_flags & StatFlag::kMainThreadUpdates))
		{
			orig = m_f;
			m_f = value;
		}
		else
		{
			LockGuard lock(m_floatLock);
			orig = m_f;
			m_f = value;
		}
		return orig;
#else
		(void)value;
		return 0.0;
#endif
	}

	template<std::integral T>
	U64 max(T value)
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!(m_flags & StatFlag::kFloat));
		checkThread();
		U64 orig;
		if(!!(m_flags & StatFlag::kMainThreadUpdates))
		{
			orig = m_u;
			m_u = value;
		}
		else
		{
			orig = m_atomic.max(value);
		}
		return orig;
#else
		(void)value;
		return 0;
#endif
	}

	template<std::floating_point T>
	F64 max([[maybe_unused]] T value)
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT("Not supported for floats");
		return 0.0;
#else
		(void)value;
		return 0.0;
#endif
	}

	template<std::integral T>
	U64 getValue() const
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!(m_flags & StatFlag::kFloat));
		checkThread();
		return !!(m_flags & StatFlag::kMainThreadUpdates) ? m_u : m_atomic.load();
#else
		return 0;
#endif
	}

	template<std::floating_point T>
	F64 getValue() const
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(!!(m_flags & StatFlag::kFloat));
		checkThread();
		if(!!(m_flags & StatFlag::kMainThreadUpdates))
		{
			return m_f;
		}
		else
		{
			LockGuard lock(m_floatLock);
			return m_f;
		}
#else
		return -1.0;
#endif
	}

private:
#if ANKI_STATS_ENABLED
	union
	{
		Atomic<U64> m_atomic = {0};
		U64 m_u;
		F64 m_f;
	};

	union
	{
		U64 m_prevValueu = 0;
		F64 m_prevValuef;
	};

	const Char* m_name = nullptr;

	mutable SpinLock m_floatLock;

	StatFlag m_flags = StatFlag::kNone;
	StatCategory m_category = StatCategory::kCount;

	void checkThread() const;
#endif
};

/// A collection of stat counters.
class StatsSet : public MakeSingletonSimple<StatsSet>
{
	friend class StatCounter;

	template<typename>
	friend class MakeSingletonSimple;

public:
	void initFromMainThread()
	{
#if ANKI_STATS_ENABLED
		ANKI_ASSERT(m_mainThreadId == kMaxU64);
		m_mainThreadId = Thread::getCurrentThreadId();
#endif
	}

	/// @note Not thread-safe.
	template<typename TFuncUint, typename TFuncFloat>
	void iterateStats(TFuncUint funcUint, TFuncFloat funcFloat)
	{
#if ANKI_STATS_ENABLED
		for(U32 i = 0; i < m_statCounterArrSize; ++i)
		{
			const StatCounter& counter = *m_statCounterArr[i];
			if(!!(counter.m_flags & StatFlag::kFloat))
			{
				funcFloat(counter.m_category, counter.m_name, counter.m_prevValuef, counter.m_flags);
			}
			else
			{
				funcUint(counter.m_category, counter.m_name, counter.m_prevValueu, counter.m_flags);
			}
		}
#else
		(void)funcUint;
		(void)funcFloat;
#endif
	}

	/// @note Not thread-safe.
	void endFrame()
#if ANKI_STATS_ENABLED
		;
#else
	{
	}
#endif

	/// @note Thread-safe.
	U32 getCounterCount() const
	{
#if ANKI_STATS_ENABLED
		return m_statCounterArrSize;
#else
		return 0;
#endif
	}

private:
#if ANKI_STATS_ENABLED
	StatCounter** m_statCounterArr = nullptr;
	U32 m_statCounterArrSize = 0;
	U32 m_statCounterArrStorageSize = 0;
	U64 m_mainThreadId = kMaxU64;
#endif

	StatsSet() = default;

#if ANKI_STATS_ENABLED
	~StatsSet();

	void registerCounter(StatCounter* counter);
#endif
};

inline StatCounter::StatCounter(StatCategory category, const Char* name, StatFlag flags)
#if ANKI_STATS_ENABLED
	: m_name(name)
	, m_flags(flags)
	, m_category(category)
{
	ANKI_ASSERT(name);
	ANKI_ASSERT(m_category < StatCategory::kCount);
	StatsSet::getSingleton().registerCounter(this);
}
#else
{
	(void)category;
	(void)name;
	(void)flags;
}
#endif

#if ANKI_STATS_ENABLED
inline void StatCounter::checkThread() const
{
	if(!!(m_flags & StatFlag::kMainThreadUpdates))
	{
		ANKI_ASSERT(StatsSet::getSingleton().m_mainThreadId == Thread::getCurrentThreadId() && "Counter can only be updated from the main thread");
	}
}
#endif
/// @}

} // end namespace anki