[Script] Instrumented scripting features for profiling purposes

Razakhel · Mar 21, 2024 · 3ffe42b · 3ffe42b
1 parent 719247a
commit 3ffe42b
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/src/RaZ/Script/LuaEnvironment.cpp b/src/RaZ/Script/LuaEnvironment.cpp
@@ -8,12 +8,16 @@
 #define SOL_PRINT_ERRORS 0
 #include "sol/sol.hpp"
 
+#include "tracy/Tracy.hpp"
+
 namespace Raz {
 
 LuaEnvironment::LuaEnvironment()
   : m_environment{ std::make_unique<sol::environment>(LuaWrapper::getState(), sol::create, LuaWrapper::getState().globals()) } {}
 
 bool LuaEnvironment::execute(const std::string& code) const {
+  ZoneScopedN("LuaEnvironment::execute");
+
   if (code.empty())
     return false;
 
@@ -32,6 +36,8 @@ bool LuaEnvironment::execute(const std::string& code) const {
 }
 
 bool LuaEnvironment::executeFromFile(const FilePath& filePath) const {
+  ZoneScopedN("LuaEnvironment::executeFromFile");
+
   if (filePath.isEmpty())
     return false;
 

diff --git a/src/RaZ/Script/LuaScript.cpp b/src/RaZ/Script/LuaScript.cpp
@@ -8,6 +8,8 @@
 #define SOL_SAFE_GETTER 0 // Allowing implicit conversion to bool
 #include "sol/sol.hpp"
 
+#include "tracy/Tracy.hpp"
+
 namespace Raz {
 
 LuaScript::LuaScript(const std::string& code) {
@@ -20,6 +22,8 @@ LuaScript::LuaScript(const std::string& code) {
 }
 
 void LuaScript::loadCode(const std::string& code) {
+  ZoneScopedN("LuaScript::loadCode");
+
   Logger::debug("[LuaScript] Loading code...");
 
   const sol::object owningEntity = m_environment.get("this");
@@ -41,18 +45,24 @@ void LuaScript::loadCode(const std::string& code) {
 }
 
 void LuaScript::loadCodeFromFile(const FilePath& filePath) {
+  ZoneScopedN("LuaScript::loadCodeFromFile");
+
   Logger::debug("[LuaScript] Loading code from file ('" + filePath + "')...");
   loadCode(FileUtils::readFileToString(filePath));
   Logger::debug("[LuaScript] Loaded code from file");
 }
 
 bool LuaScript::update(const FrameTimeInfo& timeInfo) const {
+  ZoneScopedN("LuaScript::update");
+
   const sol::unsafe_function updateFunc = m_environment.get("update");
   const sol::unsafe_function_result updateRes = updateFunc(timeInfo);
   return (updateRes.get_type() == sol::type::none || updateRes);
 }
 
 void LuaScript::setup() const {
+  ZoneScopedN("LuaScript::setup");
+
   if (!m_environment.exists("setup"))
     return;
 

diff --git a/src/RaZ/Script/LuaWrapper.cpp b/src/RaZ/Script/LuaWrapper.cpp
@@ -6,10 +6,14 @@
 #define SOL_PRINT_ERRORS 0
 #include "sol/sol.hpp"
 
+#include "tracy/Tracy.hpp"
+
 namespace Raz {
 
 void LuaWrapper::registerTypes() {
   [[maybe_unused]] static const bool _ = [] () {
+    ZoneScopedN("LuaWrapper::registerTypes");
+
     Logger::debug("[LuaWrapper] Registering types...");
 
     registerAnimationTypes();
@@ -50,6 +54,8 @@ void LuaWrapper::registerTypes() {
 }
 
 bool LuaWrapper::execute(const std::string& code) {
+  ZoneScopedN("LuaWrapper::execute");
+
   if (code.empty())
     return false;
 
@@ -68,6 +74,8 @@ bool LuaWrapper::execute(const std::string& code) {
 }
 
 bool LuaWrapper::executeFromFile(const FilePath& filePath) {
+  ZoneScopedN("LuaWrapper::executeFromFile");
+
   if (filePath.isEmpty())
     return false;
 

diff --git a/src/RaZ/Script/ScriptSystem.cpp b/src/RaZ/Script/ScriptSystem.cpp
@@ -1,13 +1,17 @@
 #include "RaZ/Script/LuaScript.hpp"
 #include "RaZ/Script/ScriptSystem.hpp"
 
+#include "tracy/Tracy.hpp"
+
 namespace Raz {
 
 ScriptSystem::ScriptSystem() {
   registerComponents<LuaScript>();
 }
 
 bool ScriptSystem::update(const FrameTimeInfo& timeInfo) {
+  ZoneScopedN("ScriptSystem::update");
+
   bool res = true;
 
   for (const Entity* entity : m_entities) {