[lld] Add test to check for timer output

[akhuang]

Summary

This test checks that timers are working and printing as expected.

I also seem to have changed the order of the timers in my globals refactoring
patch, so I fixed it here.

[aganea]

LTGM, thanks!

[mehdi_amini]

The timers.ll test is failing intermittently, can you look into this? See here for example: https://lab.llvm.org/buildbot/#/builders/139/builds/10288

[akhuang]

Hm, a timer won't print out if the time is 0, and it seems like it's inconsistent when a timer will have no time on it.. I think I'll just remove the test for now.

lld/COFF/COFFLinkerContext.h

public:
   Timer totalMapTimer;
   Timer symbolGatherTimer;
   Timer symbolStringsTimer;
   Timer writeTimer;
 
   // PDB timers.
   Timer totalPdbLinkTimer;
   Timer addObjectsTimer;
-  Timer symbolMergingTimer;
   Timer typeMergingTimer;
-  Timer tpiStreamLayoutTimer;
-  Timer publicsLayoutTimer;
-  Timer diskCommitTimer;
   Timer loadGHashTimer;
   Timer mergeGHashTimer;
+  Timer symbolMergingTimer;
+  Timer publicsLayoutTimer;
+  Timer tpiStreamLayoutTimer;
+  Timer diskCommitTimer;
 };
 
 } // namespace coff
 } // namespace lld
 
 #endif

lld/COFF/COFFLinkerContext.cpp

 COFFLinkerContext::COFFLinkerContext()
     : symtab(*this), rootTimer("Total Linking Time"),
       inputFileTimer("Input File Reading", rootTimer),
       ltoTimer("LTO", rootTimer), gcTimer("GC", rootTimer),
       icfTimer("ICF", rootTimer), codeLayoutTimer("Code Layout", rootTimer),
       outputCommitTimer("Commit Output File", rootTimer),
       totalMapTimer("MAP Emission (Cumulative)", rootTimer),
       symbolGatherTimer("Gather Symbols", totalMapTimer),
-      symbolStringsTimer("Build Symbol strings", totalMapTimer),
+      symbolStringsTimer("Build Symbol Strings", totalMapTimer),
       writeTimer("Write to File", totalMapTimer),
       totalPdbLinkTimer("PDB Emission (Cumulative)", rootTimer),
       addObjectsTimer("Add Objects", totalPdbLinkTimer),
-      symbolMergingTimer("Symbol Merging", addObjectsTimer),
       typeMergingTimer("Type Merging", addObjectsTimer),
-      tpiStreamLayoutTimer("TPI Stream Layout", totalPdbLinkTimer),
-      publicsLayoutTimer("Publics Stream Layout", totalPdbLinkTimer),
-      diskCommitTimer("Commit to Disk", totalPdbLinkTimer),
       loadGHashTimer("Global Type Hashing", addObjectsTimer),
-      mergeGHashTimer("GHash Type Merging", addObjectsTimer) {}
+      mergeGHashTimer("GHash Type Merging", addObjectsTimer),
+      symbolMergingTimer("Symbol Merging", addObjectsTimer),
+      publicsLayoutTimer("Publics Stream Layout", totalPdbLinkTimer),
+      tpiStreamLayoutTimer("TPI Stream Layout", totalPdbLinkTimer),
+      diskCommitTimer("Commit to Disk", totalPdbLinkTimer) {}
 
 COFFLinkerContext::~COFFLinkerContext() { clearGHashes(); }
 
 void COFFLinkerContext::clearGHashes() {
   for (TpiSource *src : tpiSourceList) {
     if (src->ownedGHashes)
       delete[] src->ghashes.data();
     src->ghashes = {};
     src->isItemIndex.clear();
     src->uniqueTypes.clear();
   }
 }
 
 } // namespace coff
 } // namespace lld

lld/test/COFF/timers.ll

+; REQUIRES: x86
+; RUN: llvm-as %s -o %t.obj
+
+; Test different configurations of lld to get all possible timer outputs.
+; RUN: lld-link %t.obj -time -entry:main -debug:noghash 2>&1 | \
+; RUN:   FileCheck %s --check-prefix=CHECK1
+; RUN: lld-link %t.obj -time -entry:main -debug 2>&1 | \
+; RUN:   FileCheck %s --check-prefix=CHECK2
+; RUN: lld-link %t.obj -time -entry:main -map 2>&1 | \
+; RUN:   FileCheck %s --check-prefix=CHECK3
+
+; CHECK1: Input File Reading:
+; CHECK1: LTO:
+; CHECK1: Code Layout:
+; CHECK1: Commit Output File:
+; CHECK1: PDB Emission (Cumulative):
+; CHECK1:   Add Objects:
+; CHECK1:     Type Merging:
+; CHECK1:     Symbol Merging:
+; CHECK1:   Publics Stream Layout:
+; CHECK1:   TPI Stream Layout:
+; CHECK1:   Commit to Disk:
+
+; CHECK2: Input File Reading:
+; CHECK2: LTO:
+; CHECK2: Code Layout:
+; CHECK2: Commit Output File:
+; CHECK2: PDB Emission (Cumulative):
+; CHECK2:   Add Objects:
+; CHECK2:     Global Type Hashing:
+; CHECK2:     GHash Type Merging:
+; CHECK2:     Symbol Merging:
+; CHECK2:   Publics Stream Layout:
+; CHECK2:   TPI Stream Layout:
+; CHECK2:   Commit to Disk:
+
+; CHECK3: Input File Reading:
+; CHECK3: LTO:
+; CHECK3: GC:
+; CHECK3: ICF:
+; CHECK3: Code Layout:
+; CHECK3: Commit Output File:
+; CHECK3: MAP Emission (Cumulative):
+; CHECK3:   Gather Symbols:
+; CHECK3:   Build Symbol Strings:
+; CHECK3:   Write to File:
+
+target datalayout = "e-m:w-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-pc-windows-msvc19.11.0"
+
+define dso_local i32 @main() {
+entry:
+  ret i32 0
+}
+
+!llvm.dbg.cu = !{!0}
+!llvm.module.flags = !{!2, !3}
+
+!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1, producer: "clang version 14.0.0", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None)
+!1 = !DIFile(filename: "t.cpp", directory: "", checksumkind: CSK_MD5, checksum: "495fd79f78a98304e065540d576057d9")
+!2 = !{i32 2, !"CodeView", i32 1}
+!3 = !{i32 2, !"Debug Info Version", i32 3}