統計システムの概要

ゲームの最適化に利用するために 統計システム を使用してパフォーマンス データを収集して表示できます。

Stat コマンドのヘルプを参照するには、コンソールに stat と入力するか PrintStatsHelpToOutputDevice(); メソッドを参照してください。

タイプ

統計システムは、次の統計のタイプをサポートしています。

統計項目をグループ化する

各統計項目はグループ化されている必要があります。これは、通常、指定された統計グループの表示と一致します。例えば stat statsystem は統計システムの関連データを表示します。

統計グループを定義するには、次のいずれかのメソッドを使用します。

ここでは、次のようになります。

• GroupDesc はグループのテキスト記述です
• GroupId はグループの UNIQUE ID です
• GroupCat は将来の使用のために予約されています
• CompileIn が true に設定されている場合、コンパイラによって削除される可能性があります

使用するスコープに応じて、ソース ファイルまたはヘッダ ファイルでグループ化を行うことができます。

使用例

	DECLARE_STATS_GROUP(TEXT("Threading"), STATGROUP_Threading, STATCAT_Advanced);
	DECLARE_STATS_GROUP_VERBOSE(TEXT("Linker Load"), STATGROUP_LinkerLoad, STATCAT_Advanced);
Copy full snippet

DECLARE_STATS_GROUP(TEXT("Threading"), STATGROUP_Threading, STATCAT_Advanced); DECLARE_STATS_GROUP_VERBOSE(TEXT("Linker Load"), STATGROUP_LinkerLoad, STATCAT_Advanced);

統計項目の宣言と定義を行う

統計項目を宣言して定義できますが、その前に、統計項目は次の範囲内で使用できることに注意してください。

• 単一の cpp ファイルのみ
• 関数スコープ
• モジュール スコープ
• プロジェクト全体

単一ファイルの場合

スコープが単一ファイルの場合、統計項目のタイプに応じて、次のいずれかのメソッドを使用する必要があります。

複数のファイルの場合

プロジェクト全体 (またはより広範囲のファイル) から統計項目にアクセスできるようにするには、extern バージョンを使用する必要があります。 これらのメソッドは前に説明したのと同じものですが、次のように名前の終わりに _EXTERN が付いています。

DECLARE_CYCLE_STAT_EXTERN(CounterName, StatId, GroupId, API) DECLARE_FLOAT_COUNTER_STAT_EXTERN(CounterName, StatId, GroupId, API) DECLARE_DWORD_COUNTER_STAT_EXTERN(CounterName, StatId, GroupId, API) DECLARE_FLOAT_ACCUMULATOR_STAT_EXTERN(CounterName, StatId, GroupId, API) DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN(CounterName, StatId, GroupId, API) DECLARE_MEMORY_STAT_EXTERN(CounterName, StatId, GroupId, API) DECLARE_MEMORY_STAT_POOL_EXTERN(CounterName, StatId, GroupId, Pool, API)

次に、ソースファイルで、次のパラメータを指定し、_EXTERN 付きでこれらの統計項目を宣言して定義する必要があります。

ここでは、次のようになります。

• CounterName は統計項目のテキスト記述です
• StatId は統計項目の UNIQUE ID です
• GroupId は統計項目が属するグループの ID です。GroupId は、「DECLARE_STATS_GROUP*」で指定したものです
• Pool はプラットフォーム固有のメモリ プールです
• API はモジュールの 「*_API」です。統計項目がそのモジュールでのみ使用される場合は、空にすることができます

例

プールを使用するカスタムのメモリ統計

最初に、enum EMemoryCounterRegion に新しいプールを追加する必要があります。これは、グローバルまたはプラットフォーム固有のものになります。

	enum EMemoryCounterRegion
	{
		MCR_Invalid,		// not memory
		MCR_Physical,		// main system memory
		MCR_GPU,			// memory directly a GPU (graphics card)
		MCR_GPUSystem,		// system memory directly accessible by a GPU
		MCR_TexturePool,	// pre-sized texture pools
		MCR_MAX
	};
