[CodeGen] Add MachineBlockHashInfoAnalysis for the new pass manager (#193107)

This patch introduces MachineBlockHashInfoAnalysis and its corresponding
printer pass MachineBlockHashInfoPrinterPass to the new pass manager.

This allows running -passes="print<machine-block-hash>" via llc.

Can't merge before #192826, and don't want to mix test patch with
determinism fix in #192826.

This is #192911 which was accidentally merged into spr/users branch.

Author: vitalybuka

llvm/include/llvm/CodeGen/MachineBlockHashInfo.h

@@ -106,6 +106,29 @@ class MachineBlockHashInfoResult {
   uint64_t getMBBHash(const MachineBasicBlock &MBB) const;
 };
 
+class MachineBlockHashInfoAnalysis
+    : public AnalysisInfoMixin<MachineBlockHashInfoAnalysis> {
+  friend AnalysisInfoMixin<MachineBlockHashInfoAnalysis>;
+  static AnalysisKey Key;
+
+public:
+  using Result = MachineBlockHashInfoResult;
+  Result run(MachineFunction &MF, MachineFunctionAnalysisManager &MFAM);
+};
+
+/// Printer pass for the \c MachineBlockHashInfoAnalysis results.
+class MachineBlockHashInfoPrinterPass
+    : public PassInfoMixin<MachineBlockHashInfoPrinterPass> {
+  raw_ostream &OS;
+
+public:
+  explicit MachineBlockHashInfoPrinterPass(raw_ostream &OS) : OS(OS) {}
+  PreservedAnalyses run(MachineFunction &MF,
+                        MachineFunctionAnalysisManager &MFAM);
+  static bool isRequired() { return true; }
+};
+
+/// Legacy MachineFunctionPass for MachineBlockHashInfo.
 class MachineBlockHashInfo : public MachineFunctionPass {
   MachineBlockHashInfoResult Result;
 

llvm/include/llvm/Passes/MachinePassRegistry.def

@@ -72,6 +72,7 @@ MACHINE_FUNCTION_ANALYSIS("live-reg-matrix", LiveRegMatrixAnalysis())
 MACHINE_FUNCTION_ANALYSIS("live-stacks", LiveStacksAnalysis())
 MACHINE_FUNCTION_ANALYSIS("live-vars", LiveVariablesAnalysis())
 MACHINE_FUNCTION_ANALYSIS("machine-block-freq", MachineBlockFrequencyAnalysis())
+MACHINE_FUNCTION_ANALYSIS("machine-block-hash", MachineBlockHashInfoAnalysis())
 MACHINE_FUNCTION_ANALYSIS("machine-branch-prob",
                           MachineBranchProbabilityAnalysis())
 MACHINE_FUNCTION_ANALYSIS("machine-cycles", MachineCycleAnalysis())
@@ -143,6 +144,8 @@ MACHINE_FUNCTION_PASS("print<live-stacks>", LiveStacksPrinterPass(errs()))
 MACHINE_FUNCTION_PASS("print<live-vars>", LiveVariablesPrinterPass(errs()))
 MACHINE_FUNCTION_PASS("print<machine-block-freq>",
                       MachineBlockFrequencyPrinterPass(errs()))
+MACHINE_FUNCTION_PASS("print<machine-block-hash>",
+                      MachineBlockHashInfoPrinterPass(errs()))
 MACHINE_FUNCTION_PASS("print<machine-branch-prob>",
                       MachineBranchProbabilityPrinterPass(errs()))
 MACHINE_FUNCTION_PASS("print<machine-cycles>", MachineCycleInfoPrinterPass(errs()))

llvm/lib/CodeGen/MachineBlockHashInfo.cpp

@@ -12,9 +12,11 @@
 
 #include "llvm/CodeGen/MachineBlockHashInfo.h"
 #include "llvm/ADT/Hashing.h"
+#include "llvm/CodeGen/MachineFunction.h"
 #include "llvm/CodeGen/MachineStableHash.h"
 #include "llvm/CodeGen/Passes.h"
 #include "llvm/InitializePasses.h"
+#include "llvm/Support/raw_ostream.h"
 #include "llvm/Target/TargetMachine.h"
 
 using namespace llvm;
@@ -111,7 +113,7 @@ MachineBlockHashInfoResult::MachineBlockHashInfoResult(
 uint64_t
 MachineBlockHashInfoResult::getMBBHash(const MachineBasicBlock &MBB) const {
   auto it = MBBHashInfo.find(&MBB);
-  return it == MBBHashInfo.end() ? 0 : it->second;
+  return it->second;
 }
 
 bool MachineBlockHashInfo::runOnMachineFunction(MachineFunction &F) {
@@ -126,3 +128,23 @@ uint64_t MachineBlockHashInfo::getMBBHash(const MachineBasicBlock &MBB) const {
 MachineFunctionPass *llvm::createMachineBlockHashInfoPass() {
   return new MachineBlockHashInfo();
 }
+
+AnalysisKey MachineBlockHashInfoAnalysis::Key;
+
+MachineBlockHashInfoResult
+MachineBlockHashInfoAnalysis::run(MachineFunction &MF,
+                                  MachineFunctionAnalysisManager &MFAM) {
+  return MachineBlockHashInfoResult{MF};
+}
+
+PreservedAnalyses
+MachineBlockHashInfoPrinterPass::run(MachineFunction &MF,
+                                     MachineFunctionAnalysisManager &MFAM) {
+  auto &MBHI = MFAM.getResult<MachineBlockHashInfoAnalysis>(MF);
+  OS << "Machine Block Hash Info for function: " << MF.getName() << "\n";
+  for (const auto &MBB : MF) {
+    OS << "  BB#" << MBB.getNumber() << ": "
+       << format_hex(MBHI.getMBBHash(MBB), 16) << "\n";
+  }
+  return PreservedAnalyses::all();
+}

llvm/lib/Passes/PassBuilder.cpp

@@ -119,6 +119,7 @@
 #include "llvm/CodeGen/LowerEmuTLS.h"
 #include "llvm/CodeGen/MIRPrinter.h"
 #include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
+#include "llvm/CodeGen/MachineBlockHashInfo.h"
 #include "llvm/CodeGen/MachineBlockPlacement.h"
 #include "llvm/CodeGen/MachineBranchProbabilityInfo.h"
 #include "llvm/CodeGen/MachineCSE.h"

llvm/test/CodeGen/X86/machine-block-hash.mir

@@ -0,0 +1,53 @@
+# NOTE: Assertions have been autogenerated by utils/update_mir_test_checks.py UTC_ARGS: --version 6
+# RUN: llc -mtriple=x86_64-pc-linux -passes="print<machine-block-hash>" -filetype=null %s 2>&1 | FileCheck %s --check-prefix=HASH
+
+name:            foo
+body:             |
+  ; HASH-LABEL: Machine Block Hash Info for function: foo
+  ; HASH-NEXT:  BB#0: 0xa6e9dab7a6e90002
+  ; HASH-NEXT:  BB#1: 0xa6e912e7a6e90002
+  bb.0:
+    $eax = MOV32ri 1
+    RET 0
+
+  bb.1:
+    $eax = MOV32ri 2
+    RET 0
+...
+---
+name:            func_mbb
+body:             |
+  ; HASH-LABEL: Machine Block Hash Info for function: func_mbb
+  ; HASH-NEXT:  BB#0: 0x60fdab7a6e90002
+  ; HASH-NEXT:  BB#1: 0x60f12e7a6e90002
+  bb.0:
+    successors: %bb.1
+    $eax = MOV32ri 1
+    JMP_1 %bb.1
+
+  bb.1:
+    $eax = MOV32ri 2
+    RET 0
+...
+---
+name:            func_global
+body:             |
+  ; HASH-LABEL: Machine Block Hash Info for function: func_global
+  ; HASH-NEXT:  BB#0: 0xcc1bf164cc1b0002
+  bb.0:
+    $rax = MOV64rm $rip, 1, $noreg, @foo, $noreg
+    RET 0
+...
+---
+name:            func_fp
+body:             |
+  ; HASH-LABEL: Machine Block Hash Info for function: func_fp
+  ; HASH-NEXT:  BB#0: 0x9d668f2d9d660002
+  bb.0:
+    $xmm0 = MOVSSrm $rip, 1, $noreg, %const.0, $noreg
+    RET 0
+constants:
+  - id:              0
+    value:           'float 1.000000e+00'
+    alignment:       4
+...