godot/core/profiling/SCsub
2025-12-03 06:48:41 +11:00

88 lines
3.1 KiB
Python

#!/usr/bin/env python
from __future__ import annotations
from misc.utility.scons_hints import *
import pathlib
import profiling_builders
Import("env")
env.add_source_files(env.core_sources, "*.cpp")
def find_perfetto_path(path: pathlib.Path) -> pathlib.Path:
if not path.is_dir():
print("profiler_path must be empty or point to a directory.")
Exit(255)
if (path / "sdk" / "perfetto.cc").is_file():
# perfetto root directory.
return path / "sdk"
if (path / "perfetto.cc").is_file():
# perfetto sdk directory.
return path
print("Invalid profiler_path. Unable to find perfetto.cc.")
Exit(255)
def find_tracy_path(path: pathlib.Path) -> pathlib.Path:
if not path.is_dir():
print("profiler_path must point to a directory.")
Exit(255)
if (path / "public" / "TracyClient.cpp").is_file():
# tracy root directory
return path / "public"
if (path / "TracyClient.cpp").is_file():
# tracy public directory
return path
print("Invalid profiler_path. Unable to find TracyClient.cpp.")
Exit(255)
if env["profiler"]:
if env["profiler"] == "instruments":
# Nothing else to do for Instruments.
pass
elif env["profiler"] == "tracy":
if not env["profiler_path"]:
print("profiler_path must be set when using the tracy profiler. Aborting.")
Exit(255)
profiler_path = find_tracy_path(pathlib.Path(env["profiler_path"]))
env.Prepend(CPPPATH=[str(profiler_path.absolute())])
env_tracy = env.Clone()
env_tracy.Append(CPPDEFINES=["TRACY_ENABLE"])
if env["profiler_sample_callstack"]:
if env["platform"] not in ("windows", "linux", "android"):
# Reference the feature matrix in the tracy documentation.
print("Tracy does not support call stack sampling on this platform. Aborting.")
Exit(255)
# 62 is the maximum supported callstack depth reported by the tracy docs.
env_tracy.Append(CPPDEFINES=[("TRACY_CALLSTACK", 62)])
env_tracy.disable_warnings()
env_tracy.add_source_files(env.core_sources, str((profiler_path / "TracyClient.cpp").absolute()))
elif env["profiler"] == "perfetto":
if not env["profiler_path"]:
print("profiler_path must be set when using the perfetto profiler. Aborting.")
Exit(255)
profiler_path = find_perfetto_path(pathlib.Path(env["profiler_path"]))
env.Prepend(CPPPATH=[str(profiler_path.absolute())])
env_perfetto = env.Clone()
if env["profiler_sample_callstack"]:
print("Perfetto does not support call stack sampling. Aborting.")
Exit(255)
env_perfetto.disable_warnings()
env_perfetto.Prepend(CPPPATH=[str(profiler_path.absolute())])
env_perfetto.add_source_files(env.core_sources, str((profiler_path / "perfetto.cc").absolute()))
elif env["profiler_path"]:
print("profiler is required if profiler_path is set. Aborting.")
Exit(255)
env.CommandNoCache("profiling.gen.h", [env.Value(env["profiler"])], env.Run(profiling_builders.profiler_gen_builder))