Memory Insights

Unreal Engine 5 (UE5) では Unreal Insights の機能が拡張され、改善されたメモリ トラッキングとプロファイリング向けのサポートが「Memory Insights」機能に追加されました。これによりデベロッパーは、任意の時点でメモリの各ブロックに関連付けられた Low Level Memory (LLM) タグ やコールスタックなど、メモリの割り当てと解放に関する情報をさらに詳細に確認できるようになりました。 Memory Insights が備えるクエリ システムを利用すると、特定の時点でのライブ割り当てを見つけて、メモリ使用量の増減を確認し、短期と長期の割り当てを区別して、メモリリークを発見できます。

セッションをレコーディングする

Memory Insights の利用を開始し、メモリ チャンネル内のトレースを記録するには、以下の手順に従います。

Unreal Insights を実行またはビルドする

[Start (スタート)] > [Command Prompt (コマンド プロンプト)] に移動し、以下を入力します。

		Engine\Binaries\Win64\UnrealInsights.exe

Copy full snippet

Engine\Binaries\Win64\UnrealInsights.exe

または、「Engine\Binaries\Win64」フォルダに移動し、「UnrealInsights.exe」をダブルクリックすることでも実行できます。

メモリ トレーシングを使用してゲーム プロジェクトを実行する

オペレーティング システムから コマンド プロンプト を起動し、次のプロジェクト サンプルを実行します。

	cd C:\MyEngineInstallLocation\

	Samples\Games\MyGameSample\Binaries\Win64\MyGameSample.exe -trace=default,memory

Copy full snippet

cd C:\MyEngineInstallLocation\ Samples\Games\MyGameSample\Binaries\Win64\MyGameSample.exe -trace=default,memory

プロジェクトのセッションをレコーディングするには、プロセスの最初からメモリ トレース チャンネルを有効にしておく必要があります。そうしないと、遅延接続セッションで割り当てイベントのトレーシングを開始することはできません。さらに、パッケージ化されたプロジェクトでトレースを実行している場合は、開発 モードでパッケージ化されていることを確認する必要があります。

trace コマンド metadata と assetmetadata を使用すると、アセット名とクラス名に追加のフィルタリング オプションを用意できます。たとえば、アセットごとやクラス名ごとにメモリ アロケーションの負荷を計算できます。

	Samples\Games\MyGameSample\Binaries\Win64\MyGameSample.exe -trace=default,memory,metadata,assetmetadata

Copy full snippet

Samples\Games\MyGameSample\Binaries\Win64\MyGameSample.exe -trace=default,memory,metadata,assetmetadata

Insights セッション ブラウザからトレースを開く

Unreal Insights セッション ブラウザに戻って、Unreal Engine の [Timing Insights (タイミング インサイト)] ウィンドウでの分析のために .utrace ファイルをダブルクリックして開きます。[Menu (メニュー)] > [Memory Insights (メモリ インサイト)] を選択し、[Memory Insights] ウィンドウを開きます。

メモリ割り当て - グラフ トラック

Unreal Insights では、プロジェクトに割り当てられているメモリの分析を提供するために、各割り当てイベントの完全なコールスタックをキャプチャします。Memory Insights のメイン インターフェースには、セッション中のメモリ使用に関する概要を示すタイムラインが表示されます。

Memory Insights トラッカーには、メモリ内のライブ割り当て量についての情報が表示されます。上の図には、[Main Memory Graph (メイン メモリ グラフ)]、[Live Allocation Count (ライブ割り当て数)]、[Alloc/Free Event Count (割り当て/解放イベント数)] が示されています。

[Main Memory Graph (メイン メモリ グラフ)] には、プロジェクトで追跡したメモリの総量が表示されます。これには、LLM から収集した各タグの情報が含まれます。さらに、ライブ割り当ての合計数を示す次のグラフがあります。

これらの各グラフは、詳細な割り当ての追跡に基づいています。追跡は、時間値 0 から開始され、約 1ms の詳細度があります。LLM プレフィックス タグ (RenderTargets、SceneRender、UObject) があるその他のグラフは、Low-Level Memory トラッキング ランタイム システムに基づいています。

これらのタグは、セッションが開始して数秒してからトラッキングを開始し、フレーム単位の詳細度があります。

デフォルトでは、4096 の割り当て/空きイベントごとに 1 つのタイムスタンプを発行します。必要に応じて、Engine/Source/Runtime/Core/Private/ProfilingDebugging/MemoryAllocationTrace.cpp にある MarkerSamplePeriod を変更することにより、この量を変更できます。たとえば、この変数の値を 0 に設定すると、割り当て/解放イベントが発生するごとに 1 つのタイムスタンプが発行されます。

Memory Insights のタイムラインは、[Timing View (タイミング ビュー)] へのトラックのオーバーレイをサポートしています。 Memory Insights ビューには、[Timing (タイミング)]、[Investigation (調査)]、[LLM Tags (LLM タグ)]、および [Modules (モジュール)] の 4 つのパネルが表示されます。

Timing View

[Timing] をクリックして、[Timing View] ウィンドウの表示を切り替えることができます。ここでは、メモリ使用率に関連するさまざまなトラックのパフォーマンス データを観察およびフィルタできます。

Investigation パネル

[Investigation] パネルでは、割り当てに関するさまざまなクエリを実行できます。

Low-Level Memory (LLM) Tags

[LLM Tags] では、さまざまな LLM タグの可視性を制御します。このデータは、使用しているオペレーティング システムから直接トレースされます。

LLM タグ、アセット および ソース ファイル を次のようにグループ化できます。

Modules