Copy full snippet

enum EMemoryCounterRegion { MCR_Invalid, // not memory MCR_Physical, // main system memory MCR_GPU, // memory directly a GPU (graphics card) MCR_GPUSystem, // system memory directly accessible by a GPU MCR_TexturePool, // pre-sized texture pools MCR_MAX };

次の例では、どこからでもプールを使用できます ( を参照)。

プール名は MCR_ で始める必要があります。

ヘッダ ファイルの例

	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Physical Memory Pool [Physical]"), MCR_Physical, STATGROUP_Memory, FPlatformMemory::MCR_Physical, CORE_API);
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("GPU Memory Pool [GPU]"), MCR_GPU,STATGROUP_Memory, FPlatformMemory::MCR_GPU, CORE_API);
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Texture Memory Pool [Texture]"), MCR_TexturePool, STATGROUP_Memory, FPlatformMemory::MCR_TexturePool,CORE_API);
Copy full snippet

DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Physical Memory Pool [Physical]"), MCR_Physical, STATGROUP_Memory, FPlatformMemory::MCR_Physical, CORE_API); DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("GPU Memory Pool [GPU]"), MCR_GPU,STATGROUP_Memory, FPlatformMemory::MCR_GPU, CORE_API); DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Texture Memory Pool [Texture]"), MCR_TexturePool, STATGROUP_Memory, FPlatformMemory::MCR_TexturePool,CORE_API);

ソース ファイルの例

	DEFINE_STAT(MCR_Physical);
	DEFINE_STAT(MCR_GPU);
	DEFINE_STAT(MCR_TexturePool);

	// これはプールです。そのため、通常は、F*PlatformMemory::Init() で初期化する必要があります。
	SET_MEMORY_STAT(MCR_Physical, PhysicalPoolLimit);
	SET_MEMORY_STAT(MCR_GPU, GPUPoolLimit);
	SET_MEMORY_STAT(MCR_TexturePool, TexturePoolLimit);

	// プールが作成できたら、プールのメモリ統計を設定できます。

	// 以下は、どこからでもアクセス可能です。
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Index buffer memory"), STAT_IndexBufferMemory, STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API);
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Vertex buffer memory"), STAT_VertexBufferMemory, STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API);
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Structured buffer memory"), STAT_StructuredBufferMemory,STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API);
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Pixel buffer memory"), STAT_PixelBufferMemory, STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API);

	// 以下は、定義されたモジュール内でのみアクセス可能です。
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Pool Memory Size"), STAT_TexturePoolSize, STATGROUP_Streaming, FPlatformMemory::MCR_TexturePool, );
	DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Pool Memory Used"), STAT_TexturePoolAllocatedSize, STATGROUP_Streaming, FPlatformMemory::MCR_TexturePool, );

	// 最後に、メモリ統計を更新する必要があります。

	// 指定された値の分だけメモリ統計を増やします。
	INC_MEMORY_STAT_BY(STAT_PixelBufferMemory,NumBytes);
	// 指定された値の分だけメモリ統計を減らします。
	DEC_MEMORY_STAT_BY(STAT_PixelBufferMemory,NumBytes);
	// 指定された値でメモリ統計を設定します。
	SET_MEMORY_STAT(STAT_PixelBufferMemory,NumBytes);
Copy full snippet

