Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

使用 C++ 效能分析器

要優化 Godot 的效能,首先要知道該優化什麼。這時,效能分析器就是非常有用的工具。

備註

編輯器里雖然自帶了一個 built-in GDScript profiler ,但在某些情況下,使用 C++ 效能分析器可能會更有協助。比如當 GDScript 分析器的準確度不夠,或者因為分析器自身的 Bug 而遺漏了部分資訊時,C++ 分析器就能派上用場啦。

分析器主要分為兩大類:取樣分析器和追蹤分析器。

取樣分析器(sampling profilers)會週期性地打斷正在執行的程式,並抓取一個“樣本(sample)”,記錄下此刻正在執行的是哪些函式。利用這些資訊,分析器就能估算出程式在哪些函式上花費的時間最多。

追蹤型分析器的工作原理是記錄應用特定的事件(比如某一影格的開始和結束),並生成一個被稱為“追蹤記錄("trace")”的記錄。分析器可以利用這個追蹤記錄,繪製出一張圖表,精准地呈現出高層級的時間線,讓你清楚地看到到底發生了甚麼。不過有一點需要注意:任何沒有被明確加入插樁(instrumented)的程式碼,都不會出現在追蹤分析器的時間線上!

Godot 既支援取樣分析器(sampling profilers),也支援追蹤分析器(tracing profilers),並且已經內建了用於追蹤分析器的常規 Godot 事件記錄記錄程式碼!

針對不同的問題,使用某一類分析器可能會比另一類更容易進行除錯。不過,想要給出一套明確的標準來告訴你具體該用哪個,其實是很困難的。所以不妨兩個都試試看,看看你能從中發現些甚麼!

取樣型效能分析器

我們推薦使用以下的取樣型效能分析器:

  • VerySleepy (僅適用於 Windows)

  • Hotspot(僅限 Linux)

  • Instruments (僅限蘋果 Apple 平台)

  • :ref:`Superluminal <doc_profiler_superluminal>`(Windows、Linux、Xbox 和 PlayStation;需要付費授權)

設定 Godot

若要取得有用的效能分析資訊,務必要 使用包含偵錯符號的 Godot 執行檔。官方釋出的二進位檔並未包含偵錯符號,因為這會大幅增加下載檔案的大小。

若想獲得最貼近生產環境(但又有除錯符號)的效能分析資料,建議用 production=yes debug_symbols=yes 的 SCons 選項編譯執行檔。

你也可以用較少優化的建構(比如 target=template_debug 且未啟用 LTO)來進行效能分析,但這樣得出的結果會和實際運作環境有些偏差。

警告

請勿 在編譯完成後使用 strip 指令移除偵錯符號,否則執行效能分析器時將無法取得有用的分析資訊。

測試啟動/關閉所需時間

如果你想專門最佳化 Godot 的啟動或關閉效能,可以在設定效能分析器時,給 Godot 的可執行程式加上 --quit 這個命令行選項。這會讓 Godot 在剛完成啟動後立刻自動退出。 --quit 選項可以配合 --editor (啟動編輯器)、 --project-manager (啟動專案管理器)以及 --path <path to project directory> (直接執行某個專案)一起使用。

也參考

更多 Godot 支援的命令列參數,請參閱 命令列教學 。

追蹤型效能分析器

Godot 目前支援三種追蹤型分析器(tracing profilers):

備註

Perfetto 是 Android 預設的追蹤系統,因此官方在 GitHub Releases 頁面 上提供了已經內建並啟用了 Perfetto 的預編譯匯出範本。

要想使用它們(指代上文提到的效能分析工具),你需要從原始碼自行編譯引擎。如果你以前從未做過這件事,請先閱讀針對你想要進行效能分析平台的 these docs 。你需要按照相同的步驟來操作,只是在執行 scons 命令時需要額外加上一些參數。

微型效能基準測試

微基準測試雖不嚴格屬於效能剖析範疇,但二者屬於相關概念:在確定了效能瓶頸後,您需要一種簡單且可隔離的測試方法,來驗證目前操作是否產生了實際影響。雖然重新進行效能剖析也是一種可行方案,但有時採用微基準測試會更為簡便。

您可以在下文各小節中查看範例基準測試設定。在 C++ 與 GDScript 之間,GDScript 基準測試通常是更合適的選擇。由於 GDScript 基準測試涉及 GDScript 語言及其執行時開銷,因此能更真實地反映大多數使用者實際體驗到的效能變化;而 C++ 基準測試功能更全面,能夠檢測到更細微的效能差異,但其正確設定難度也更高。在實際應用中,同時進行兩種基準測試往往更為穩妥。

備註

進行有效的基準測試可能並非易事。基準測試很容易誤導開發者——例如,它們可能未能真實反映實際應用場景,未能充分考慮編譯器最佳化及其他細微因素,或者採用不可靠的測量方式,導致記錄到的是噪聲而非實際的效能變化。在開始基準測試之前,請先查閱相關的基準測試指南和最佳實踐。一個不錯的起點是 Gregg 的 "Active Benchmarking",,該資源提供了關於基準測試的高層級概述及快速檢查清單。

GDScript 基準測試

要執行 GDScript 基準測試,請先建立一個包含以下內容的 benchmark.gd 檔案:

extends SceneTree

func _init():
    const N = 1_000_000

    var t0 := Time.get_ticks_usec()
    for i in N:
        pass  # Do the thing you want to benchmark here.
    var t1 := Time.get_ticks_usec()

    var ns_per_op := (t1 - t0) * 1000.0 / N
    print("Benchmark result: %.1f ns/op" % ns_per_op)
    quit()

編輯該檔案以新增您的基準測試。您可以使用 godot --headless -s benchmark.gd 來執行該基準測試。

備註

在撰寫本文時,GDScript 並不進行太多程式碼最佳化;例如,通常不會執行死程式碼消除操作。因此,用 GDScript 編寫一個具有代表性的基準測試比用 C++ 編寫要更容易。不過,這種情況在未來可能會發生變化。

C++ 基準測試

要執行 C++ 基準測試,請建立一個名為 tests/core/test_user_bench.cpp 的檔案,其內容如下:

#include "tests/test_macros.h"

TEST_FORCE_LINK(test_user_bench)

#include <chrono>
#include <cstdio>

static void user_bench() {
    const int N = 1'000'000;
    static uintptr_t sink = 0; // Defeats dead-code elimination.

    auto t0 = std::chrono::steady_clock::now();
    for (int i = 0; i < N; i++) {
        // Do the thing you want to benchmark here.
        // sink += (uintptr_t)something; // Update the sink from the result somehow.
    }
    auto t1 = std::chrono::steady_clock::now();

    double ns_per_op = std::chrono::duration<double, std::nano>(t1 - t0).count() / N;
    printf("Benchmark result: %.1f ns/op (sink %zu)\n", ns_per_op, (size_t)sink);
}

REGISTER_TEST_COMMAND("user-bench", &user_bench)

編輯該檔案以新增您的基準測試。使用 tests=yes 編譯 Godot,然後使用 godot --test user-bench 執行該基準測試。

備註

C++ 基準測試結果可能具有不確定性,若缺乏扎實的 C++ 及編譯器知識基礎,很容易導致誤判。在開始進行基準測試之前,請先查閱有關如何對 C++ 進行基準測試的指南與最佳實踐。您可以在 Bakhvalov 的 "Performance Analysis and Tuning on Modern CPUs" 和 Agner Fog 的 "Software Optimization Resources" 中找到免費的深度指南。