[SLU][profcheck] create likely branch weights for guard->branch

Author: mtrofin

llvm/lib/Transforms/Scalar/SimpleLoopUnswitch.cpp

@@ -40,6 +40,7 @@
 #include "llvm/IR/Instruction.h"
 #include "llvm/IR/Instructions.h"
 #include "llvm/IR/IntrinsicInst.h"
+#include "llvm/IR/MDBuilder.h"
 #include "llvm/IR/Module.h"
 #include "llvm/IR/PatternMatch.h"
 #include "llvm/IR/ProfDataUtils.h"
@@ -2831,9 +2832,14 @@ static BranchInst *turnGuardIntoBranch(IntrinsicInst *GI, Loop &L,
      MSSAU->getMemorySSA()->verifyMemorySSA();
 
   DomTreeUpdater DTU(DT, DomTreeUpdater::UpdateStrategy::Eager);
-  Instruction *DeoptBlockTerm =
-      SplitBlockAndInsertIfThen(GI->getArgOperand(0), GI, true,
-                                GI->getMetadata(LLVMContext::MD_prof), &DTU, &LI);
+  // llvm.experimental.guard doesn't have branch weights. We can assume,
+  // however, that the deopt path is unlikely.
+  Instruction *DeoptBlockTerm = SplitBlockAndInsertIfThen(
+      GI->getArgOperand(0), GI, true,
+      !ProfcheckDisableMetadataFixes && EstimateProfile
+          ? MDBuilder(GI->getContext()).createUnlikelyBranchWeights()
+          : nullptr,
+      &DTU, &LI);
   BranchInst *CheckBI = cast<BranchInst>(CheckBB->getTerminator());
   // SplitBlockAndInsertIfThen inserts control flow that branches to
   // DeoptBlockTerm if the condition is true.  We want the opposite.

llvm/test/Transforms/SimpleLoopUnswitch/guards.ll

@@ -1,14 +1,14 @@
-; NOTE: Assertions have been autogenerated by utils/update_test_checks.py UTC_ARGS: -p --version 5
+; NOTE: Assertions have been autogenerated by utils/update_test_checks.py UTC_ARGS: -p --check-globals all --version 5
 ; RUN: opt -passes='loop(simple-loop-unswitch<nontrivial>),verify<loops>' -simple-loop-unswitch-guards -S < %s | FileCheck %s
 ; RUN: opt -passes='simple-loop-unswitch<nontrivial>' -simple-loop-unswitch-guards -S < %s | FileCheck %s
 ; RUN: opt -passes='loop-mssa(simple-loop-unswitch<nontrivial>),verify<loops>' -simple-loop-unswitch-guards  -verify-memoryssa -verify-loop-info -S < %s | FileCheck %s
 
 declare void @llvm.experimental.guard(i1, ...)
 
-define void @test_simple_case(i1 %cond, i32 %N) {
-; CHECK-LABEL: define void @test_simple_case(i1 %cond, i32 %N) {
+define void @test_simple_case(i1 %cond, i32 %N) !prof !0 {
+; CHECK-LABEL: define void @test_simple_case(i1 %cond, i32 %N) !prof !0 {
 ; CHECK-NEXT:  entry:
-; CHECK-NEXT:    br i1 %cond, label %entry.split.us, label %entry.split
+; CHECK-NEXT:    br i1 %cond, label %entry.split.us, label %entry.split, !prof !1
 ; CHECK:       entry.split.us:
 ; CHECK-NEXT:    br label %loop.us
 ; CHECK:       loop.us:
@@ -48,9 +48,9 @@ exit:
 define void @test_two_guards(i1 %cond1, i1 %cond2, i32 %N) {
 ; CHECK-LABEL: define void @test_two_guards(i1 %cond1, i1 %cond2, i32 %N) {
 ; CHECK-NEXT:  entry:
-; CHECK-NEXT:    br i1 %cond1, label %entry.split.us, label %entry.split
+; CHECK-NEXT:    br i1 %cond1, label %entry.split.us, label %entry.split, !prof !1
 ; CHECK:       entry.split.us:
-; CHECK-NEXT:    br i1 %cond2, label %entry.split.us.split.us, label %entry.split.us.split
+; CHECK-NEXT:    br i1 %cond2, label %entry.split.us.split.us, label %entry.split.us.split, !prof !1
 ; CHECK:       entry.split.us.split.us:
 ; CHECK-NEXT:    br label %loop.us.us
 ; CHECK:       loop.us.us:
@@ -105,7 +105,7 @@ define void @test_conditional_guards(i1 %cond, i32 %N) {
 ; CHECK-LABEL: define void @test_conditional_guards(i1 %cond, i32 %N) {
 ; CHECK-NEXT:  entry:
 ; CHECK-NEXT:    %cond.fr = freeze i1 %cond
-; CHECK-NEXT:    br i1 %cond.fr, label %entry.split.us, label %entry.split
+; CHECK-NEXT:    br i1 %cond.fr, label %entry.split.us, label %entry.split, !prof !1
 ; CHECK:       entry.split.us:
 ; CHECK-NEXT:    br label %loop.us
 ; CHECK:       loop.us:
@@ -167,7 +167,7 @@ exit:
 define void @test_nested_loop(i1 %cond, i32 %N, i1 %arg) {
 ; CHECK-LABEL: define void @test_nested_loop(i1 %cond, i32 %N, i1 %arg) {
 ; CHECK-NEXT:  entry:
-; CHECK-NEXT:    br i1 %cond, label %entry.split, label %outer_loop.split
+; CHECK-NEXT:    br i1 %cond, label %entry.split, label %outer_loop.split, !prof !1
 ; CHECK:       entry.split:
 ; CHECK-NEXT:    br i1 %arg, label %entry.split.split.us, label %entry.split.split
 ; CHECK:       entry.split.split.us:
@@ -238,7 +238,7 @@ exit:
 define void @test_sibling_loops(i1 %cond1, i1 %cond2, i32 %N) {
 ; CHECK-LABEL: define void @test_sibling_loops(i1 %cond1, i1 %cond2, i32 %N) {
 ; CHECK-NEXT:  entry:
-; CHECK-NEXT:    br i1 %cond1, label %entry.split.us, label %entry.split
+; CHECK-NEXT:    br i1 %cond1, label %entry.split.us, label %entry.split, !prof !1
 ; CHECK:       entry.split.us:
 ; CHECK-NEXT:    br label %loop1.us
 ; CHECK:       loop1.us:
@@ -258,7 +258,7 @@ define void @test_sibling_loops(i1 %cond1, i1 %cond2, i32 %N) {
 ; CHECK-NEXT:    call void (i1, ...) @llvm.experimental.guard(i1 false) [ "deopt"() ]
 ; CHECK-NEXT:    unreachable
 ; CHECK:       between:
-; CHECK-NEXT:    br i1 %cond2, label %between.split.us2, label %between.split
+; CHECK-NEXT:    br i1 %cond2, label %between.split.us2, label %between.split, !prof !1
 ; CHECK:       between.split.us2:
 ; CHECK-NEXT:    br label %loop2.us
 ; CHECK:       loop2.us:
@@ -337,3 +337,9 @@ exit:
 
 declare void @may_throw(i32 %i)
 declare i32 @__CxxFrameHandler3(...)
+
+!0 = !{!"function_entry_count", i32 10}
+;.
+; CHECK: !0 = !{!"function_entry_count", i32 10}
+; CHECK: !1 = !{!"branch_weights", i32 1048575, i32 1}
+;.