DEFINE_STAT(MCR_Physical); DEFINE_STAT(MCR_GPU); DEFINE_STAT(MCR_TexturePool); // これはプールです。そのため、通常は、F*PlatformMemory::Init() で初期化する必要があります。 SET_MEMORY_STAT(MCR_Physical, PhysicalPoolLimit); SET_MEMORY_STAT(MCR_GPU, GPUPoolLimit); SET_MEMORY_STAT(MCR_TexturePool, TexturePoolLimit); // プールが作成できたら、プールのメモリ統計を設定できます。 // 以下は、どこからでもアクセス可能です。 DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Index buffer memory"), STAT_IndexBufferMemory, STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API); DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Vertex buffer memory"), STAT_VertexBufferMemory, STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API); DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Structured buffer memory"), STAT_StructuredBufferMemory,STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API); DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Pixel buffer memory"), STAT_PixelBufferMemory, STATGROUP_RHI, FPlatformMemory::MCR_GPU, RHI_API); // 以下は、定義されたモジュール内でのみアクセス可能です。 DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Pool Memory Size"), STAT_TexturePoolSize, STATGROUP_Streaming, FPlatformMemory::MCR_TexturePool, ); DECLARE_MEMORY_STAT_POOL_EXTERN(TEXT("Pool Memory Used"), STAT_TexturePoolAllocatedSize, STATGROUP_Streaming, FPlatformMemory::MCR_TexturePool, ); // 最後に、メモリ統計を更新する必要があります。 // 指定された値の分だけメモリ統計を増やします。 INC_MEMORY_STAT_BY(STAT_PixelBufferMemory,NumBytes); // 指定された値の分だけメモリ統計を減らします。 DEC_MEMORY_STAT_BY(STAT_PixelBufferMemory,NumBytes); // 指定された値でメモリ統計を設定します。 SET_MEMORY_STAT(STAT_PixelBufferMemory,NumBytes);

プールを使用しない通常のメモリ統計

	DECLARE_MEMORY_STAT(TEXT("Total Physical"), STAT_TotalPhysical, STATGROUP_MemoryPlatform);
	DECLARE_MEMORY_STAT(TEXT("Total Virtual"), STAT_TotalVirtual, STATGROUP_MemoryPlatform);
	DECLARE_MEMORY_STAT(TEXT("Page Size"), STAT_PageSize, STATGROUP_MemoryPlatform);
	DECLARE_MEMORY_STAT(TEXT("Total Physical GB"), STAT_TotalPhysicalGB, STATGROUP_MemoryPlatform);
Copy full snippet

DECLARE_MEMORY_STAT(TEXT("Total Physical"), STAT_TotalPhysical, STATGROUP_MemoryPlatform); DECLARE_MEMORY_STAT(TEXT("Total Virtual"), STAT_TotalVirtual, STATGROUP_MemoryPlatform); DECLARE_MEMORY_STAT(TEXT("Page Size"), STAT_PageSize, STATGROUP_MemoryPlatform); DECLARE_MEMORY_STAT(TEXT("Total Physical GB"), STAT_TotalPhysicalGB, STATGROUP_MemoryPlatform);

または、必要に応じて、ヘッダ ファイルに DECLARE_MEMORY_STAT_EXTERN、ソース ファイルに DEFINE_STAT を記述することができます。

メモリ統計の更新は、プールを使用したバージョンと同じ方法で行われます。

Cycle Counter を使用したパフォーマンス データ

最初に、Cycle Counter を追加する必要があります。

	DECLARE_CYCLE_STAT(TEXT("Broadcast"), STAT_StatsBroadcast, STATGROUP_StatSystem);
	DECLARE_CYCLE_STAT(TEXT("Condense"), STAT_StatsCondense, STATGROUP_StatSystem);
Copy full snippet

DECLARE_CYCLE_STAT(TEXT("Broadcast"), STAT_StatsBroadcast, STATGROUP_StatSystem); DECLARE_CYCLE_STAT(TEXT("Condense"), STAT_StatsCondense, STATGROUP_StatSystem);

または、必要に応じて、ヘッダ ファイルに DECLARE_CYCLE_STAT_EXTERN、ソース ファイルに DEFINE_STAT を記述することができます。

これで、以下のようにパフォーマンス データを取得できます。

	Stats::Broadcast()
	{
		SCOPE_CYCLE_COUNTER(STAT_StatsBroadcast);
		// ...
		// コードの一部
		// ...
	}
