Expose TimeTraceProfiler for Async Events

[atetubou]

To avoid issue like #56554 and #83236 due to no guarantees for nested relationships between file level span and syntax tree level span, I'd like to have a timeTraceAsyncProfilerBegin specific to trace handling only Source spans around

llvm-project/clang/lib/Sema/Sema.cpp

Lines 153 to 170 in 8715f25

	if (IncludeLoc.isValid()) {
	if (llvm::timeTraceProfilerEnabled()) {
	OptionalFileEntryRef FE = SM.getFileEntryRefForID(SM.getFileID(Loc));
	llvm::timeTraceProfilerBegin("Source", FE ? FE->getName()
	: StringRef("<unknown>"));
	}
	IncludeStack.push_back(IncludeLoc);
	S->DiagnoseNonDefaultPragmaAlignPack(
	Sema::PragmaAlignPackDiagnoseKind::NonDefaultStateAtInclude,
	IncludeLoc);
	}
	break;
	}
	case ExitFile:
	if (!IncludeStack.empty()) {
	if (llvm::timeTraceProfilerEnabled())
	llvm::timeTraceProfilerEnd();

.

This is a preparation PR to do that in following PR.

[llvmbot]

@llvm/pr-subscribers-llvm-support

Author: Takuto Ikuta (atetubou)

Changes

To avoid issue like #56554 and #83236 due to no guarantees for nested relationships between file level span and syntax tree level span, I'd like to have a TimeTraceProfiler specific to trace handling only Source spans around

llvm-project/clang/lib/Sema/Sema.cpp

Lines 153 to 170 in 8715f25

	if (IncludeLoc.isValid()) {
	if (llvm::timeTraceProfilerEnabled()) {
	OptionalFileEntryRef FE = SM.getFileEntryRefForID(SM.getFileID(Loc));
	llvm::timeTraceProfilerBegin("Source", FE ? FE->getName()
	: StringRef("<unknown>"));
	}
	IncludeStack.push_back(IncludeLoc);
	S->DiagnoseNonDefaultPragmaAlignPack(
	Sema::PragmaAlignPackDiagnoseKind::NonDefaultStateAtInclude,
	IncludeLoc);
	}
	break;
	}
	case ExitFile:
	if (!IncludeStack.empty()) {
	if (llvm::timeTraceProfilerEnabled())
	llvm::timeTraceProfilerEnd();

.

This is a preparation patch to do that in following PR.

---

Full diff: https://github.com/llvm/llvm-project/pull/83778.diff

2 Files Affected:

• (modified) llvm/include/llvm/Support/TimeProfiler.h (+6)
• (modified) llvm/lib/Support/TimeProfiler.cpp (+21)

diff --git a/llvm/include/llvm/Support/TimeProfiler.h b/llvm/include/llvm/Support/TimeProfiler.h
index 454a65f70231f4..cef4110c10deae 100644
--- a/llvm/include/llvm/Support/TimeProfiler.h
+++ b/llvm/include/llvm/Support/TimeProfiler.h
@@ -86,6 +86,9 @@ class raw_pwrite_stream;
 struct TimeTraceProfiler;
 TimeTraceProfiler *getTimeTraceProfilerInstance();
 
+TimeTraceProfiler *newTimeTraceProfiler(unsigned TimeTraceGranularity = 0,
+                                        StringRef ProcName = "");
+
 /// Initialize the time trace profiler.
 /// This sets up the global \p TimeTraceProfilerInstance
 /// variable to be the profiler instance.
@@ -123,9 +126,12 @@ Error timeTraceProfilerWrite(StringRef PreferredFileName,
 void timeTraceProfilerBegin(StringRef Name, StringRef Detail);
 void timeTraceProfilerBegin(StringRef Name,
                             llvm::function_ref<std::string()> Detail);
+void timeTraceProfilerBegin(TimeTraceProfiler *Profiler, StringRef Name,
+                            StringRef Detail);
 
 /// Manually end the last time section.
 void timeTraceProfilerEnd();
+void timeTraceProfilerEnd(TimeTraceProfiler *Profiler);
 
 /// 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
diff --git a/llvm/lib/Support/TimeProfiler.cpp b/llvm/lib/Support/TimeProfiler.cpp
index 4d625b3eb5b170..9cd5ea6d81758f 100644
--- a/llvm/lib/Support/TimeProfiler.cpp
+++ b/llvm/lib/Support/TimeProfiler.cpp
@@ -293,6 +293,16 @@ void llvm::timeTraceProfilerInitialize(unsigned TimeTraceGranularity,
       TimeTraceGranularity, llvm::sys::path::filename(ProcName));
 }
 
+TimeTraceProfiler *llvm::newTimeTraceProfiler(unsigned TimeTraceGranularity,
+                                              StringRef ProcName) {
+  TimeTraceProfiler *Profiler =
+      new TimeTraceProfiler(TimeTraceGranularity, ProcName);
+  auto &Instances = getTimeTraceProfilerInstances();
+  std::lock_guard<std::mutex> Lock(Instances.Lock);
+  Instances.List.push_back(Profiler);
+  return Profiler;
+}
+
 // Removes all TimeTraceProfilerInstances.
 // Called from main thread.
 void llvm::timeTraceProfilerCleanup() {
@@ -353,7 +363,18 @@ void llvm::timeTraceProfilerBegin(StringRef Name,
     TimeTraceProfilerInstance->begin(std::string(Name), Detail);
 }
 
+void llvm::timeTraceProfilerBegin(TimeTraceProfiler *Profiler, StringRef Name,
+                                  StringRef Detail) {
+  if (Profiler != nullptr)
+    Profiler->begin(std::string(Name), [&]() { return std::string(Detail); });
+}
+
 void llvm::timeTraceProfilerEnd() {
   if (TimeTraceProfilerInstance != nullptr)
     TimeTraceProfilerInstance->end();
 }
+
+void llvm::timeTraceProfilerEnd(TimeTraceProfiler *Profiler) {
+  if (Profiler != nullptr)
+    Profiler->end();
+}

[atetubou]

@ZequanWu could you take a look this?

[atetubou]

@MaskRay thank you for taking a look. If this looks good to you, could you merge this PR?
I'll rebase #83961 when this is merged.