demangle OptFunction trace names

[Trass3r]

Summary

This improves consistency in the trace files as other entries are demangled too.
Fixes #45901.

[thakis]

Is it possible to test this?

llvm/lib/IR/LegacyPassManager.cpp

1412–1413

Please use a named capture list instead of [&}.

[Trass3r]

I don't know, are there any tests for all the other scopes?
There is a generic test for the functionality.

llvm/lib/IR/LegacyPassManager.cpp

1412–1413

Ok. Just followed the pattern used by other call sites like https://github.com/llvm/llvm-project/blob/781b491bba9d798e53f7784dced3c2be77c81dd4/clang/lib/CodeGen/CodeGenModule.cpp#L3570

[Trass3r]

explicit lambda capture and format

[thakis]

I don't know if there are tests. In any case, it's good to add one for this change, no? :)

[Trass3r]

Any pointers where that test would go and how to write it?

[Trass3r]

@thakis found a suitable test where I could add this

[Trass3r]

@thakis ping

[jamieschmeiser]

Is the mode change on check-time-trace-sections.py intended? I did a count of python files under llvm-project and < 10% are 755. I'm not saying it is better one way or the other; I'm just ensuring it is intentional.

[Trass3r]

Yeah it was conscious at least. No strong opinion on that though.

[jamieschmeiser]

LGTM

[lebedev.ri]

Old pass manager is dead. There is no point in making improvements to it.

[Trass3r]

Well last time I checked it this code was still in use. When is it going to be deleted?
Also the test has value to ensure the new pass manager emits these entries as before.

[lebedev.ri]

This review may be stuck/dead, consider abandoning if no longer relevant.
Removing myself as reviewer in attempt to clean dashboard.

[Trass3r]

I can only refer to my last comment, even in latest trunk that code is still active for the codegen passes.
But meanwhile I found the corresponding new code.

clang/test/Driver/check-time-trace-sections.py

 #!/usr/bin/env python
 
 import json, sys, time
 
 def is_inside(range1, range2):
     a = range1["ts"]; b = a + range1["dur"]
     c = range2["ts"]; d = c + range2["dur"]
     return (a >= c and a <= d) and (b >= c and b <= d)
 
 def is_before(range1, range2):
     b = range1["ts"] + range1["dur"]; c = range2["ts"]
     return b <= c
 
 log_contents = json.loads(sys.stdin.read())
 events = log_contents["traceEvents"]
-codegens = [event for event in events if event["name"] == "CodeGen Function"]
+
+instants  = [event for event in events if event["name"] == "InstantiateFunction"]
+codegens  = [event for event in events if event["name"] == "CodeGen Function"]
+opts      = [event for event in events if event["name"] == "OptFunction"]
 frontends = [event for event in events if event["name"] == "Frontend"]
-backends = [event for event in events if event["name"] == "Backend"]
+backends  = [event for event in events if event["name"] == "Backend"]
 
 beginning_of_time = log_contents["beginningOfTime"] / 1000000
 seconds_since_epoch = time.time()
 
 # Make sure that the 'beginningOfTime' is not later than now.
 if beginning_of_time > seconds_since_epoch:
     sys.exit("'beginningOfTime' should represent the absolute time when the "
              "process has started")
 
 if not all([any([is_inside(codegen, frontend) for frontend in frontends])
                         for codegen in codegens]):
     sys.exit("Not all CodeGen sections are inside any Frontend section!")
 
 if not all([all([is_before(frontend, backend) for frontend in frontends])
                         for backend in backends]):
     sys.exit("Not all Frontend section are before all Backend sections!")
+
+# Check that entries for foo exist and are in a demangled form.
+if not any(e for e in instants if "foo<int>" in e["args"]["detail"]):
+    sys.exit("Missing Instantiate entry for foo!")
+if not any(e for e in codegens if "foo<int>" in e["args"]["detail"]):
+    sys.exit("Missing CodeGen entry for foo!")
+if not any(e for e in opts if "foo<int>" in e["args"]["detail"]):
+    sys.exit("Missing Optimize entry for foo!")

llvm/lib/IR/CMakeLists.txt