Copy full snippet

Stats::Broadcast() { SCOPE_CYCLE_COUNTER(STAT_StatsBroadcast); // ... // コードの一部 // ... }

関数が呼び出されるたびに統計情報を取得したくない場合は、条件付き Cycle Counter を使用できます。それほど一般的な方法ではありませんが、役に立つ場合があります。

	Stats::Broadcast(bool bSomeCondition)
	{

		CONDITIONAL_SCOPE_CYCLE_COUNTER(STAT_StatsBroadcast,bSomeCondition);
		// ...
		// コードの一部
		// ...
	}
Copy full snippet

Stats::Broadcast(bool bSomeCondition) { CONDITIONAL_SCOPE_CYCLE_COUNTER(STAT_StatsBroadcast,bSomeCondition); // ... // コードの一部 // ... }

単一の関数からパフォーマンス データを取得する場合は、次の構文を使用できます。

	Stats::Broadcast(bool bSomeCondition)
	{
		DECLARE_SCOPE_CYCLE_COUNTER(TEXT("Broadcast"), STAT_StatsBroadcast, STATGROUP_StatSystem);
		// ...
		// コードの一部
		// ...
	}
Copy full snippet

Stats::Broadcast(bool bSomeCondition) { DECLARE_SCOPE_CYCLE_COUNTER(TEXT("Broadcast"), STAT_StatsBroadcast, STATGROUP_StatSystem); // ... // コードの一部 // ... }

次のようにすることもできます。

	Stats::Broadcast(bool bSomeCondition)
	{
		QUICK_SCOPE_CYCLE_COUNTER(TEXT("Stats::Broadcast"));
		// ...
		// コードの一部
		// ...
	}
Copy full snippet

Stats::Broadcast(bool bSomeCondition) { QUICK_SCOPE_CYCLE_COUNTER(TEXT("Stats::Broadcast")); // ... // コードの一部 // ... }

これは主に一時的な統計に使用されます。

前述のすべての Cycle Counter は使用すると、パフォーマンス データに関する詳細な情報を取得するために、階層が生成されます。ただし、フラットな Cycle Counter を設定するオプションもあります。

	Stats::Broadcast(bool bSomeCondition)
	{
		const uint32 BroadcastBeginTime = FPlatformTime::Cycles();
		// ...
		// コードの一部
		// ...
		const uint32 BroadcastEndTime = FPlatformTime::Cycles();
		SET_CYCLE_COUNTER(STAT_StatsBroadcast, BroadcastEndTime-BroadcastBeginTime);
	}
Copy full snippet

Stats::Broadcast(bool bSomeCondition) { const uint32 BroadcastBeginTime = FPlatformTime::Cycles(); // ... // コードの一部 // ... const uint32 BroadcastEndTime = FPlatformTime::Cycles(); SET_CYCLE_COUNTER(STAT_StatsBroadcast, BroadcastEndTime-BroadcastBeginTime); }

GetStatId を使用したパフォーマンス データ

Unreal Engine に実装されているいくつかのタスクは、パフォーマンス データの取得に関して異なるアプローチを使用します。これらは、GetStatId() メソッドを実装します。GetStatId() が存在しない場合、コードはコンパイルされません。

次に例を示します。

	class FParallelAnimationCompletionTask
	{
		// ...
		// コードの一部
		// ...
		FORCEINLINE TStatId GetStatId() const
		{
			RETURN_QUICK_DECLARE_CYCLE_STAT(FParallelAnimationCompletionTask, STATGROUP_TaskGraphTasks);
		}
		// ...
		// コードの一部
		// ...
	};
Copy full snippet

class FParallelAnimationCompletionTask { // ... // コードの一部 // ... FORCEINLINE TStatId GetStatId() const { RETURN_QUICK_DECLARE_CYCLE_STAT(FParallelAnimationCompletionTask, STATGROUP_TaskGraphTasks); } // ... // コードの一部 // ... };

パフォーマンス データをログに記録する

単にパフォーマンス データをログに記録する場合は、次の機能を使用できます。

メソッド

次のメソッドは、時間 (秒単位で渡される) を取得し、渡された変数にデルタ時間を追加します。

SCOPE_SECONDS_COUNTER(double& Seconds)

コードの例

	Stats::Broadcast()
	{
		double ThisTime = 0;
		{
	       SCOPE_SECONDS_COUNTER(ThisTime);
	  		// ...
			// コードの一部
			// ...
		}
		UE_LOG(LogTemp, Log, TEXT("Stats::Broadcast %.2f"), ThisTime);	
	}
Copy full snippet

Stats::Broadcast() { double ThisTime = 0; { SCOPE_SECONDS_COUNTER(ThisTime); // ... // コードの一部 // ... } UE_LOG(LogTemp, Log, TEXT("Stats::Broadcast %.2f"), ThisTime); }

ユーティリティ クラスとメソッド

コードの例

	double GMyBroadcastTime = 0.0;
	Stats::Broadcast()
	{
		SCOPE_LOG_TIME("Stats::Broadcast", &GMyBroadcastTime);
		SCOPE_LOG_TIME_IN_SECONDS("Stats::Broadcast (sec)", &GMyBroadcastTime);
		// ...
		// コードの一部
		// ...
	}

	Stats::Condense()
	{
		// 名前は「Stats::Condense()」にする必要があります。ただし、コンパイラによって異なる場合があります。
		SCOPE_LOG_TIME_FUNC_WITH_GLOBAL(&GMyBroadcastTime);
		// ...
		// コードの一部
		// ...
	}
Copy full snippet

double GMyBroadcastTime = 0.0; Stats::Broadcast() { SCOPE_LOG_TIME("Stats::Broadcast", &GMyBroadcastTime); SCOPE_LOG_TIME_IN_SECONDS("Stats::Broadcast (sec)", &GMyBroadcastTime); // ... // コードの一部 // ... } Stats::Condense() { // 名前は「Stats::Condense()」にする必要があります。ただし、コンパイラによって異なる場合があります。 SCOPE_LOG_TIME_FUNC_WITH_GLOBAL(&GMyBroadcastTime); // ... // コードの一部 // ... }

FLOAT Counter または DWORD Counter を使用した汎用データ

通常、最初に行う必要があるのは、次のようなカウンターを追加することです。

	DECLARE_FLOAT_COUNTER_STAT_EXTERN(STAT_FloatCounter,StatId,STATGROUP_TestGroup, CORE_API);
	DECLARE_DWORD_COUNTER_STAT_EXTERN(STAT_DwordCounter,StatId,STATGROUP_TestGroup, CORE_API);
	DECLARE_FLOAT_ACCUMULATOR_STAT_EXTERN(STAT_FloatAccumulator,StatId,STATGROUP_TestGroup, CORE_API);
	DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN(STAT_DwordAccumulator,StatId,STATGROUP_TestGroup, CORE_API);
Copy full snippet

DECLARE_FLOAT_COUNTER_STAT_EXTERN(STAT_FloatCounter,StatId,STATGROUP_TestGroup, CORE_API); DECLARE_DWORD_COUNTER_STAT_EXTERN(STAT_DwordCounter,StatId,STATGROUP_TestGroup, CORE_API); DECLARE_FLOAT_ACCUMULATOR_STAT_EXTERN(STAT_FloatAccumulator,StatId,STATGROUP_TestGroup, CORE_API); DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN(STAT_DwordAccumulator,StatId,STATGROUP_TestGroup, CORE_API);

次に、カウンターを更新および管理するには、次のメソッドを使用できます。

カウンターの更新メソッド

カウンターを管理するヘルパー メソッド