diff --git a/lldb/include/lldb/Utility/Timer.h b/lldb/include/lldb/Utility/Timer.h --- a/lldb/include/lldb/Utility/Timer.h +++ b/lldb/include/lldb/Utility/Timer.h @@ -10,10 +10,16 @@ #define LLDB_UTILITY_TIMER_H #include "lldb/lldb-defines.h" +#include "llvm/ADT/ScopeExit.h" #include "llvm/Support/Chrono.h" +#include "llvm/Support/Signposts.h" #include #include +namespace llvm { + class SignpostEmitter; +} + namespace lldb_private { class Stream; @@ -72,15 +78,28 @@ const Timer &operator=(const Timer &) = delete; }; +llvm::SignpostEmitter &GetSignposts(); + } // namespace lldb_private // Use a format string because LLVM_PRETTY_FUNCTION might not be a string // literal. #define LLDB_SCOPED_TIMER() \ static ::lldb_private::Timer::Category _cat(LLVM_PRETTY_FUNCTION); \ - ::lldb_private::Timer _scoped_timer(_cat, "%s", LLVM_PRETTY_FUNCTION) -#define LLDB_SCOPED_TIMERF(...) \ + ::lldb_private::Timer _scoped_timer(_cat, "%s", LLVM_PRETTY_FUNCTION); \ + SIGNPOST_EMITTER_START_INTERVAL(::lldb_private::GetSignposts(), \ + &_scoped_timer, "%s", LLVM_PRETTY_FUNCTION); \ + auto _scoped_signpost = llvm::make_scope_exit([&_scoped_timer]() { \ + ::lldb_private::GetSignposts().endInterval(&_scoped_timer); \ + }) + +#define LLDB_SCOPED_TIMERF(FMT, ...) \ static ::lldb_private::Timer::Category _cat(LLVM_PRETTY_FUNCTION); \ - ::lldb_private::Timer _scoped_timer(_cat, __VA_ARGS__) + ::lldb_private::Timer _scoped_timer(_cat, FMT, __VA_ARGS__); \ + SIGNPOST_EMITTER_START_INTERVAL(::lldb_private::GetSignposts(), \ + &_scoped_timer, FMT, __VA_ARGS__); \ + auto _scoped_signpost = llvm::make_scope_exit([&_scoped_timer]() { \ + ::lldb_private::GetSignposts().endInterval(&_scoped_timer); \ + }) #endif // LLDB_UTILITY_TIMER_H diff --git a/lldb/source/Utility/Timer.cpp b/lldb/source/Utility/Timer.cpp --- a/lldb/source/Utility/Timer.cpp +++ b/lldb/source/Utility/Timer.cpp @@ -33,6 +33,8 @@ /// Allows llvm::Timer to emit signposts when supported. static llvm::ManagedStatic Signposts; +llvm::SignpostEmitter &lldb_private::GetSignposts() { return *Signposts; } + std::atomic Timer::g_quiet(true); std::atomic Timer::g_display_depth(0); static std::mutex &GetFileMutex() { @@ -59,7 +61,6 @@ Timer::Timer(Timer::Category &category, const char *format, ...) : m_category(category), m_total_start(std::chrono::steady_clock::now()) { - Signposts->startInterval(this, m_category.GetName()); TimerStack &stack = GetTimerStackForCurrentThread(); stack.push_back(this); @@ -86,8 +87,6 @@ auto total_dur = stop_time - m_total_start; auto timer_dur = total_dur - m_child_duration; - Signposts->endInterval(this, m_category.GetName()); - TimerStack &stack = GetTimerStackForCurrentThread(); if (g_quiet && stack.size() <= g_display_depth) { std::lock_guard lock(GetFileMutex()); diff --git a/llvm/include/llvm/Support/Signposts.h b/llvm/include/llvm/Support/Signposts.h --- a/llvm/include/llvm/Support/Signposts.h +++ b/llvm/include/llvm/Support/Signposts.h @@ -18,8 +18,17 @@ #define LLVM_SUPPORT_SIGNPOSTS_H #include "llvm/ADT/StringRef.h" +#include "llvm/Config/config.h" #include +#if LLVM_SUPPORT_XCODE_SIGNPOSTS +#include +#include +#endif + +#define SIGNPOSTS_AVAILABLE() \ + __builtin_available(macos 10.14, iOS 12, tvOS 12, watchOS 5, *) + namespace llvm { class SignpostEmitterImpl; @@ -36,8 +45,27 @@ /// Begin a signposted interval for a given object. void startInterval(const void *O, StringRef Name); + +#if LLVM_SUPPORT_XCODE_SIGNPOSTS + os_log_t &getLogger() const; + os_signpost_id_t getSignpostForObject(const void *O); +#endif + + /// A macro to take advantage of the special format string handling + /// in the os_signpost API. The format string substitution is + /// deferred to the log consumer and done outside of the + /// application. +#define SIGNPOST_EMITTER_START_INTERVAL(SIGNPOST_EMITTER, O, ...) \ + do { \ + if ((SIGNPOST_EMITTER).isEnabled()) \ + if (SIGNPOSTS_AVAILABLE()) \ + os_signpost_interval_begin((SIGNPOST_EMITTER).getLogger(), \ + (SIGNPOST_EMITTER).getSignpostForObject(O), \ + "LLVM Timers", __VA_ARGS__); \ + } while (0) + /// End a signposted interval for a given object. - void endInterval(const void *O, StringRef Name); + void endInterval(const void *O); }; } // end namespace llvm diff --git a/llvm/lib/Support/Signposts.cpp b/llvm/lib/Support/Signposts.cpp --- a/llvm/lib/Support/Signposts.cpp +++ b/llvm/lib/Support/Signposts.cpp @@ -10,19 +10,14 @@ #include "llvm/Support/Signposts.h" #include "llvm/Support/Timer.h" -#include "llvm/Config/config.h" #if LLVM_SUPPORT_XCODE_SIGNPOSTS #include "llvm/ADT/DenseMap.h" #include "llvm/Support/Mutex.h" -#include -#include #endif // if LLVM_SUPPORT_XCODE_SIGNPOSTS using namespace llvm; #if LLVM_SUPPORT_XCODE_SIGNPOSTS -#define SIGNPOSTS_AVAILABLE() \ - __builtin_available(macos 10.14, iOS 12, tvOS 12, watchOS 5, *) namespace { os_log_t *LogCreator() { os_log_t *X = new os_log_t; @@ -40,13 +35,13 @@ namespace llvm { class SignpostEmitterImpl { using LogPtrTy = std::unique_ptr; - using LogTy = LogPtrTy::element_type; LogPtrTy SignpostLog; DenseMap Signposts; sys::SmartMutex Mutex; - LogTy &getLogger() const { return *SignpostLog; } +public: + os_log_t &getLogger() const { return *SignpostLog; } os_signpost_id_t getSignpostForObject(const void *O) { sys::SmartScopedLock Lock(Mutex); const auto &I = Signposts.find(O); @@ -60,7 +55,6 @@ return Inserted.first->second; } -public: SignpostEmitterImpl() : SignpostLog(LogCreator()) {} bool isEnabled() const { @@ -79,7 +73,7 @@ } } - void endInterval(const void *O, llvm::StringRef Name) { + void endInterval(const void *O) { if (isEnabled()) { if (SIGNPOSTS_AVAILABLE()) { // Both strings used here are required to be constant literal strings. @@ -125,10 +119,17 @@ #endif // if !HAVE_ANY_SIGNPOST_IMPL } -void SignpostEmitter::endInterval(const void *O, StringRef Name) { +#if HAVE_ANY_SIGNPOST_IMPL +os_log_t &SignpostEmitter::getLogger() const { return Impl->getLogger(); } +os_signpost_id_t SignpostEmitter::getSignpostForObject(const void *O) { + return Impl->getSignpostForObject(O); +} +#endif + +void SignpostEmitter::endInterval(const void *O) { #if HAVE_ANY_SIGNPOST_IMPL if (Impl == nullptr) return; - Impl->endInterval(O, Name); + Impl->endInterval(O); #endif // if !HAVE_ANY_SIGNPOST_IMPL } diff --git a/llvm/lib/Support/Timer.cpp b/llvm/lib/Support/Timer.cpp --- a/llvm/lib/Support/Timer.cpp +++ b/llvm/lib/Support/Timer.cpp @@ -174,7 +174,7 @@ Running = false; Time += TimeRecord::getCurrentTime(false); Time -= StartTime; - Signposts->endInterval(this, getName()); + Signposts->endInterval(this); } void Timer::clear() {