add_llvm_component_library(LLVMCore
   LINK_LIBS
   ${LLVM_PTHREAD_LIB}
 
   DEPENDS
   intrinsics_gen
 
   LINK_COMPONENTS
   BinaryFormat
+  Demangle
   Remarks
   Support
   TargetParser
   )

llvm/lib/IR/LegacyPassManager.cpp

 //===- LegacyPassManager.cpp - LLVM Pass Infrastructure Implementation ----===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file implements the legacy LLVM Pass Manager infrastructure.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/IR/LegacyPassManager.h"
 #include "llvm/ADT/MapVector.h"
+#include "llvm/Demangle/Demangle.h"
 #include "llvm/IR/DiagnosticInfo.h"
 #include "llvm/IR/IRPrintingPasses.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/IR/LegacyPassManagers.h"
 #include "llvm/IR/Module.h"
 #include "llvm/IR/PassTimingInfo.h"
 #include "llvm/IR/PrintPasses.h"
 #include "llvm/Support/Chrono.h"
bool FPPassManager::runOnFunction(Function &F) {
   StringMap<std::pair<unsigned, unsigned>> FunctionToInstrCount;
   bool EmitICRemark = M.shouldEmitInstrCountChangedRemark();
   // Collect the initial size of the module.
   if (EmitICRemark) {
     InstrCount = initSizeRemarkInfo(M, FunctionToInstrCount);
     FunctionSize = F.getInstructionCount();
   }
 
-  llvm::TimeTraceScope FunctionScope("OptFunction", F.getName());
+  llvm::TimeTraceScope FunctionScope(
+      "OptFunction", [&F]() { return demangle(F.getName().str()); });
 
   for (unsigned Index = 0; Index < getNumContainedPasses(); ++Index) {
     FunctionPass *FP = getContainedPass(Index);
     bool LocalChanged = false;
 
     llvm::TimeTraceScope PassScope("RunPass", FP->getPassName());
 
     dumpPassInfo(FP, EXECUTION_MSG, ON_FUNCTION_MSG, F.getName());

llvm/lib/Passes/CMakeLists.txt

add_llvm_component_library(LLVMPasses
   intrinsics_gen
 
   LINK_COMPONENTS
   AggressiveInstCombine
   Analysis
   CodeGen
   Core
   Coroutines
+  Demangle
   IPO
   InstCombine
   IRPrinter
   ObjCARC
   Scalar
   Support
   Target
   TransformUtils
   Vectorize
   Instrumentation
   )

llvm/lib/Passes/StandardInstrumentations.cpp

 //===----------------------------------------------------------------------===//
 
 #include "llvm/Passes/StandardInstrumentations.h"
 #include "llvm/ADT/Any.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Analysis/CallGraphSCCPass.h"
 #include "llvm/Analysis/LazyCallGraph.h"
 #include "llvm/Analysis/LoopInfo.h"
+#include "llvm/Demangle/Demangle.h"
 #include "llvm/IR/Constants.h"
 #include "llvm/IR/Function.h"
 #include "llvm/IR/LegacyPassManager.h"
 #include "llvm/IR/Module.h"
 #include "llvm/IR/PassInstrumentation.h"
 #include "llvm/IR/PassManager.h"
 #include "llvm/IR/PrintPasses.h"
 #include "llvm/IR/Verifier.h"

 void printIR(raw_ostream &OS, const Loop *L) {
   const Function *F = L->getHeader()->getParent();
   if (!isFunctionInPrintList(F->getName()))
     return;
   printLoop(const_cast<Loop &>(*L), OS);
 }
 
 std::string getIRName(Any IR) {
-  if (any_cast<const Module *>(&IR))
-    return "[module]";
+  if (const auto **M = any_cast<const Module *>(&IR))
+    return (*M)->getModuleIdentifier();
 
   if (const auto **F = any_cast<const Function *>(&IR))
-    return (*F)->getName().str();
+    return demangle((*F)->getName().str());
 
   if (const auto **C = any_cast<const LazyCallGraph::SCC *>(&IR))
     return (*C)->getName();
 
   if (const auto **L = any_cast<const Loop *>(&IR))
     return (*L)->getName().str();
 
   llvm_unreachable("Unknown wrapped IR type");