コール スタック シンボルが解決されると、その結果がキャッシュ ファイルに格納されます。これらのファイルは、[Modules (モジュール)] をクリックすることで表示できます。このパネルでは、古いトレース ファイルを開いて、シンボルを使用できます。

Discovered、Cached、Resolved、および Failed となっているシンボルの数の列を確認できます。失敗したリスト アイテムが赤色で強調表示され、正しく解決されたリスト アイテムは緑色で強調表示されます。黄色は一部のシンボルが解決され、一部が失敗したことを示しています。

以前のメモリ トラッキングのランタイムの実装は、フォルダ「Engine\Source\Runtime\Core\Public\HAL\LowLevelMemTracker.h」内の LowLevelMemTracker クラスに実装されています。[LLM Tags] パネルと LLM グラフの両方で、このシステムから直接トレースされたデータが使用されています。詳細な割り当てデータは、別の固有のトレースの実装から取得されます。

Memory Insights には、新しいクエリ機能と追跡されたメモリ割り当て情報が含まれます。特定の時間枠 (ある瞬間の前後) に UE5 が割り当て/解放を行ったメモリ ブロックを特定したり、メモリリークを確認したりできます。クエリ システムにアクセスするには、トレース ログを開いて [Investigation] タブに移動します。

[Investigation] - 割り当てのクエリ

タイムラインにメモリ使用率の概要が示されると同時に、「クエリ」を使用することで、一定の時間範囲にわたる個々の割り当ての振る舞いが評価されます。クエリ は、ルール と、「A」や「B」ラベルなどの タイムスタンプ (複数可) によって定義されます。

[Investigation] パネル には、データを評価するための クエリ ルールが含まれます。

使用可能な クエリ ルール は次のとおりです。

クエリを作成するには、ルールを選択して、タイムライン内のラベル付きマーカーを目的の位置にドラッグするか、[Investigation] タブ内で時間を指定します。

目的のルールと時間を選択したら、[Investigation] タブの [Run Query (クエリを実行)] ボタンをクリックしてクエリを実行します。

クエリとキャプチャするデータ セットによっては、クエリの実行に長時間かかる場合があります。

割り当ての詳細ビュー

クエリを実行すると新しいウィンドウが表示され、クエリが完了した際にその結果が割り当てテーブルに表示されます。デフォルトでは、この結果はフラット リストの形式で表示されます。

それぞれの割り当ては、その Count (カウント)、Size (サイズ)、LLM Tag (LLM タグ)、Callstack Size (コールスタック サイズ)、割り当てを行った Function (ファンクション) とともに表示されます。

関数名または情報アイコン上にマウス カーソルを合わせると、追加情報と完全なコール スタックが表示されます。

情報アイコン上にマウス カーソルを合わせると、完全なコール スタックが表示されます。

ソート

テーブルのヘッダをクリックすることで、リストをさまざまな列でソートできます。

Grouping (グループ化)

割り当てをグループにまとめるには、[Preset (プリセット)] オプションを使用できます。

[Hierarchy (階層)] に移動して [All (すべて)] をクリックするとドロップダウン メニューが表示され、ここでデフォルトの フラット ビュー から別のグループ化オプションに変更することができます。

次のオプションのリストから階層をグループ化できます。

詳細フィルタリング

検索テキスト ボックスでは、階層ノードのテキストに基づいて結果を迅速にフィルタする方法を利用できます。クエリによって生成された割り当てのセットは、検索テキスト ボックスの横の Filter Configurator をクリックしてさらにフィルタを適用し、割り当てのグループを分離できます。

グループや、AND/OR キーワードを使用し、詳細なクエリを構築することもできます。

コールスタック シンボル解決

プログラム カウンター アドレスを使用することで、プロジェクトからの コールスタック シンボル トレーシング を実行できます。解析では、対応するソース ファイルに関する情報とともに、これらのアドレスを読み取り可能な文字列に解決する必要があります。

これには、Memory Insights でデバッグ情報を含む正しいバージョンのファイル (プラットフォームに応じて) .pdb または .elf ファイルにアクセスできる必要があります。Insights では、次のリストに従って正しいファイルを検索します。

1. このセッション中にユーザーによって入力された新しいパス。

2. 実行可能ファイルのパス (一部のプラットフォームで利用可能な場合。これはコンパイルされてバイナリになる)。

3. UE_INSIGHTS_SYMBOLPATH 環境変数からのパス。この変数は、セミコロン区切りのパスを受け入れます。

4. ユーザー コンフィギュレーション ファイルからのパス。

すべてのシンボルが解決されると、その結果がキャッシュ ファイルに格納されます。これらのファイルは、[Modules] パネルをクリックすると表示できます。続いて、選択したファイルを右クリックし、ドロップダウン メニューから以下のうち 1 つを選択すると、これらのファイルを開くことができます。

これにより、トレース ファイルを他のユーザーに送信する方法が提供されます。このデバッグ情報へのアクセス権は不要です。

現時点では、シンボルの解決は Win64、XB1/XSX、PS4/PS5、および Switch でサポートされています。

複数のアドレス空間

メモリ トレーシングでは、さまざまな ヒープ のメモリをトラックします。概念上、あらゆる割り当ては ルート ヒープ に属しており、一つのタイプのメモリを表します。たとえばデスクトップ プラットフォームでは、あるルート ヒープがシステム メモリで、他のものがグラフィック カード上のビデオ メモリである場合があります。それぞれのルート ヒープには独自のアドレス空間があります。 各ルート ヒープでは、割り当てのホストが可能なヒープ割り当てが作成されます。通常、これは割り当てをバックアップする仮想メモリ割り当てを意味しますが、ヒープ割り当てでブロック スタイル アロケータを表すことも可能です。これによって、これらのメモリ ブロックの使用に関する調査が提供されます。