https://github.com/ivanaivanovska updated
https://github.com/llvm/llvm-project/pull/103039
>From 1294a50b0da22e2904d3e43942a6be702c93d133 Mon Sep 17 00:00:00 2001
From: Ivana Ivanovska <iivanov...@google.com>
Date: Tue, 13 Aug 2024 10:30:34 +0000
Subject: [PATCH 1/2] Added instant events and marking defered templated
instantiation.
---
clang/lib/Sema/SemaExpr.cpp | 18 ++++++
.../lib/Sema/SemaTemplateInstantiateDecl.cpp | 17 +++++
clang/unittests/Support/TimeProfilerTest.cpp | 51 ++++++++++++++-
llvm/include/llvm/Support/TimeProfiler.h | 19 +++++-
llvm/lib/Support/TimeProfiler.cpp | 64 +++++++++++++------
5 files changed, 145 insertions(+), 24 deletions(-)
diff --git a/clang/lib/Sema/SemaExpr.cpp b/clang/lib/Sema/SemaExpr.cpp
index 74c0e017059055..adc021c8cd237b 100644
--- a/clang/lib/Sema/SemaExpr.cpp
+++ b/clang/lib/Sema/SemaExpr.cpp
@@ -18,6 +18,7 @@
#include "clang/AST/ASTLambda.h"
#include "clang/AST/ASTMutationListener.h"
#include "clang/AST/CXXInheritance.h"
+#include "clang/AST/Decl.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/DeclTemplate.h"
#include "clang/AST/EvaluatedExprVisitor.h"
@@ -63,6 +64,7 @@
#include "llvm/Support/Casting.h"
#include "llvm/Support/ConvertUTF.h"
#include "llvm/Support/SaveAndRestore.h"
+#include "llvm/Support/TimeProfiler.h"
#include "llvm/Support/TypeSize.h"
#include <optional>
@@ -18013,6 +18015,22 @@ void Sema::MarkFunctionReferenced(SourceLocation Loc,
FunctionDecl *Func,
std::make_pair(Func, PointOfInstantiation));
// Notify the consumer that a function was implicitly instantiated.
Consumer.HandleCXXImplicitFunctionInstantiation(Func);
+
+ llvm::TimeTraceScope TimeScope(
+ "DeferInstantiation",
+ [&]() {
+ llvm::TimeTraceMetadata M;
+ llvm::raw_string_ostream OS(M.Detail);
+ Func->getNameForDiagnostic(OS, getPrintingPolicy(),
+ /*Qualified=*/true);
+ if (llvm::isTimeTraceVerbose()) {
+ auto Loc = SourceMgr.getExpansionLoc(Func->getLocation());
+ M.File = SourceMgr.getFilename(Loc);
+ M.Line = SourceMgr.getExpansionLineNumber(Loc);
+ }
+ return M;
+ },
+ llvm::TimeTraceEventType::InstantEvent);
}
}
} else {
diff --git a/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
b/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
index f93cd113988ae4..d6d580d399457d 100644
--- a/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
+++ b/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
@@ -4941,6 +4941,23 @@ void Sema::InstantiateFunctionDefinition(SourceLocation
PointOfInstantiation,
Function->setInstantiationIsPending(true);
PendingInstantiations.push_back(
std::make_pair(Function, PointOfInstantiation));
+
+ llvm::TimeTraceScope TimeScope(
+ "DeferInstantiation",
+ [&]() {
+ llvm::TimeTraceMetadata M;
+ llvm::raw_string_ostream OS(M.Detail);
+ Function->getNameForDiagnostic(OS, getPrintingPolicy(),
+ /*Qualified=*/true);
+ if (llvm::isTimeTraceVerbose()) {
+ auto Loc = SourceMgr.getExpansionLoc(Function->getLocation());
+ M.File = SourceMgr.getFilename(Loc);
+ M.Line = SourceMgr.getExpansionLineNumber(Loc);
+ }
+ return M;
+ },
+ llvm::TimeTraceEventType::InstantEvent);
+
} else if (TSK == TSK_ImplicitInstantiation) {
if (AtEndOfTU && !getDiagnostics().hasErrorOccurred() &&
!getSourceManager().isInSystemHeader(PatternDecl->getBeginLoc())) {
diff --git a/clang/unittests/Support/TimeProfilerTest.cpp
b/clang/unittests/Support/TimeProfilerTest.cpp
index f53fe71d630bf5..ccda12e943dd73 100644
--- a/clang/unittests/Support/TimeProfilerTest.cpp
+++ b/clang/unittests/Support/TimeProfilerTest.cpp
@@ -238,13 +238,55 @@ Frontend (test.cc)
buildTraceGraph(Json));
}
+TEST(TimeProfilerTest, ClassTemplateInstantiations) {
+ std::string Code = R"(
+ template<class T>
+ struct S
+ {
+ void foo() {}
+ void bar();
+ };
+
+ template struct S<double>; // explicit instantiation of S<double>
+
+ void user() {
+ S<int> a; // implicit instantiation of S<int>
+ S<float>* b;
+ b->foo(); // implicit instatiation of S<float> and S<float>::foo()
+ }
+ )";
+
+ setupProfiler();
+ ASSERT_TRUE(compileFromString(Code, "-std=c++20", "test.cc"));
+ std::string Json = teardownProfiler();
+ ASSERT_EQ(R"(
+Frontend (test.cc)
+| ParseClass (S)
+| InstantiateClass (S<double>, test.cc:9)
+| InstantiateFunction (S<double>::foo, test.cc:5)
+| ParseDeclarationOrFunctionDefinition (test.cc:11:5)
+| | ParseFunctionDefinition (user)
+| | | InstantiateClass (S<int>, test.cc:3)
+| | | InstantiateClass (S<float>, test.cc:3)
+| | | DeferInstantiation (S<float>::foo, test.cc:5)
+| PerformPendingInstantiations
+| | InstantiateFunction (S<float>::foo, test.cc:5)
+)",
+ buildTraceGraph(Json));
+}
+
TEST(TimeProfilerTest, TemplateInstantiations) {
std::string B_H = R"(
template <typename T>
- T fooB(T t) {
+ T fooC(T t) {
return T();
}
+ template <typename T>
+ constexpr T fooB(T t) {
+ return fooC(t);
+ }
+
#define MacroTemp(x) template <typename T> void foo##x(T) { T(); }
)";
@@ -267,14 +309,19 @@ TEST(TimeProfilerTest, TemplateInstantiations) {
std::string Json = teardownProfiler();
ASSERT_EQ(R"(
Frontend (test.cc)
+| ParseFunctionDefinition (fooC)
| ParseFunctionDefinition (fooB)
| ParseFunctionDefinition (fooMTA)
| ParseFunctionDefinition (fooA)
| ParseDeclarationOrFunctionDefinition (test.cc:3:5)
| | ParseFunctionDefinition (user)
+| | | DeferInstantiation (fooA<int>, a.h:7)
| PerformPendingInstantiations
| | InstantiateFunction (fooA<int>, a.h:7)
-| | | InstantiateFunction (fooB<int>, b.h:3)
+| | | InstantiateFunction (fooB<int>, b.h:8)
+| | | | DeferInstantiation (fooC<int>, b.h:3)
+| | | DeferInstantiation (fooMTA<int>, a.h:4)
+| | | InstantiateFunction (fooC<int>, b.h:3)
| | | InstantiateFunction (fooMTA<int>, a.h:4)
)",
buildTraceGraph(Json));
diff --git a/llvm/include/llvm/Support/TimeProfiler.h
b/llvm/include/llvm/Support/TimeProfiler.h
index 9e2ba31991f542..f4952b18e4f6ef 100644
--- a/llvm/include/llvm/Support/TimeProfiler.h
+++ b/llvm/include/llvm/Support/TimeProfiler.h
@@ -83,6 +83,8 @@ namespace llvm {
class raw_pwrite_stream;
+enum class TimeTraceEventType { CompleteEvent, InstantEvent, AsyncEvent };
+
struct TimeTraceMetadata {
std::string Detail;
// Source file and line number information for the event.
@@ -152,6 +154,10 @@ timeTraceProfilerBegin(StringRef Name,
TimeTraceProfilerEntry *timeTraceAsyncProfilerBegin(StringRef Name,
StringRef Detail);
+// Mark an instant event.
+TimeTraceProfilerEntry *timeTraceInstantEventProfilerBegin(StringRef Name,
+ llvm::function_ref<TimeTraceMetadata()> Metadata);
+
/// Manually end the last time section.
void timeTraceProfilerEnd();
void timeTraceProfilerEnd(TimeTraceProfilerEntry *E);
@@ -181,9 +187,18 @@ class TimeTraceScope {
Entry = timeTraceProfilerBegin(Name, Detail);
}
TimeTraceScope(StringRef Name,
- llvm::function_ref<TimeTraceMetadata()> Metadata) {
- if (getTimeTraceProfilerInstance() != nullptr)
+ llvm::function_ref<TimeTraceMetadata()> Metadata,
TimeTraceEventType Et = TimeTraceEventType::CompleteEvent) {
+ if (getTimeTraceProfilerInstance() == nullptr)
+ return;
+ assert((Et == TimeTraceEventType::InstantEvent ||
+ Et == TimeTraceEventType::CompleteEvent) &&
+ "Event Type not supported.");
+
+ if (Et == TimeTraceEventType::CompleteEvent) {
Entry = timeTraceProfilerBegin(Name, Metadata);
+ } else {
+ Entry = timeTraceInstantEventProfilerBegin(Name, Metadata);
+ }
}
~TimeTraceScope() {
if (getTimeTraceProfilerInstance() != nullptr)
diff --git a/llvm/lib/Support/TimeProfiler.cpp
b/llvm/lib/Support/TimeProfiler.cpp
index c2014028ddadca..738f5f5842bb0d 100644
--- a/llvm/lib/Support/TimeProfiler.cpp
+++ b/llvm/lib/Support/TimeProfiler.cpp
@@ -13,6 +13,7 @@
#include "llvm/Support/TimeProfiler.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/STLFunctionalExtras.h"
+#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/Support/JSON.h"
#include "llvm/Support/Path.h"
@@ -70,23 +71,23 @@ using NameAndCountAndDurationType =
/// Represents an open or completed time section entry to be captured.
struct llvm::TimeTraceProfilerEntry {
- const TimePointType Start;
+ TimePointType Start;
TimePointType End;
- const std::string Name;
+ std::string Name;
TimeTraceMetadata Metadata;
+ TimeTraceEventType EventType;
- const bool AsyncEvent = false;
TimeTraceProfilerEntry(TimePointType &&S, TimePointType &&E, std::string &&N,
- std::string &&Dt, bool Ae)
+ std::string &&Dt, TimeTraceEventType Et)
: Start(std::move(S)), End(std::move(E)), Name(std::move(N)), Metadata(),
- AsyncEvent(Ae) {
+ EventType(Et) {
Metadata.Detail = std::move(Dt);
}
TimeTraceProfilerEntry(TimePointType &&S, TimePointType &&E, std::string &&N,
- TimeTraceMetadata &&Mt, bool Ae)
+ TimeTraceMetadata &&Mt, TimeTraceEventType Et)
: Start(std::move(S)), End(std::move(E)), Name(std::move(N)),
- Metadata(std::move(Mt)), AsyncEvent(Ae) {}
+ Metadata(std::move(Mt)), EventType(Et) {}
// Calculate timings for FlameGraph. Cast time points to microsecond
precision
// rather than casting duration. This avoids truncation issues causing inner
@@ -116,19 +117,19 @@ struct llvm::TimeTraceProfiler {
TimeTraceProfilerEntry *begin(std::string Name,
llvm::function_ref<std::string()> Detail,
- bool AsyncEvent = false) {
+ TimeTraceEventType Et =
TimeTraceEventType::CompleteEvent) {
Stack.emplace_back(std::make_unique<TimeTraceProfilerEntry>(
ClockType::now(), TimePointType(), std::move(Name), Detail(),
- AsyncEvent));
+ Et));
return Stack.back().get();
}
TimeTraceProfilerEntry *
begin(std::string Name, llvm::function_ref<TimeTraceMetadata()> Metadata,
- bool AsyncEvent = false) {
+ TimeTraceEventType Et = TimeTraceEventType::CompleteEvent) {
Stack.emplace_back(std::make_unique<TimeTraceProfilerEntry>(
ClockType::now(), TimePointType(), std::move(Name), Metadata(),
- AsyncEvent));
+ Et));
return Stack.back().get();
}
@@ -144,9 +145,22 @@ struct llvm::TimeTraceProfiler {
// Calculate duration at full precision for overall counts.
DurationType Duration = E.End - E.Start;
- // Only include sections longer or equal to TimeTraceGranularity msec.
- if (duration_cast<microseconds>(Duration).count() >= TimeTraceGranularity)
+ // Only include Instant Events or events with a duration longer or equal to
+ // TimeTraceGranularity msec.
+ if (E.EventType == TimeTraceEventType::InstantEvent ||
+ duration_cast<microseconds>(Duration).count() >= TimeTraceGranularity)
{
Entries.emplace_back(E);
+ } else {
+ // if the event is not included, exclude also all instant events that
+ // happened during this event.
+ for (SmallVector<TimeTraceProfilerEntry, 128>::iterator it =
Entries.begin(); it != Entries.end();) {
+ if (TimeTraceEventType::InstantEvent == it->EventType &&
+ it->Start > E.Start && it->Start < E.End)
+ it = Entries.erase(it);
+ else
+ ++it;
+ }
+ }
// Track total time taken by each "name", but only the topmost levels of
// them; e.g. if there's a template instantiation that instantiates other
@@ -194,13 +208,15 @@ struct llvm::TimeTraceProfiler {
J.attribute("pid", Pid);
J.attribute("tid", int64_t(Tid));
J.attribute("ts", StartUs);
- if (E.AsyncEvent) {
+ if (E.EventType == TimeTraceEventType::AsyncEvent) {
J.attribute("cat", E.Name);
J.attribute("ph", "b");
J.attribute("id", 0);
- } else {
+ } else if (E.EventType == TimeTraceEventType::CompleteEvent) {
J.attribute("ph", "X");
J.attribute("dur", DurUs);
+ } else { // instant event
+ J.attribute("ph", "i");
}
J.attribute("name", E.Name);
if (!E.Metadata.isEmpty()) {
@@ -215,7 +231,7 @@ struct llvm::TimeTraceProfiler {
}
});
- if (E.AsyncEvent) {
+ if (E.EventType == TimeTraceEventType::AsyncEvent) {
J.object([&] {
J.attribute("pid", Pid);
J.attribute("tid", int64_t(Tid));
@@ -406,7 +422,7 @@ TimeTraceProfilerEntry
*llvm::timeTraceProfilerBegin(StringRef Name,
StringRef Detail) {
if (TimeTraceProfilerInstance != nullptr)
return TimeTraceProfilerInstance->begin(
- std::string(Name), [&]() { return std::string(Detail); }, false);
+ std::string(Name), [&]() { return std::string(Detail); },
TimeTraceEventType::CompleteEvent);
return nullptr;
}
@@ -414,7 +430,7 @@ TimeTraceProfilerEntry *
llvm::timeTraceProfilerBegin(StringRef Name,
llvm::function_ref<std::string()> Detail) {
if (TimeTraceProfilerInstance != nullptr)
- return TimeTraceProfilerInstance->begin(std::string(Name), Detail, false);
+ return TimeTraceProfilerInstance->begin(std::string(Name), Detail,
TimeTraceEventType::CompleteEvent);
return nullptr;
}
@@ -422,7 +438,15 @@ TimeTraceProfilerEntry *
llvm::timeTraceProfilerBegin(StringRef Name,
llvm::function_ref<TimeTraceMetadata()> Metadata)
{
if (TimeTraceProfilerInstance != nullptr)
- return TimeTraceProfilerInstance->begin(std::string(Name), Metadata,
false);
+ return TimeTraceProfilerInstance->begin(std::string(Name), Metadata,
TimeTraceEventType::CompleteEvent);
+ return nullptr;
+}
+
+TimeTraceProfilerEntry *
+llvm::timeTraceInstantEventProfilerBegin(StringRef Name,
+ llvm::function_ref<TimeTraceMetadata()> Metadata)
{
+ if (TimeTraceProfilerInstance != nullptr)
+ return TimeTraceProfilerInstance->begin(std::string(Name), Metadata,
TimeTraceEventType::InstantEvent);
return nullptr;
}
@@ -430,7 +454,7 @@ TimeTraceProfilerEntry
*llvm::timeTraceAsyncProfilerBegin(StringRef Name,
StringRef Detail) {
if (TimeTraceProfilerInstance != nullptr)
return TimeTraceProfilerInstance->begin(
- std::string(Name), [&]() { return std::string(Detail); }, true);
+ std::string(Name), [&]() { return std::string(Detail); },
TimeTraceEventType::AsyncEvent);
return nullptr;
}
>From 25413e83737d929a1f6001a9e0177b8c0a0f531b Mon Sep 17 00:00:00 2001
From: Ivana Ivanovska <iivanov...@google.com>
Date: Wed, 28 Aug 2024 09:57:49 +0000
Subject: [PATCH 2/2] Refactored TimeTraceProfilerEntry to allow easier
extensibility. Implemented inserting Instant Events with a single function.
---
clang/lib/Sema/Sema.cpp | 8 +-
clang/lib/Sema/SemaExpr.cpp | 27 +-
.../lib/Sema/SemaTemplateInstantiateDecl.cpp | 28 +-
llvm/include/llvm/Support/TimeProfiler.h | 40 +--
llvm/lib/Support/TimeProfiler.cpp | 324 +++++++++++-------
llvm/unittests/Support/TimeProfilerTest.cpp | 2 +-
6 files changed, 255 insertions(+), 174 deletions(-)
diff --git a/clang/lib/Sema/Sema.cpp b/clang/lib/Sema/Sema.cpp
index 2e989f0ba6fe45..f6d0c88f9822aa 100644
--- a/clang/lib/Sema/Sema.cpp
+++ b/clang/lib/Sema/Sema.cpp
@@ -159,7 +159,7 @@ namespace sema {
class SemaPPCallbacks : public PPCallbacks {
Sema *S = nullptr;
llvm::SmallVector<SourceLocation, 8> IncludeStack;
- llvm::SmallVector<llvm::TimeTraceProfilerEntry *, 8> ProfilerStack;
+ llvm::SmallVector<std::shared_ptr<llvm::DurableEvent>, 8> ProfilerStack;
public:
void set(Sema &S) { this->S = &S; }
@@ -191,8 +191,10 @@ class SemaPPCallbacks : public PPCallbacks {
}
case ExitFile:
if (!IncludeStack.empty()) {
- if (llvm::timeTraceProfilerEnabled())
- llvm::timeTraceProfilerEnd(ProfilerStack.pop_back_val());
+ if (llvm::timeTraceProfilerEnabled()) {
+ auto E = ProfilerStack.pop_back_val();
+ llvm::timeTraceProfilerEnd(E);
+ }
S->DiagnoseNonDefaultPragmaAlignPack(
Sema::PragmaAlignPackDiagnoseKind::ChangedStateAtExit,
diff --git a/clang/lib/Sema/SemaExpr.cpp b/clang/lib/Sema/SemaExpr.cpp
index adc021c8cd237b..69948fd49d208d 100644
--- a/clang/lib/Sema/SemaExpr.cpp
+++ b/clang/lib/Sema/SemaExpr.cpp
@@ -18016,21 +18016,18 @@ void Sema::MarkFunctionReferenced(SourceLocation Loc,
FunctionDecl *Func,
// Notify the consumer that a function was implicitly instantiated.
Consumer.HandleCXXImplicitFunctionInstantiation(Func);
- llvm::TimeTraceScope TimeScope(
- "DeferInstantiation",
- [&]() {
- llvm::TimeTraceMetadata M;
- llvm::raw_string_ostream OS(M.Detail);
- Func->getNameForDiagnostic(OS, getPrintingPolicy(),
- /*Qualified=*/true);
- if (llvm::isTimeTraceVerbose()) {
- auto Loc = SourceMgr.getExpansionLoc(Func->getLocation());
- M.File = SourceMgr.getFilename(Loc);
- M.Line = SourceMgr.getExpansionLineNumber(Loc);
- }
- return M;
- },
- llvm::TimeTraceEventType::InstantEvent);
+ llvm::timeTraceProfilerInsert("DeferInstantiation", [&]() {
+ llvm::TimeTraceMetadata M;
+ llvm::raw_string_ostream OS(M.Detail);
+ Func->getNameForDiagnostic(OS, getPrintingPolicy(),
+ /*Qualified=*/true);
+ if (llvm::isTimeTraceVerbose()) {
+ auto Loc = SourceMgr.getExpansionLoc(Func->getLocation());
+ M.File = SourceMgr.getFilename(Loc);
+ M.Line = SourceMgr.getExpansionLineNumber(Loc);
+ }
+ return M;
+ });
}
}
} else {
diff --git a/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
b/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
index d6d580d399457d..49ee468336d67a 100644
--- a/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
+++ b/clang/lib/Sema/SemaTemplateInstantiateDecl.cpp
@@ -4942,22 +4942,18 @@ void Sema::InstantiateFunctionDefinition(SourceLocation
PointOfInstantiation,
PendingInstantiations.push_back(
std::make_pair(Function, PointOfInstantiation));
- llvm::TimeTraceScope TimeScope(
- "DeferInstantiation",
- [&]() {
- llvm::TimeTraceMetadata M;
- llvm::raw_string_ostream OS(M.Detail);
- Function->getNameForDiagnostic(OS, getPrintingPolicy(),
- /*Qualified=*/true);
- if (llvm::isTimeTraceVerbose()) {
- auto Loc = SourceMgr.getExpansionLoc(Function->getLocation());
- M.File = SourceMgr.getFilename(Loc);
- M.Line = SourceMgr.getExpansionLineNumber(Loc);
- }
- return M;
- },
- llvm::TimeTraceEventType::InstantEvent);
-
+ llvm::timeTraceProfilerInsert("DeferInstantiation", [&]() {
+ llvm::TimeTraceMetadata M;
+ llvm::raw_string_ostream OS(M.Detail);
+ Function->getNameForDiagnostic(OS, getPrintingPolicy(),
+ /*Qualified=*/true);
+ if (llvm::isTimeTraceVerbose()) {
+ auto Loc = SourceMgr.getExpansionLoc(Function->getLocation());
+ M.File = SourceMgr.getFilename(Loc);
+ M.Line = SourceMgr.getExpansionLineNumber(Loc);
+ }
+ return M;
+ });
} else if (TSK == TSK_ImplicitInstantiation) {
if (AtEndOfTU && !getDiagnostics().hasErrorOccurred() &&
!getSourceManager().isInSystemHeader(PatternDecl->getBeginLoc())) {
diff --git a/llvm/include/llvm/Support/TimeProfiler.h
b/llvm/include/llvm/Support/TimeProfiler.h
index f4952b18e4f6ef..323d7c8c5f8c55 100644
--- a/llvm/include/llvm/Support/TimeProfiler.h
+++ b/llvm/include/llvm/Support/TimeProfiler.h
@@ -94,13 +94,17 @@ struct TimeTraceMetadata {
bool isEmpty() const { return Detail.empty() && File.empty(); }
};
+struct TimeTraceProfilerEntry;
+struct InstantEvent;
+struct DurableEvent;
+struct CompleteEvent;
+struct AsyncEvent;
+
struct TimeTraceProfiler;
TimeTraceProfiler *getTimeTraceProfilerInstance();
bool isTimeTraceVerbose();
-struct TimeTraceProfilerEntry;
-
/// Initialize the time trace profiler.
/// This sets up the global \p TimeTraceProfilerInstance
/// variable to be the profiler instance.
@@ -136,13 +140,13 @@ Error timeTraceProfilerWrite(StringRef PreferredFileName,
/// Profiler copies the string data, so the pointers can be given into
/// temporaries. Time sections can be hierarchical; every Begin must have a
/// matching End pair but they can nest.
-TimeTraceProfilerEntry *timeTraceProfilerBegin(StringRef Name,
- StringRef Detail);
-TimeTraceProfilerEntry *
+std::shared_ptr<DurableEvent> timeTraceProfilerBegin(StringRef Name,
+ StringRef Detail);
+std::shared_ptr<DurableEvent>
timeTraceProfilerBegin(StringRef Name,
llvm::function_ref<std::string()> Detail);
-TimeTraceProfilerEntry *
+std::shared_ptr<DurableEvent>
timeTraceProfilerBegin(StringRef Name,
llvm::function_ref<TimeTraceMetadata()> MetaData);
@@ -151,16 +155,17 @@ timeTraceProfilerBegin(StringRef Name,
/// separately from other traces. See
///
https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview#heading=h.jh64i9l3vwa1
/// for more details.
-TimeTraceProfilerEntry *timeTraceAsyncProfilerBegin(StringRef Name,
- StringRef Detail);
+std::shared_ptr<DurableEvent> timeTraceAsyncProfilerBegin(StringRef Name,
+ StringRef Detail);
// Mark an instant event.
-TimeTraceProfilerEntry *timeTraceInstantEventProfilerBegin(StringRef Name,
+void timeTraceProfilerInsert(StringRef Name,
llvm::function_ref<TimeTraceMetadata()> Metadata);
+void timeTraceProfilerInsert(StringRef Name, StringRef Detail);
/// Manually end the last time section.
void timeTraceProfilerEnd();
-void timeTraceProfilerEnd(TimeTraceProfilerEntry *E);
+void timeTraceProfilerEnd(std::shared_ptr<DurableEvent> &E);
/// The TimeTraceScope is a helper class to call the begin and end functions
/// of the time trace profiler. When the object is constructed, it begins
@@ -187,18 +192,9 @@ class TimeTraceScope {
Entry = timeTraceProfilerBegin(Name, Detail);
}
TimeTraceScope(StringRef Name,
- llvm::function_ref<TimeTraceMetadata()> Metadata,
TimeTraceEventType Et = TimeTraceEventType::CompleteEvent) {
- if (getTimeTraceProfilerInstance() == nullptr)
- return;
- assert((Et == TimeTraceEventType::InstantEvent ||
- Et == TimeTraceEventType::CompleteEvent) &&
- "Event Type not supported.");
-
- if (Et == TimeTraceEventType::CompleteEvent) {
+ llvm::function_ref<TimeTraceMetadata()> Metadata) {
+ if (getTimeTraceProfilerInstance() != nullptr)
Entry = timeTraceProfilerBegin(Name, Metadata);
- } else {
- Entry = timeTraceInstantEventProfilerBegin(Name, Metadata);
- }
}
~TimeTraceScope() {
if (getTimeTraceProfilerInstance() != nullptr)
@@ -206,7 +202,7 @@ class TimeTraceScope {
}
private:
- TimeTraceProfilerEntry *Entry = nullptr;
+ std::shared_ptr<DurableEvent> Entry = nullptr;
};
} // end namespace llvm
diff --git a/llvm/lib/Support/TimeProfiler.cpp
b/llvm/lib/Support/TimeProfiler.cpp
index 738f5f5842bb0d..ac0c1d89bb8176 100644
--- a/llvm/lib/Support/TimeProfiler.cpp
+++ b/llvm/lib/Support/TimeProfiler.cpp
@@ -69,25 +69,20 @@ using NameAndCountAndDurationType =
} // anonymous namespace
-/// Represents an open or completed time section entry to be captured.
+/// Represents an entry to be captured.
struct llvm::TimeTraceProfilerEntry {
- TimePointType Start;
- TimePointType End;
- std::string Name;
+ const TimePointType Start;
+ const std::string Name;
TimeTraceMetadata Metadata;
- TimeTraceEventType EventType;
- TimeTraceProfilerEntry(TimePointType &&S, TimePointType &&E, std::string &&N,
- std::string &&Dt, TimeTraceEventType Et)
- : Start(std::move(S)), End(std::move(E)), Name(std::move(N)), Metadata(),
- EventType(Et) {
+ TimeTraceProfilerEntry(TimePointType &&S, std::string &&N, std::string &&Dt)
+ : Start(std::move(S)), Name(std::move(N)), Metadata() {
Metadata.Detail = std::move(Dt);
}
- TimeTraceProfilerEntry(TimePointType &&S, TimePointType &&E, std::string &&N,
- TimeTraceMetadata &&Mt, TimeTraceEventType Et)
- : Start(std::move(S)), End(std::move(E)), Name(std::move(N)),
- Metadata(std::move(Mt)), EventType(Et) {}
+ TimeTraceProfilerEntry(TimePointType &&S, std::string &&N,
+ TimeTraceMetadata &&Mt)
+ : Start(std::move(S)), Name(std::move(N)), Metadata(std::move(Mt)) {}
// Calculate timings for FlameGraph. Cast time points to microsecond
precision
// rather than casting duration. This avoids truncation issues causing inner
@@ -98,11 +93,128 @@ struct llvm::TimeTraceProfilerEntry {
.count();
}
+ virtual void writeEvent(json::OStream &J, sys::Process::Pid Pid, uint64_t
Tid,
+ TimePointType StartTime) const {
+ J.object([&] {
+ J.attribute("pid", Pid);
+ J.attribute("tid", int64_t(Tid));
+ J.attribute("ts", getFlameGraphStartUs(StartTime));
+ writeAdditionalEventFileds(J);
+ J.attribute("name", Name);
+ if (!Metadata.isEmpty()) {
+ J.attributeObject("args", [&] {
+ if (!Metadata.Detail.empty())
+ J.attribute("detail", Metadata.Detail);
+ if (!Metadata.File.empty())
+ J.attribute("file", Metadata.File);
+ if (Metadata.Line > 0)
+ J.attribute("line", Metadata.Line);
+ });
+ }
+ });
+ }
+
+ virtual void writeAdditionalEventFileds(json::OStream &J) const {}
+
+ virtual ~TimeTraceProfilerEntry() = default;
+};
+
+struct llvm::InstantEvent : llvm::TimeTraceProfilerEntry {
+ InstantEvent(TimePointType &&S, std::string &&N, std::string &&Dt)
+ : TimeTraceProfilerEntry(std::move(S), std::move(N), std::move(Dt)) {}
+
+ InstantEvent(TimePointType &&S, std::string &&N, TimeTraceMetadata &&Mt)
+ : TimeTraceProfilerEntry(std::move(S), std::move(N), std::move(Mt)) {}
+
+ void writeAdditionalEventFileds(json::OStream &J) const override {
+ J.attribute("ph", "i");
+ }
+};
+
+struct llvm::DurableEvent : llvm::TimeTraceProfilerEntry {
+ DurableEvent(TimePointType &&S, TimePointType &&E, std::string &&N,
+ std::string &&Dt)
+ : TimeTraceProfilerEntry(std::move(S), std::move(N), std::move(Dt)),
+ InstantEvents{}, End(std::move(E)) {}
+
+ DurableEvent(TimePointType &&S, TimePointType &&E, std::string &&N,
+ TimeTraceMetadata &&Mt)
+ : TimeTraceProfilerEntry(std::move(S), std::move(N), std::move(Mt)),
+ InstantEvents{}, End(std::move(E)) {}
+
+ virtual void writeEvent(json::OStream &J, sys::Process::Pid Pid, uint64_t
Tid,
+ TimePointType StartTime) const override {
+ TimeTraceProfilerEntry::writeEvent(J, Pid, Tid, StartTime);
+ writeInstantEvents(J, Pid, Tid, StartTime);
+ }
+
+ void writeInstantEvents(json::OStream &J, sys::Process::Pid Pid, uint64_t
Tid,
+ TimePointType StartTime) const {
+ for (auto IE : InstantEvents) {
+ IE->writeEvent(J, Pid, Tid, StartTime);
+ }
+ }
+
+ virtual void writeAdditionalEventFileds(json::OStream &J) const override {}
+
ClockType::rep getFlameGraphDurUs() const {
return (time_point_cast<microseconds>(End) -
time_point_cast<microseconds>(Start))
.count();
}
+
+ std::vector<std::shared_ptr<InstantEvent>> InstantEvents;
+ TimePointType End;
+};
+
+struct llvm::CompleteEvent : llvm::DurableEvent {
+ CompleteEvent(TimePointType &&S, TimePointType &&E, std::string &&N,
+ std::string &&Dt)
+ : DurableEvent(std::move(S), std::move(E), std::move(N), std::move(Dt))
{}
+
+ CompleteEvent(TimePointType &&S, TimePointType &&E, std::string &&N,
+ TimeTraceMetadata &&Mt)
+ : DurableEvent(std::move(S), std::move(E), std::move(N), std::move(Mt))
{}
+
+ virtual void writeAdditionalEventFileds(json::OStream &J) const override {
+ J.attribute("ph", "X");
+ J.attribute("dur", getFlameGraphDurUs());
+ }
+};
+
+struct llvm::AsyncEvent : llvm::DurableEvent {
+ AsyncEvent(TimePointType &&S, TimePointType &&E, std::string &&N,
+ std::string &&Dt)
+ : DurableEvent(std::move(S), std::move(E), std::move(N), std::move(Dt))
{}
+
+ AsyncEvent(TimePointType &&S, TimePointType &&E, std::string &&N,
+ TimeTraceMetadata &&Mt)
+ : DurableEvent(std::move(S), std::move(E), std::move(N), std::move(Mt))
{}
+
+ void writeEvent(json::OStream &J, sys::Process::Pid Pid, uint64_t Tid,
+ TimePointType StartTime) const override {
+ DurableEvent::writeEvent(J, Pid, Tid, StartTime);
+ writeEndEvent(J, Pid, Tid, StartTime);
+ }
+
+ void writeEndEvent(json::OStream &J, sys::Process::Pid Pid, uint64_t Tid,
+ TimePointType StartTime) const {
+ J.object([&] {
+ J.attribute("pid", Pid);
+ J.attribute("tid", int64_t(Tid));
+ J.attribute("ts", getFlameGraphStartUs(StartTime) +
getFlameGraphDurUs());
+ J.attribute("cat", Name);
+ J.attribute("ph", "e");
+ J.attribute("id", 0);
+ J.attribute("name", Name);
+ });
+ }
+
+ void writeAdditionalEventFileds(json::OStream &J) const override {
+ J.attribute("cat", Name);
+ J.attribute("ph", "b");
+ J.attribute("id", 0);
+ }
};
struct llvm::TimeTraceProfiler {
@@ -114,52 +226,68 @@ struct llvm::TimeTraceProfiler {
TimeTraceVerbose(TimeTraceVerbose) {
llvm::get_thread_name(ThreadName);
}
-
- TimeTraceProfilerEntry *begin(std::string Name,
- llvm::function_ref<std::string()> Detail,
- TimeTraceEventType Et =
TimeTraceEventType::CompleteEvent) {
- Stack.emplace_back(std::make_unique<TimeTraceProfilerEntry>(
- ClockType::now(), TimePointType(), std::move(Name), Detail(),
- Et));
- return Stack.back().get();
+ std::shared_ptr<DurableEvent> begin(std::string Name,
+ llvm::function_ref<std::string()> Detail,
+ bool AsyncEventType) {
+ if (AsyncEventType) {
+ Stack.emplace_back(std::make_shared<AsyncEvent>(
+ ClockType::now(), TimePointType(), std::move(Name), Detail()));
+ } else {
+ Stack.emplace_back(std::make_shared<CompleteEvent>(
+ ClockType::now(), TimePointType(), std::move(Name), Detail()));
+ }
+ return Stack.back();
}
- TimeTraceProfilerEntry *
+ std::shared_ptr<DurableEvent>
begin(std::string Name, llvm::function_ref<TimeTraceMetadata()> Metadata,
- TimeTraceEventType Et = TimeTraceEventType::CompleteEvent) {
- Stack.emplace_back(std::make_unique<TimeTraceProfilerEntry>(
- ClockType::now(), TimePointType(), std::move(Name), Metadata(),
- Et));
- return Stack.back().get();
+ bool AsyncEventType) {
+
+ if (AsyncEventType) {
+ Stack.emplace_back(std::make_shared<AsyncEvent>(
+ ClockType::now(), TimePointType(), std::move(Name), Metadata()));
+ } else {
+ Stack.emplace_back(std::make_shared<CompleteEvent>(
+ ClockType::now(), TimePointType(), std::move(Name), Metadata()));
+ }
+ return Stack.back();
+ }
+
+ void insert(std::string Name, llvm::function_ref<std::string()> Detail) {
+ if (Stack.empty())
+ return;
+
+ Stack.back().get()->InstantEvents.emplace_back(
+ std::make_shared<InstantEvent>(ClockType::now(), std::move(Name),
+ Detail()));
+ }
+
+ void insert(std::string Name,
+ llvm::function_ref<TimeTraceMetadata()> Metadata) {
+ if (Stack.empty())
+ return;
+
+ Stack.back().get()->InstantEvents.emplace_back(
+ std::make_shared<InstantEvent>(ClockType::now(), std::move(Name),
+ Metadata()));
}
void end() {
assert(!Stack.empty() && "Must call begin() first");
- end(*Stack.back());
+ end(Stack.back());
}
- void end(TimeTraceProfilerEntry &E) {
+ void end(std::shared_ptr<DurableEvent> &E) {
assert(!Stack.empty() && "Must call begin() first");
- E.End = ClockType::now();
+ E->End = ClockType::now();
// Calculate duration at full precision for overall counts.
- DurationType Duration = E.End - E.Start;
+ DurationType Duration = E->End - E->Start;
- // Only include Instant Events or events with a duration longer or equal to
+ // Only include events with a duration longer or equal to
// TimeTraceGranularity msec.
- if (E.EventType == TimeTraceEventType::InstantEvent ||
- duration_cast<microseconds>(Duration).count() >= TimeTraceGranularity)
{
+ if (duration_cast<microseconds>(Duration).count() >= TimeTraceGranularity)
{
Entries.emplace_back(E);
- } else {
- // if the event is not included, exclude also all instant events that
- // happened during this event.
- for (SmallVector<TimeTraceProfilerEntry, 128>::iterator it =
Entries.begin(); it != Entries.end();) {
- if (TimeTraceEventType::InstantEvent == it->EventType &&
- it->Start > E.Start && it->Start < E.End)
- it = Entries.erase(it);
- else
- ++it;
- }
}
// Track total time taken by each "name", but only the topmost levels of
@@ -168,18 +296,17 @@ struct llvm::TimeTraceProfiler {
// happens to be the ones that don't have any currently open entries above
// itself.
if (llvm::none_of(llvm::drop_begin(llvm::reverse(Stack)),
- [&](const std::unique_ptr<TimeTraceProfilerEntry> &Val) {
- return Val->Name == E.Name;
+ [&](const std::shared_ptr<DurableEvent> &Val) {
+ return Val->Name == E->Name;
})) {
- auto &CountAndTotal = CountAndTotalPerName[E.Name];
+ auto &CountAndTotal = CountAndTotalPerName[E->Name];
CountAndTotal.first++;
CountAndTotal.second += Duration;
};
- llvm::erase_if(Stack,
- [&](const std::unique_ptr<TimeTraceProfilerEntry> &Val) {
- return Val.get() == &E;
- });
+ llvm::erase_if(Stack, [&](const std::shared_ptr<DurableEvent> &Val) {
+ return Val.get() == E.get();
+ });
}
// Write events from this TimeTraceProfilerInstance and
@@ -200,54 +327,13 @@ struct llvm::TimeTraceProfiler {
J.arrayBegin();
// Emit all events for the main flame graph.
- auto writeEvent = [&](const auto &E, uint64_t Tid) {
- auto StartUs = E.getFlameGraphStartUs(StartTime);
- auto DurUs = E.getFlameGraphDurUs();
-
- J.object([&] {
- J.attribute("pid", Pid);
- J.attribute("tid", int64_t(Tid));
- J.attribute("ts", StartUs);
- if (E.EventType == TimeTraceEventType::AsyncEvent) {
- J.attribute("cat", E.Name);
- J.attribute("ph", "b");
- J.attribute("id", 0);
- } else if (E.EventType == TimeTraceEventType::CompleteEvent) {
- J.attribute("ph", "X");
- J.attribute("dur", DurUs);
- } else { // instant event
- J.attribute("ph", "i");
- }
- J.attribute("name", E.Name);
- if (!E.Metadata.isEmpty()) {
- J.attributeObject("args", [&] {
- if (!E.Metadata.Detail.empty())
- J.attribute("detail", E.Metadata.Detail);
- if (!E.Metadata.File.empty())
- J.attribute("file", E.Metadata.File);
- if (E.Metadata.Line > 0)
- J.attribute("line", E.Metadata.Line);
- });
- }
- });
-
- if (E.EventType == TimeTraceEventType::AsyncEvent) {
- J.object([&] {
- J.attribute("pid", Pid);
- J.attribute("tid", int64_t(Tid));
- J.attribute("ts", StartUs + DurUs);
- J.attribute("cat", E.Name);
- J.attribute("ph", "e");
- J.attribute("id", 0);
- J.attribute("name", E.Name);
- });
- }
- };
- for (const TimeTraceProfilerEntry &E : Entries)
- writeEvent(E, this->Tid);
+ for (const auto &E : Entries) {
+ E->writeEvent(J, Pid, this->Tid, StartTime);
+ }
for (const TimeTraceProfiler *TTP : Instances.List)
- for (const TimeTraceProfilerEntry &E : TTP->Entries)
- writeEvent(E, TTP->Tid);
+ for (const auto &E : TTP->Entries) {
+ E->writeEvent(J, Pid, TTP->Tid, StartTime);
+ }
// Emit totals by section name as additional "thread" events, sorted from
// longest one.
@@ -335,8 +421,8 @@ struct llvm::TimeTraceProfiler {
J.objectEnd();
}
- SmallVector<std::unique_ptr<TimeTraceProfilerEntry>, 16> Stack;
- SmallVector<TimeTraceProfilerEntry, 128> Entries;
+ SmallVector<std::shared_ptr<DurableEvent>, 16> Stack;
+ SmallVector<std::shared_ptr<DurableEvent>, 128> Entries;
StringMap<CountAndDurationType> CountAndTotalPerName;
// System clock time when the session was begun.
const time_point<system_clock> BeginningOfTime;
@@ -418,43 +504,47 @@ Error llvm::timeTraceProfilerWrite(StringRef
PreferredFileName,
return Error::success();
}
-TimeTraceProfilerEntry *llvm::timeTraceProfilerBegin(StringRef Name,
- StringRef Detail) {
+std::shared_ptr<DurableEvent> llvm::timeTraceProfilerBegin(StringRef Name,
+ StringRef Detail) {
if (TimeTraceProfilerInstance != nullptr)
return TimeTraceProfilerInstance->begin(
- std::string(Name), [&]() { return std::string(Detail); },
TimeTraceEventType::CompleteEvent);
+ std::string(Name), [&]() { return std::string(Detail); }, false);
return nullptr;
}
-TimeTraceProfilerEntry *
+std::shared_ptr<DurableEvent>
llvm::timeTraceProfilerBegin(StringRef Name,
llvm::function_ref<std::string()> Detail) {
if (TimeTraceProfilerInstance != nullptr)
- return TimeTraceProfilerInstance->begin(std::string(Name), Detail,
TimeTraceEventType::CompleteEvent);
+ return TimeTraceProfilerInstance->begin(std::string(Name), Detail, false);
return nullptr;
}
-TimeTraceProfilerEntry *
+std::shared_ptr<DurableEvent>
llvm::timeTraceProfilerBegin(StringRef Name,
llvm::function_ref<TimeTraceMetadata()> Metadata)
{
if (TimeTraceProfilerInstance != nullptr)
- return TimeTraceProfilerInstance->begin(std::string(Name), Metadata,
TimeTraceEventType::CompleteEvent);
+ return TimeTraceProfilerInstance->begin(std::string(Name), Metadata,
false);
return nullptr;
}
-TimeTraceProfilerEntry *
-llvm::timeTraceInstantEventProfilerBegin(StringRef Name,
- llvm::function_ref<TimeTraceMetadata()> Metadata)
{
+void llvm::timeTraceProfilerInsert(StringRef Name, StringRef Detail) {
if (TimeTraceProfilerInstance != nullptr)
- return TimeTraceProfilerInstance->begin(std::string(Name), Metadata,
TimeTraceEventType::InstantEvent);
- return nullptr;
+ TimeTraceProfilerInstance->insert(std::string(Name),
+ [&]() { return std::string(Detail); });
+}
+
+void llvm::timeTraceProfilerInsert(
+ StringRef Name, llvm::function_ref<TimeTraceMetadata()> Metadata) {
+ if (TimeTraceProfilerInstance != nullptr)
+ TimeTraceProfilerInstance->insert(std::string(Name), Metadata);
}
-TimeTraceProfilerEntry *llvm::timeTraceAsyncProfilerBegin(StringRef Name,
- StringRef Detail) {
+std::shared_ptr<DurableEvent>
+llvm::timeTraceAsyncProfilerBegin(StringRef Name, StringRef Detail) {
if (TimeTraceProfilerInstance != nullptr)
return TimeTraceProfilerInstance->begin(
- std::string(Name), [&]() { return std::string(Detail); },
TimeTraceEventType::AsyncEvent);
+ std::string(Name), [&]() { return std::string(Detail); }, true);
return nullptr;
}
@@ -463,7 +553,7 @@ void llvm::timeTraceProfilerEnd() {
TimeTraceProfilerInstance->end();
}
-void llvm::timeTraceProfilerEnd(TimeTraceProfilerEntry *E) {
+void llvm::timeTraceProfilerEnd(std::shared_ptr<DurableEvent> &E) {
if (TimeTraceProfilerInstance != nullptr)
- TimeTraceProfilerInstance->end(*E);
+ TimeTraceProfilerInstance->end(E);
}
diff --git a/llvm/unittests/Support/TimeProfilerTest.cpp
b/llvm/unittests/Support/TimeProfilerTest.cpp
index bb820ec99a393e..250e0e4f4704b8 100644
--- a/llvm/unittests/Support/TimeProfilerTest.cpp
+++ b/llvm/unittests/Support/TimeProfilerTest.cpp
@@ -57,7 +57,7 @@ TEST(TimeProfiler, Begin_End_Smoke) {
TEST(TimeProfiler, Async_Begin_End_Smoke) {
setupProfiler();
- auto *Profiler = timeTraceAsyncProfilerBegin("event", "detail");
+ auto Profiler = timeTraceAsyncProfilerBegin("event", "detail");
timeTraceProfilerEnd(Profiler);
std::string json = teardownProfiler();
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
