Refactored TimeTraceProfilerEntry to allow easier extensibility. Implemented inserting Instant Events with a single function.

Author: ivanaivanovska

clang/lib/Sema/Sema.cpp

@@ -160,7 +160,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; }
@@ -192,8 +192,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,

clang/lib/Sema/SemaExpr.cpp

@@ -18049,21 +18049,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 {

clang/lib/Sema/SemaTemplateInstantiateDecl.cpp

@@ -4984,22 +4984,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())) {

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,26 +192,17 @@ 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)
       timeTraceProfilerEnd(Entry);
   }
 
 private:
-  TimeTraceProfilerEntry *Entry = nullptr;
+  std::shared_ptr<DurableEvent> Entry = nullptr;
 };
 
 } // end namespace llvm