【CEDEC2018】一歩先のUnityでのパフォーマンス/メモリ計測、デバッグ術

2018/8/22 一歩先の Unity でのパフォーマンス / メモリ計測、デバッグ術講演者名黒河優介所属団体 Unity Technologies Japan 肩書・役職 Developer Relation Engineer

自己紹介 • 役職 • ユニティ・テクノロジーズ・ジャパン合同会社エンタープライズコンサルティングデベロッパーリレーションマネージャー／エンジニア • 仕事内容 • 大規模プロジェクトのサポート業務 • プロジェクトに合う形で、パフォーマンスに関する提案等を行っている

3.

まず初めに… 快適に動作するアプリケーションを作成するためには、パフォーマンス計測を行いボトルネックとなる箇所を修正や、デバッグを行いバグを修正していくことが重要になります。 Unityはパフォーマンス計測や、デバッグのための機能を日々アップデートしています。このセッションでは直近のアップデートを紹介し、皆様の開発に役立てれば幸いです。 ※テストの話はしません

4.

本日のアジェンダ • Profiler、デバッグ機能についてのおさらい • 実機だけでも使えるパフォーマンス計測術 • Profiler、デバッグ機能関連のアップデート情報

5.

Profiler、デバッグ機能おさらい

6.

おさらい • Unity Profiler • Frame Debugger • Consoleウィンドウ • Script Debugging • プラットフォーム毎のツール

7.

おさらい • Unity Profiler • Frame Debugger • Consoleウィンドウ • Script Debugging • プラットフォーム毎のツール

8.

Unity Profiler CPU/Rendering/Memoryなどのパフォーマンス測定が出来ます。

9.

Unity Profiler 画面上半分は各項目の推移グラフで、下半分は選択した項目の詳細が表示されます

10.

Unity Profiler Timeline表示に切り替えて別スレッドの処理も確認する事が出来ます

11.

Unity Profiler Deep ProfileをONにすると、C#呼び出しで深い階層も自動的に計測対象となります (Editor上での実行時のみ有効)

12.

Unity Profiler Profile EditorをONにすると、EditorでのC#処理が計測の対象となります。

13.

Unity Profiler ネットワークや有線ケーブルを利用して、実機でのパフォーマンス計測も可能です ※要Development ビルド

14.

Unity Profiler Profilerに自分で定義した項目を載せる事が可能です

15.

