seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add profiler option to SCons builds.

Browse Source 
Add `tracy` option to `profiler`. If set, a tracy profiling client will be injected into the Godot binary.

# Conflicts:
#	platform/linuxbsd/godot_linuxbsd.cpp
This commit is contained in:
Lukas Tenbrink
2025-04-01 19:00:42 +02:00
parent 6fd949a6dc
commit e80194e31f
14 changed files with 266 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
core/profiling/SCsub Normal file
View File

@ -0,0 +1,69 @@
#!/usr/bin/env python
from misc.utility.scons_hints import *
import pathlib
from typing import Tuple
import profiling_builders
Import("env")
env.add_source_files(env.core_sources, "*.cpp")
def get_profiler_and_path_from_path(path: pathlib.Path) -> Tuple[str, 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 "perfetto", path / "sdk"
if (path / "perfetto.cc").is_file():
# perfetto sdk directory.
return "perfetto", path
if (path / "public" / "TracyClient.cpp").is_file():
# tracy root directory
return "tracy", path / "public"
if (path / "TracyClient.cpp").is_file():
# tracy public directory
return "tracy", path
print("Unrecognized profiler_path option. Please set a path to either tracy or perfetto.")
Exit(255)
env["profiler"] = None
if env["profiler_path"]:
profiler_name, profiler_path = get_profiler_and_path_from_path(pathlib.Path(env["profiler_path"]))
env["profiler"] = profiler_name
if profiler_name == "tracy":
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 profiler_name == "perfetto":
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()))
env.CommandNoCache("profiling.gen.h", [env.Value(env["profiler"])], env.Run(profiling_builders.profiler_gen_builder))

45
core/profiling/profiling.cpp Normal file
View File

@ -0,0 +1,45 @@
/**************************************************************************/
/* profiling.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#include "profiling.h"
#ifdef GODOT_USE_PERFETTO
PERFETTO_TRACK_EVENT_STATIC_STORAGE();
void godot_init_profiler() {
perfetto::TracingInitArgs args;
args.backends |= perfetto::kSystemBackend;
perfetto::Tracing::Initialize(args);
perfetto::TrackEvent::Register();
}
#endif

106
core/profiling/profiling.h Normal file
View File

@ -0,0 +1,106 @@
/**************************************************************************/
/* profiling.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#pragma once
#include "core/typedefs.h"
#include "profiling.gen.h"
#if defined(GODOT_USE_TRACY)
// Use the tracy profiler.
#define TRACY_ENABLE
#include <tracy/Tracy.hpp>
#ifndef TRACY_CALLSTACK
#define TRACY_CALLSTACK 0
#endif
// Define tracing macros.
#define GodotProfileFrameMark FrameMark
#define GodotProfileZone(m_zone_name) ZoneScopedN(m_zone_name)
#define GodotProfileZoneGroupedFirst(m_group_name, m_zone_name) ZoneNamedN(__godot_tracy_zone_##m_group_name, m_zone_name, true)
#define GodotProfileZoneGroupedEndEarly(m_group_name, m_zone_name) __godot_tracy_zone_##m_group_name.~ScopedZone();
#define GodotProfileZoneGrouped(m_group_name, m_zone_name) \
GodotProfileZoneGroupedEndEarly(m_group_name, m_zone_name); \
static constexpr tracy::SourceLocationData TracyConcat(__tracy_source_location, TracyLine){ m_zone_name, TracyFunction, TracyFile, (uint32_t)TracyLine, 0 }; \
new (&__godot_tracy_zone_##m_group_name) tracy::ScopedZone(&TracyConcat(__tracy_source_location, TracyLine), TRACY_CALLSTACK, true)
static void godot_init_profiler() {
// Send our first event to tracy; otherwise it doesn't start collecting data.
// FrameMark is kind of fitting because it communicates "this is where we started tracing".
FrameMark;
}
#elif defined(GODOT_USE_PERFETTO)
// Use the perfetto profiler.
#include <perfetto.h>
PERFETTO_DEFINE_CATEGORIES(
perfetto::Category("godot")
.SetDescription("All Godot Events"), );
// See PERFETTO_INTERNAL_SCOPED_EVENT_FINALIZER
struct PerfettoGroupedEventEnder {
_FORCE_INLINE_ void _end_now() {
TRACE_EVENT_END("godot");
}
_FORCE_INLINE_ ~PerfettoGroupedEventEnder() {
_end_now();
}
};
#define GodotProfileFrameMark // TODO
#define GodotProfileZone(m_zone_name) TRACE_EVENT("godot", m_zone_name);
#define GodotProfileZoneGroupedFirst(m_group_name, m_zone_name) \
TRACE_EVENT_BEGIN("godot", m_zone_name); \
PerfettoGroupedEventEnder __godot_perfetto_zone_##m_group_name
#define GodotProfileZoneGroupedEndEarly(m_group_name, m_zone_name) __godot_perfetto_zone_##m_group_name.~PerfettoGroupedEventEnder()
#define GodotProfileZoneGrouped(m_group_name, m_zone_name) \
__godot_perfetto_zone_##m_group_name._end_now(); \
TRACE_EVENT_BEGIN("godot", m_zone_name);
void godot_init_profiler();
#else
// No profiling; all macros are stubs.
static void godot_init_profiler() {
}
#define GodotProfileFrameMark
#define GodotProfileZone(m_zone_name)
#define GodotProfileZoneGroupedFirst(m_group_name, m_zone_name)
#define GodotProfileZoneGroupedEndEarly(m_group_name, m_zone_name)
#define GodotProfileZoneGrouped(m_group_name, m_zone_name)
#endif

13
core/profiling/profiling_builders.py Normal file
View File

@ -0,0 +1,13 @@
"""Functions used to generate source files during build time"""
import methods
def profiler_gen_builder(target, source, env):
with methods.generated_wrapper(str(target[0])) as file:
if env["profiler"] == "tracy":
file.write("#define GODOT_USE_TRACY\n")
if env["profiler_sample_callstack"]:
file.write("#define TRACY_CALLSTACK 62\n")
if env["profiler"] == "perfetto":
file.write("#define GODOT_USE_PERFETTO\n")