diff --git a/CMakeLists.txt b/CMakeLists.txt index aaa5939e7d..5a0f2eff4f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -163,6 +163,7 @@ option(SKIP_QT_GUI "Skip building of Qt GUI" OFF) option(USE_PCH "Use precompiled headers" OFF) option(NJOBS "Number of parallel processes" OFF) option(ENABLE_VULKAN_DIAGNOSTICS "Enable Vulkan diagnostics" OFF) +option(ENABLE_TRACE "Enable Tracing" OFF) if (NJOBS) message(STATUS "Number of parallel processes: ${NJOBS}") @@ -219,6 +220,11 @@ if (ENABLE_VULKAN_DIAGNOSTICS) add_definitions(-DENABLE_VULKAN_DIAGNOSTICS) endif() +if (ENABLE_TRACE) + message(STATUS "Tracing is enabled") + add_definitions(-DENABLE_TRACE) +endif() + set(CMAKE_POSITION_INDEPENDENT_CODE ON) # Set environment variables diff --git a/android/app/build.gradle b/android/app/build.gradle index cfa42b20bc..53fd25ddeb 100644 --- a/android/app/build.gradle +++ b/android/app/build.gradle @@ -129,6 +129,11 @@ android { enableVulkanDiagnostics = project.getProperty('enableVulkanDiagnostics') } + def enableTrace = 'OFF' + if (project.hasProperty('enableTrace')) { + enableTrace = project.getProperty('enableTrace') + } + cmake { cppFlags '-fexceptions', '-frtti' // There is no sense to enable sections without gcc's --gc-sections flag. @@ -136,7 +141,8 @@ android { '-Wno-extern-c-compat' arguments '-DANDROID_TOOLCHAIN=clang', '-DANDROID_STL=c++_static', "-DOS=$osName", '-DSKIP_TESTS=ON', '-DSKIP_TOOLS=ON', "-DUSE_PCH=$pchFlag", - "-DNJOBS=$njobs", "-DENABLE_VULKAN_DIAGNOSTICS=$enableVulkanDiagnostics" + "-DNJOBS=$njobs", "-DENABLE_VULKAN_DIAGNOSTICS=$enableVulkanDiagnostics", + "-DENABLE_TRACE=$enableTrace" targets 'organicmaps' } } diff --git a/android/gradle.properties b/android/gradle.properties index 9b49d4d9c8..263ba01ce3 100644 --- a/android/gradle.properties +++ b/android/gradle.properties @@ -11,5 +11,7 @@ android.nonFinalResIds=false enableVulkanDiagnostics=OFF +enableTrace=OFF + # Autogenerated by tools/unix/generate_localizations.sh supportedLocalizations=af,ar,az,be,bg,ca,cs,da,de,el,en,en_GB,es,es_MX,et,eu,fa,fi,fr,fr_CA,iw,hi,hu,in,it,ja,ko,lt,lv,mr,mt,nb,nl,pl,pt,pt_BR,ro,ru,sk,sv,sw,th,tr,uk,vi,zh,zh_HK,zh_MO,zh_TW diff --git a/platform/CMakeLists.txt b/platform/CMakeLists.txt index 1f6482e547..feb0212e78 100644 --- a/platform/CMakeLists.txt +++ b/platform/CMakeLists.txt @@ -54,6 +54,7 @@ set(SRC settings.cpp settings.hpp socket.hpp + trace.hpp string_storage_base.cpp string_storage_base.hpp utm_mgrs_utils.cpp @@ -92,12 +93,14 @@ if (PLATFORM_IPHONE) platform_unix_impl.hpp secure_storage_ios.mm socket_apple.mm + trace_empty.cpp ) elseif(${PLATFORM_ANDROID}) append(SRC platform_android.cpp platform_unix_impl.cpp platform_unix_impl.hpp + trace_android.cpp ) else() # neither iPhone nor Android # Find bash first, on Windows it can be either in Git or in WSL @@ -125,6 +128,7 @@ else() # neither iPhone nor Android location_service.hpp network_policy_dummy.cpp platform_qt.cpp + trace_empty.cpp "${CMAKE_CURRENT_BINARY_DIR}/platform_qt_version.cpp" ) diff --git a/platform/platform.hpp b/platform/platform.hpp index 457e08d9e8..621e638cc5 100644 --- a/platform/platform.hpp +++ b/platform/platform.hpp @@ -4,6 +4,7 @@ #include "platform/country_defines.hpp" #include "platform/gui_thread.hpp" #include "platform/secure_storage.hpp" +#include "platform/trace.hpp" #include "coding/reader.hpp" @@ -118,6 +119,8 @@ protected: platform::BatteryLevelTracker m_batteryTracker; + platform::Trace m_trace; + public: Platform(); virtual ~Platform() = default; @@ -339,6 +342,8 @@ public: platform::BatteryLevelTracker & GetBatteryTracker() { return m_batteryTracker; } + platform::Trace & GetTrace() { return m_trace; } + private: void RunThreads(); void ShutdownThreads(); diff --git a/platform/trace.hpp b/platform/trace.hpp new file mode 100644 index 0000000000..216cbe7cac --- /dev/null +++ b/platform/trace.hpp @@ -0,0 +1,54 @@ +#pragma once + +#include "base/macros.hpp" + +#include +#include +#include + +namespace platform +{ +class TraceImpl; + +// API is inspired by https://developer.android.com/ndk/reference/group/tracing +class Trace +{ +public: + Trace() noexcept; + ~Trace() noexcept; + + void BeginSection(char const * name) noexcept; + void EndSection() noexcept; + void SetCounter(char const * name, int64_t value) noexcept; + +private: + std::unique_ptr m_impl; + + DISALLOW_COPY_AND_MOVE(Trace); +}; + +class TraceSection +{ +public: + inline TraceSection(Trace & trace, char const * section) noexcept + : m_trace(trace) + { + m_trace.BeginSection(section); + } + + inline ~TraceSection() noexcept { + m_trace.EndSection(); + } + +private: + Trace & m_trace; +}; +} // namespace platform + +#ifdef ENABLE_TRACE +#define TRACE_SECTION(section) platform::TraceSection ___section(GetPlatform().GetTrace(), section) +#define TRACE_COUNTER(name, value) GetPlatform().GetTrace().SetCounter(name, value) +#else +#define TRACE_SECTION(section) static_cast(0) +#define TRACE_COUNTER(name, value) static_cast(0) +#endif diff --git a/platform/trace_android.cpp b/platform/trace_android.cpp new file mode 100644 index 0000000000..5e4b53551c --- /dev/null +++ b/platform/trace_android.cpp @@ -0,0 +1,84 @@ +#include "platform/trace.hpp" + +#include +#include + +namespace platform +{ +// Source: https://developer.android.com/topic/performance/tracing/custom-events-native +typedef void *(*ATrace_beginSection) (char const *); +typedef void *(*ATrace_endSection) (void); +typedef void *(*ATrace_setCounter) (char const *, int64_t); + +class TraceImpl +{ +public: + TraceImpl() noexcept + { + m_lib = dlopen("libandroid.so", RTLD_NOW | RTLD_LOCAL); + + // Access the native tracing functions. + if (m_lib != nullptr) { + // Use dlsym() to prevent crashes on devices running Android 5.1 + // (API level 22) or lower. + m_beginSection = reinterpret_cast( + dlsym(m_lib, "ATrace_beginSection")); + m_endSection = reinterpret_cast( + dlsym(m_lib, "ATrace_endSection")); + m_setCounter = reinterpret_cast( + dlsym(m_lib, "ATrace_setCounter")); + } + } + + ~TraceImpl() noexcept + { + if (m_lib != nullptr) + dlclose(m_lib); + } + + void BeginSection(char const * name) noexcept + { + if (m_beginSection != nullptr) + m_beginSection(name); + } + + void EndSection() noexcept + { + if (m_endSection != nullptr) + m_endSection(); + } + + void SetCounter(char const * name, int64_t value) noexcept + { + if (m_setCounter != nullptr) + m_setCounter(name, value); + } + +private: + void * m_lib = nullptr; + ATrace_beginSection m_beginSection = nullptr; + ATrace_endSection m_endSection = nullptr; + ATrace_setCounter m_setCounter = nullptr; +}; + +Trace::Trace() noexcept + : m_impl(std::make_unique()) +{} + +Trace::~Trace() noexcept = default; + +void Trace::BeginSection(char const * name) noexcept +{ + m_impl->BeginSection(name); +} + +void Trace::EndSection() noexcept +{ + m_impl->EndSection(); +} + +void Trace::SetCounter(char const * name, int64_t value) noexcept +{ + m_impl->SetCounter(name, value); +} +} // namespace platform diff --git a/platform/trace_empty.cpp b/platform/trace_empty.cpp new file mode 100644 index 0000000000..1b6e88dca9 --- /dev/null +++ b/platform/trace_empty.cpp @@ -0,0 +1,16 @@ +#include "platform/trace.hpp" + +namespace platform +{ +class TraceImpl {}; + +Trace::Trace() noexcept = default; + +Trace::~Trace() noexcept = default; + +void Trace::BeginSection(char const * name) noexcept {} + +void Trace::EndSection() noexcept {} + +void Trace::SetCounter(char const * name, int64_t value) noexcept {} +} // namespace platform