Unity Profiler public class Sample : MonoBehaviour { private CustomSampler sampler; void Start () { sampler = CustomSampler.Create("処理計測"); } void Update () { コードはこんな sampler.Begin(); // ..何か処理をします感じです sampler.End(); } }

16.

豆知識 Editor⇔実機間では Sample名の文字列も含まれているため、Profilerさえ繋げてしまえば別プロジェクトのProfilingが出来ます。 ※Unityのバージョン毎にデータフォーマットが変わるのでバージョンは合わせる必要があります

17.

おさらい • Unity Profiler • Frame Debugger • Consoleウィンドウ • Script Debugging • プラットフォーム毎のツール

18.

Frame Debugger Unityの描画処理を1ステップずつ確認出来ます。Shader パラメーターも確認出来ますので、描画関連のデバッグに利用できます

19.

おさらい • Unity Profiler • Frame Debugger • Consoleウィンドウ • Script Debugging • プラットフォーム毎のツール

20.

Consoleウィンドウ Debug.Logの出力先のConsoleウィンドウです

21.

Consoleウィンドウネットワークや有線経由で実機と接続して実機上のログを出力する事が出来ます (2017.1+)

22.

おさらい • Unity Profiler • Frame Debugger • Consoleウィンドウ • Script Debugging • プラットフォーム毎のツール

23.

Script Debugging Visual Studio等のIDE環境等を利用してUnity Editor上で動作している C# スクリプトのデバッグが出来ます。

24.

Script Debugging breakポイントを貼ったり、変数をウォッチしたりと普通にデバッグが出来ます

25.

Script Debugging BackEndがMonoでかつ、 Script Debuggingを有効にしている場合には実機上で動いているC# スクリプトのデバッグが出来ます

26.

Script Debugging ネットワーク/もしくは有線を利用して、実機上で動いている C#スクリプトのデバッグが出来ます(Mono限定)

27.

おさらい • Unity Profiler • Frame Debugger • Consoleウィンドウ • Script Debugging • プラットフォーム毎のツール

28.

プラットフォーム毎のツール • PC/Android • RenderDoc • iOS • Instruments • OpenGLES Frame Debugger • Android • Systrace • DS-5™ Streamline • Snapdragon Profiler • Mali Graphics Debugger • GAPID 等々…

29.

RenderDoc 描画の深いレベルでのデバッグに使えます

30.

Instruments 深いレベルでのCPUプロファイルが出来ます

31.

OpenGLES Frame Debugger 深いレベルでの描画のデバッグ・プロファイルが出来ます

32.

Systrace CPUで動いている処理等が確認出来ます

33.

DS-5™ Streamline ARM製のツールです。 CPUの様子等が確認出来ます

34.

Snapdragon Profiler 描画のデバッグが出来ます。チップセットがSnapdragonである必要があります。

35.

Mali Graphics Debugger 描画のデバッグやプロファイルが出来ます。GPUがMaliの場合に利用できます

36.

GAPID Google製のGraphicsデバッグツールです。画像付きでキャプチャーしてくれるので非常に便利です。

37.

Android向けツールは、コマンドライン向け SimplePerf、Intel Android向けツールなど多々あります。詳細は下記Webで https://unity3d.com/jp/learn/tutorials/topics/best-practices/android-profiling-tools

https://unity3d.com/jp/learn/tutorials/topics/best-practices/android-profiling-tools

38.

39.

実機でも使えるパフォーマンス計測術

40.

簡易的にパフォーマンス計測を日常的に行い、大事にならないようにしておく必要があります。日常的に目標とする端末でパフォーマンス上の問題が起きていないか確認しましょう。

41.

このような感じで実機上で視認できる形でパフォーマンスを「視える化」しておくのが大事です

42.

そのために必要な機能として、実機上でも動作するパフォーマンス計測の手法をお伝えいたします。

43.

実機でも使えるパフォーマンス計測術 • Time.realtimeSinceStartupを利用 • Time.realtimeSinceStartup + PlayerLoop(2018.1+) • Recorder APIについて • Memory情報の取得 • Profilerログデータ書き出し

44.

実機でも使えるパフォーマンス計測術 • Time.realtimeSinceStartupを利用 • Time.realtimeSinceStartup + PlayerLoop(2018.1+) • Recorder APIについて • Memory情報の取得 • Profilerログデータ書き出し

45.

[beta]

Time.realtimeSinceStartupの利用
void Update(){
float startTime = Time.realtimeSinceStartup;
DoSomething();
float executeTime = Time.realtimeSinceStartup - startTime;
Debug.Log(string.Format("DoSomethingに{0}ms掛かりました",
executeTime * 1000.0f));
}

Time.realtimeSinceStartupはアクセスした瞬間に時間を取りに行

きます。そのため、計測する箇所の前後の差分を求める事で処理
時間が取れます。 Releaseビルドでも計測可能です

46.

実機でも使えるパフォーマンス計測術 • Time.realtimeSinceStartupを利用 • Time.realtimeSinceStartup + PlayerLoop(2018.1+) • Recorder APIについて • Memory情報の取得 • Profilerログデータ書き出し

47.

PlayerLoopも活用 Unity 2018.1より追加されたPlayerLoopを利用することで、MainLoop中に行われる特定のUnity処理を省いたり、 Unity処理の間に独自のC#処理を差し込むことが可能です。これと Time.realtimeSinceStartupを組み合わせて、更に情報をとることが可能です

48.

PlayerLoopについて MonoBehaviour Updateを処理 Animatorの処理 MonoBehaviour LateUpdateを処理 Etc....

49.

PlayerLoopについて MonoBehaviour Updateを処理 Animatorの処理 MonoBehaviour LateUpdateを処理 LateUpdateは全くないので、この部分の処理を全て省くという事が出来たり… Etc....

50.

PlayerLoopについて MonoBehaviour Updateを処理 MonoBehaviour Animatorの処理 LateUpdateを処理 Animatorの処理の前後に特定のC#スクリプトを差し込むこともできます。 Etc....

51.

PlayerLoopについて PlayerLoopで設定できるステップはかなり種類が多いです。どんな種類があるかはProfielrのトップ階層を見ると何となくわかります。

52.

PlayerLoopも活用 MonoBehaviour Updateを処理 MonoBehaviour Animatorの処理 LateUpdateを処理 Animatorの処理の前後で Time.realtimeSinceFromStartup を取っておけば、 Animatorの処理時間をランタイムで計測出来ます！ Etc....

53.

PlayerLoopも活用 https://github.com/wotakuro/MainLoopProfilingSample

https://github.com/wotakuro/MainLoopProfilingSample

54.

PlayerLoopも活用水色：スクリプト処理赤色：Animator関連処理黄緑：描画関係紫色：その他それぞれの処理時間を表します https://github.com/wotakuro/MainLoopProfilingSample

https://github.com/wotakuro/MainLoopProfilingSample

55.

実機でも使えるパフォーマンス計測術 • Time.realtimeSinceStartupを利用 • Time.realtimeSinceStartup + PlayerLoop(2018.1+) • Recorder APIについて • Memory情報の取得 • Profilerログデータ書き出し

56.

Recorder APIについて Profilerに載っている名前を指定して、そこに掛かった処理時間をRuntime上で取得することが出来ます

57.

Recorder APIについて Recorder recorder = Recorder.Get("Camera.Render"); Debug.Log(string.Format(“{0}ms ({1} Calls)", recorder.elapsedNanoseconds * 0.00001f), recorder.sampleBlockCount); Recorder API で Profilerに表示される項目を取得できます。 ※ただし全Threadでの累計処理時間のみ取得可能です

58.

Recorder API について「Camera.Renderer」に 5.94ms(3.13 + 2.81)で2回呼び出しがあったという情報が取得できます

59.

先ほどのMainLoopとうまく組み合わせて … Camera.Renderの合計時間 - Main Thread側の描画処理時間で RenderThreadの処理負荷が概算できます

60.

実機でも使えるパフォーマンス計測術 • Time.realtimeSinceStartupを利用 • Time.realtimeSinceStartup + PlayerLoop(2018.1+) • Recorder APIについて • Memory情報の取得 • Profilerログデータ書き出し

61.

Memory情報の取得 • Profiler APIを利用して概要のざっくり把握 • Resources APIを利用して読み込んでるアセットを一覧で把握

62.

Profiler APIを使用して取得 • Managed Memoryの使用状況 • Profiler.GetMonoHeapSizeLong • Profiler.GetMonoUsedSizeLong • Unityが確保したメモリの使用状況 • Profiler.GetRuntimeMemorySizeLong • Profiler.GetTotalReservedMemoryLong • Profiler.GetTotalUnusedReservedMemoryLong

63.

読み込んでいるアセット一覧を取得 Resources.FindObjectsOfTypeAllを利用することで、実行中にメモリ上にあるアセットを列挙することが可能です。 ※Editor上で行った場合は、Editor実行時に読み込んだアセットも列挙されてしまうため、実機上で行う必要があります

64.

読み込んでいるアセット一覧を取得 Texture2D[] textures = Resources.FindObjectsOfTypeAll<Texture2D>(); Mesh[] meshes = Resources.FindObjectsOfTypeAll<Mesh>(); AudioClip[] audioClips = Resources.FindObjectsOfTypeAll<AudioClip>(); AnimationClip[] animationClips = Resources.FindObjectsOfTypeAll<AnimationClip>(); メモリに読み込んだアセット一覧の取得が上記のように出来ます

65.

実機でも使えるパフォーマンス計測術 • Time.realtimeSinceStartupを利用 • Time.realtimeSinceStartup + PlayerLoop(2018.1+) • Recorder APIについて • Memory情報の取得 • Profilerログデータ書き出し

66.

Profilerログデータ書き出し string logfile = Path.Combine(Application.persistentDataPath, "profiler.log"); Profiler.logFile = logfile; Profiler.enableBinaryLog = true; Profiler.enabled = true; Profilerを内部的に動かし、ログファイルとして結果を保存し始めます。止めるときは、下記呼び出しをします「Profiler.enabled = false;Profiler.logFile = null;」

67.

Profilerログデータ書き出し保存したログファイルは ProfilerのLoadで読み込めます。 ※1.Androidならば「adb pull ファイルパス」という形でコマンドラインでPCからログファイル取得できます。 ※2.iOSの場合、XCode上の「info.plist」を編集することで、iTunes からログファイルへのアクセスが可能になります。

68.

Profilerログデータ書き出しログファイル自体には、ログ書き出しを開始してからの全てのフレームが保存されていますが、表示側の問題で 300フレーム分しか表示されません…

69.

Profilerログデータ書き出し 300フレーム問題を解決するために専用のEditor拡張を作成しました。リポジトリ https://github.com/wotakuro/ProfilerBinarylogSplit

https://github.com/wotakuro/ProfilerBinarylogSplit

70.

アップデート情報

71.

アップデート情報 • 実機上でのProfiler動作の高速化(2017.3+) • 実機上でのDeepProfiling (2017.3+) • User Threadへの対応(2017.3+) • Native Plugin Callbackへの対応(2018.2+) • IL2CPPでのScript Debugging(2018.2+) • 新しいMemory Profiler(2018.3+)

72.

アップデート情報 • 実機上でのProfiler動作の高速化(2017.3+) • 実機上でのDeepProfiling (2017.3+) • User Threadへの対応(2017.3+) • Native Plugin Callbackへの対応(2018.2+) • IL2CPPでのScript Debugging(2018.2+) • 新しいMemory Profiler(2018.3+)

73.

実機上でのProfiler動作の高速化 • 2017.3のタイミングで実機⇔Editor間での通信フォーマットから見直し、実機上で動作するProfilerの負荷が下がりました • 1フレーム毎に全てのSample名を送っていたのをやめ、前のフレームで送っていた場合は、Sample名を送らないようにしました • 実機側で集計処理を行って結果をEditorに送信する実装になっていましたが、新しくEditor側で集計するようにしました

74.

2017.3以前では文字列を都度送ってます１フレーム目 BehaviourUpdate 2ms Player.Update 1ms Enemy.Update 0.5ms Bullet.Update 0.5ms ２フレーム目 Memoryや Rendering等の情報 BehaviourUpdate 1.8ms Player.Update 0.9ms Enemy.Update 0.4ms Bullet.Update 0.5ms Memoryや Rendering等の情報 1フレーム毎にSample名の文字列情報を含む全ての情報を含んでいるため、巨大なデータをEditorと実機の間でやり取りしていました

75.

2017.3以降では文字列を都度送りません Dictonary 0:BehaviourUpdate 1:Player.Update 2:Enemy.Update 3:Bullet.Update １フレーム目 Sampleの情報 Memoryや Rendering等の情報 2フレーム目 Sampleの情報 Memoryや Rendering等の情報 Sample名とID(int)がセットになった辞書を送っておき、以降は IDベースでやり取りします

76.

集計処理について BehaivourUpdate BeginSample 起動から 1000ms Player.Update BeginSample 起動から 1000ms Enemy.Update EndSample 起動から1001.5ms Player.Update EndSample 起動から1001ms Enemy.Update BeginSample 起動から 1001ms Bullet.Update Bullet.Update BeginSample EndSample 起動から1001.5ms 起動から1002ms BehaivourUpdate End 起動から1002ms Thread毎にBeginSample/EndSampleが発生したタイミングでキューにデータを溜めていきます

77.

集計処理について BehaivourUpdate 1000ms から開始して 2ms掛かった以降の3つを呼び出している Player.Update 1000msから開始して 1ms掛かった呼び出し先なし Enemy.Update 1001msから開始して 0.5ms掛かった呼び出し先なし Bullet.Update 1001.5msから開始して 0.5ms掛かった呼び出し先なし Profilerに表示するために先のイベントを集計してこのようなデータに変換する必要があります

78.

集計処理について BehaivourUpdate BeginSample 起動から 1000ms Player.Update BeginSample 起動から 1000ms Player.Update EndSample 起動から1001ms Enemy.Update BeginSample 起動から 1001ms Enemy.Update EndSample 起動から 1001.5ms Bullet.Update BeginSample 起動から 1001.5ms Bullet.Update EndSample 起動から1002ms BehaivourUpdate End 起動から1002ms この集計処理を Editor側で受け持つようにし、実機上では上のデータをそのまま転送するようにしました BehaivourUpdate 1000msから開始して 2ms掛かった以降3つを呼び出している Player.Update 1000msから開始して 1ms掛かった呼び出し先はない Enemy.Update 1001ms から開始して 0.5ms掛かった呼び出し先はない Bullet.Update 1001.5msから開始して0.5ms掛かった呼び出し先はない

79.

豆知識 2017.3以降では API ”Profiler.logFile”を利用して書き込んだデータと、Profiler Window上でSaveしたデータは一致しなくなりました。 ”Profiler.logFile”は集計前の形式のデータなのに対して、 Profiler Window上でSaveするデータは集計後のデータだからです。

80.

アップデート情報 • 実機上でのProfiler動作の高速化(2017.3+) • 実機上でのDeepProfiling (2017.3+) • User Threadへの対応(2017.3+) • Native Plugin Callbackへの対応(2018.2+) • IL2CPPでのScript Debugging(2018.2+) • 新しいMemory Profiler(2018.3+)

81.

実機上でのDeep Profiling これまでは実機上でのDeepProfilingは出来ませんでしたが、引数に「-deepprofiling」を渡して実行することで、実機上でも DeepProfilingが可能になりました ※.Net 4.x系で Mono限定

82.

Androidでの引数渡し Androidでは下記のようなadb コマンドを利用する事で引数を指定してアプリを実行できます adb shell am start -n [パッケージ名]/ [アクティビティ名] -e “unity -deepprofiling" 例：adb shell am start -n com.unity.test/com.unity3d.player.UnityPlayerActivity -e “unity -deepprofiling"

83.

アップデート情報 • 実機上でのProfiler動作の高速化(2017.3+) • 実機上でのDeepProfiling (2017.3+) • User Threadへの対応(2017.3+) • Native Plugin Callbackへの対応(2018.2+) • IL2CPPでのScript Debugging(2018.2+) • 新しいMemory Profiler(2018.3+)

84.

User Threadへの対応

85.

User Threadへの対応 Thread th = new Thread(ThreadExec); th.Start(); static void ThreadExec(){ CustomSampler sampler = CustomSampler.Create("Exec"); Profiler.BeginThreadProfiling("User","DoSomething"); while (flag){ sampler.Begin(); Exec(); // .. 何か処理する sampler.End(); } Profiler.EndThreadProfiling(); } ※2018.3から C#で作成したThreadは自動的に登録されるようになります

86.

アップデート情報 • 実機上でのProfiler動作の高速化(2017.3+) • 実機上でのDeepProfiling (2017.3+) • User Threadへの対応(2017.3+) • Native Plugin Callbackへの対応(2018.2+) • IL2CPPでのScript Debugging(2018.2+) • 新しいMemory Profiler(2018.3+)

87.

Native Plugin Callbackへの対応 2018.2から導入されました利用するには Editor/Data/PluginAPI/IUnityProfilerCallbacks.hをinclude します。 ※ヘッダーにサンプルコードもあります

88.

Native Plugin Callbackへの対応 BehaivourUpdate BeginSample 起動から 1000ms Player.Update BeginSample 起動から 1000ms Player.Update EndSample 起動から1001ms Enemy.Update BeginSample 起動から 1001ms Enemy.Update EndSample 起動から 1001.5ms Bullet.Update BeginSample 起動から 1001.5ms Bullet.Update EndSample 起動から1002ms BehaivourUpdate End 起動から1002ms これらのイベントが呼び出されたときにNative Pluginへコールバックさせるインターフェースが追加されました

89.

Native Plugin Callbackへの対応 NativePlugin内でProfilerのタイムライン相当のデータを構築することが出来ます

90.

Native Plugin側でデータを保存して、それを表示するツールを作れば独自の Profilerも作成出来ます

91.

Native Plugin Callbackの利用例 Unity Profilerから取得した情報を Profilerから取得した情報を Unity AndroidのSystraceに載せています AndroidのSystraceに載せています https://github.com/Over17/UnitySystracePlugin

https://github.com/Over17/UnitySystracePlugin

92.

Native Plugin Callbackの利用例 python [android-sdkパス]/platform-tools/systrace/systrace.py --time=5 -o \output.html -a com.unity.sample[アプリのBundleID］上記のようなコマンドで取得することが可能です https://github.com/Over17/UnitySystracePlugin

https://github.com/Over17/UnitySystracePlugin

93.

アップデート情報 • 実機上でのProfiler動作の高速化(2017.3+) • 実機上でのDeepProfiling (2017.3+) • User Threadへの対応(2017.3+) • Native Plugin CallBackへの対応(2018.2+) • IL2CPPでのScript Debugging(2018.2+) • 新しいMemory Profiler(2018.3+)

94.

IL2CPP でのScript Debugging IL2CPPでビルドしたアプリケーションに対しても、C#のコードレベルでデバッグが可能です

95.

IL2CPP でのScript Debugging • 2018.2から導入されました • PC/iOS/Android/Consoleゲーム機に入ってます (Xbox Oneは2018.3に入る予定です) • 「.Net 4.x Equivalement」にのみ対応しています ※Processにアタッチしてからbreakpointを認識するまでに10秒ほどのラグがあります。 1度認識してしまえば、その後のレスポンスは早いです

96.

アップデート情報 • 実機上でのProfiler動作の高速化(2017.3+) • 実機上でのDeepProfiling (2017.3+) • User Threadへの対応(2017.3+) • Native Plugin Callbackへの対応(2018.2+) • IL2CPPでのScript Debugging(2018.2+) • 新しいMemory Profiler(2018.3+)

97.

新しいMemoryProfiler • Memoryの計測ツールの現状 • Unity標準搭載 • UnityのBuilt-In Profiler • 拡張機能系 • Memory Profiler • Memory Profiler Extension • Memory Profiler Advanced( PerfAssist )

98.

Unity標準のMemoryProfiler リアルタイムでメモリのサマリー情報が確認出来る Simpleモード

99.

Unity標準のMemoryProfiler メモリのsnapshotをとって、その時点でのデータを詳細に閲覧できるDetailedモード

100.

[拡張系] Memory Profiler メモリのsnapshotをとって、その時点でのデータを見やすくした Editor拡張です https://bitbucket.org/Unity-Technologies/memoryprofiler にて配布