Tracy を用いたプロファイリング

Tracy は、パフォーマンス上のボトルネックを分析するために使用できるリアルタイムプロファイラです。これは、クライアントとプロファイラの2つの部分で構成されています。BN に統合されたクライアントは、プロファイリングデータをプロファイラに送信します。クライアントはオプトインであるため、プロファイリングを開始するには、tracy クライアントを含めて BN をビルドする必要があります。

Tracy Profiler のインストール

Caution

適切に機能するためには、ゲームとプロファイラの両方が同じバージョンの tracy でビルドされている必要があります。多数の問題のため、Windows バージョンは v0.10を使用していますが、Linux バージョンは 6d1deb5640ed11da01995fb1791115cfebe54dbfを使用しています。

Linux

$ git clone https://github.com/wolfpld/tracy
$ cd tracy
$ git checkout 6d1deb5640ed11da01995fb1791115cfebe54dbf # BN tracy クライアントが使用するコミット

https://github.com/wolfpld/tracy をクローンします。

# ubuntu の場合 (X11)
$ sudo apt install cmake clang git libcapstone-dev xorg-dev dbus libgtk-3-dev

# ubuntu の場合 (wayland)
$ sudo apt install libglfw-dev libgtk-3-dev libfreetype6-dev libtbb-dev debuginfod libwayland-dev dbus libxkbcommon-dev libglvnd-dev meson cmake git wayland-protocols

# arch の場合、https://github.com/wolfpld/tracy/blob/master/.github/workflows/linux.yml#L16C12-L16C163
$ pacman -Syu --noconfirm && pacman -S --noconfirm --needed freetype2 tbb debuginfod wayland dbus libxkbcommon libglvnd meson cmake git wayland-protocols

依存関係をインストールします。

$ cmake -B profiler/build -S profiler # wayland を使用している場合

cmake を設定します。tracy はデフォルトで wayland を使用します。X11 を使用したい場合は、LEGACY=1 フラグを追加する必要があります。

Note

X11 の場合

$ cmake -DLEGACY=ON -B profiler/build -S profiler # X11 を使用している場合

ctracy はデフォルトで wayland を使用します。X11 を使用したい場合は、LEGACY=1 フラグを追加する必要があります。

Note

fileselector の修正

$ cmake -DGTK_FILESELECTOR=ON -B profiler/build -S profiler

デフォルトのファイルセレクター (xdg-portal)の問題により、tracy はトレース履歴の開閉に失敗する場合があります。回避策として、GTK_FILESELECTOR=ON をコンパイルフラグに追加して gtk ファイルセレクターを使用します。

$ cmake --build profiler/build --config Release --parallel $(nproc)

バイナリをビルドします。ビルドされたバイナリは ./profiler/build/tracy-profilerで利用可能になります。

Tip

デスクトップエントリの追加

[Desktop Entry]
Version=1.0
Type=Application
Name=Tracy Profiler
GenericName=Code profiler
GenericName[pl]=Profiler kodu
GenericName[ko]=코드 프로파일러
Comment=Examine code to see where it is slow
Comment[pl]=Znajdowanie wolno wykonującego się kodu
Comment[ko]=코드 분석해서 느린 곳 찾기
Exec=<THE_PATH_WHERE_YOU_INSTALLED_TRACY>/profiler/build/tracy-profiler %f
Icon=<THE_PATH_WHERE_YOU_INSTALLED_TRACY>/icon/icon.ico
Terminal=false
Categories=Development;Profiling;
MimeType=application/tracy;
X-Desktop-File-Install-Version=0.26

アプリランチャーでプロファイラを利用可能にするには、上記の内容で $HOME/.local/share/applications/tracy.desktop ファイルを作成します。<THE_PATH_WHERE_YOU_INSTALLED_TRACY> を tracy をインストールしたパスに置き換えることを忘れないでください！

Windows

https://github.com/wolfpld/tracy/releasesから、プリコンパイルされた実行可能ファイルをダウンロードしてください。

Tracy クライアントを含めた BN のビルド

cmake を用いて -D USE_TRACY=ON フラグを付けてビルドします。例:

$ cmake -B build -DUSE_TRACY=ON ...other flags...

詳細については、CMake オプションを参照してください。

プロファイルするゾーンのマーク付け

プロファイルしたい関数に ZoneScoped をマークします。これは tracy GUI に表示されます。例:

bool game::do_turn()
{
    ZoneScoped;

    /** Other code... */
}

他にもより複雑なプロファイリングマクロが利用可能です。詳細については、以下のリンクを確認してください。

Tracy Profiler の使用

BN (USE_TRACY=ONでビルドしたもの)を起動し、tracy プロファイラを実行します。

connect ボタンをクリックしてゲームに接続します。

プロファイリングデータが GUI に表示されます。