[flang][CodeGen] fix bug hoisting allocas using a shared constant arg #116251
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When hoisting the allocas with a constant integer size, the constant integer was moved to where the alloca is hoisted to unconditionally. By CodeGen there have been various iterations of mlir canonicalization and dead code elimination. This can cause lots of unrelated bits of code to share the same constant values. If for some reason the alloca couldn't be hoisted all of the way to the entry block of the function, moving the constant might result in it no-longer dominating some of the remaining uses. In theory, there should be dominance analysis to ensure the location of the constant does dominate all uses of it. But those constants are effectively free anyway (they aren't even separate instructions in LLVM IR), so it is less expensive just to leave the old one where it was and insert a new one we know for sure is immediately before the alloca.
tblah
requested review from
VijayKandiah,
clementval,
pawosm-arm and
vzakhari
llvmbot
added
flang
Member
|
@llvm/pr-subscribers-flang-fir-hlfir @llvm/pr-subscribers-flang-codegen Author: Tom Eccles (tblah) ChangesWhen hoisting the allocas with a constant integer size, the constant integer was moved to where the alloca is hoisted to unconditionally. By CodeGen there have been various iterations of mlir canonicalization and dead code elimination. This can cause lots of unrelated bits of code to share the same constant values. If for some reason the alloca couldn't be hoisted all of the way to the entry block of the function, moving the constant might result in it no-longer dominating some of the remaining uses. In theory, there should be dominance analysis to ensure the location of the constant does dominate all uses of it. But those constants are effectively free anyway (they aren't even separate instructions in LLVM IR), so it is less expensive just to leave the old one where it was and insert a new one we know for sure is immediately before the alloca. Full diff: https://github.com/llvm/llvm-project/pull/116251.diff 2 Files Affected:
diff --git a/flang/lib/Optimizer/CodeGen/CodeGen.cpp b/flang/lib/Optimizer/CodeGen/CodeGen.cpp
index d038efcb2eb42c..886ee6b6712772 100644
--- a/flang/lib/Optimizer/CodeGen/CodeGen.cpp
+++ b/flang/lib/Optimizer/CodeGen/CodeGen.cpp
@@ -278,7 +278,14 @@ struct AllocaOpConversion : public fir::FIROpConversion<fir::AllocaOp> {
mlir::Region *parentRegion = rewriter.getInsertionBlock()->getParent();
mlir::Block *insertBlock =
getBlockForAllocaInsert(parentOp, parentRegion);
- size.getDefiningOp()->moveBefore(&insertBlock->front());
+
+ // The old size might have had multiple users, some at a broader scope
+ // than we can safely outline the alloca to. As it is only an
+ // llvm.constant operation, it is faster to clone it than to calculate the
+ // dominance to see if it really should be moved.
+ mlir::Operation *clonedSize = rewriter.clone(*size.getDefiningOp());
+ size = clonedSize->getResult(0);
+ clonedSize->moveBefore(&insertBlock->front());
rewriter.setInsertionPointAfter(size.getDefiningOp());
}
diff --git a/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir b/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir
index 184abe24fe967d..353b76667e4194 100644
--- a/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir
+++ b/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir
@@ -1065,3 +1065,51 @@ func.func @omp_map_common_block_using_common_block_members() {
}
fir.global common @var_common_(dense<0> : vector<8xi8>) {alignment = 4 : i64} : !fir.array<8xi8>
+
+// -----
+
+
+func.func @use_string(%arg0 : !fir.ref<!fir.char<1,?>>) {
+ return
+}
+
+func.func @use_index(%arg0 : index) {
+ return
+}
+
+// CHECK-LABEL: llvm.func @alloca_hoisting_openmp() {
+// CHECK: %[[VAL_0:.*]] = llvm.mlir.constant(6 : index) : i64
+// CHECK: %[[VAL_1:.*]] = llvm.mlir.constant(1 : i32) : i32
+// CHECK: %[[VAL_2:.*]] = llvm.mlir.constant(42 : i32) : i32
+// CHECK: omp.parallel {
+// CHECK: %[[VAL_3:.*]] = llvm.mlir.constant(6 : index) : i64
+// CHECK: %[[VAL_4:.*]] = llvm.alloca %[[VAL_3]] x i8 : (i64) -> !llvm.ptr
+// CHECK: omp.wsloop {
+// CHECK: omp.loop_nest (%[[VAL_5:.*]]) : i32 = (%[[VAL_1]]) to (%[[VAL_2]]) inclusive step (%[[VAL_1]]) {
+// CHECK: %[[VAL_6:.*]] = llvm.mlir.constant(1 : i64) : i64
+// CHECK: llvm.call @use_string(%[[VAL_4]]) : (!llvm.ptr) -> ()
+// CHECK: omp.yield
+// CHECK: }
+// CHECK: }
+// CHECK: omp.terminator
+// CHECK: }
+// CHECK: llvm.call @use_index(%[[VAL_0]]) : (i64) -> ()
+// CHECK: llvm.return
+// CHECK: }
+func.func @alloca_hoisting_openmp() {
+ %c6 = arith.constant 6 : index
+ %c1_i32 = arith.constant 1 : i32
+ %c42_i32 = arith.constant 42 : i32
+ omp.parallel {
+ omp.wsloop {
+ omp.loop_nest (%arg0) : i32 = (%c1_i32) to (%c42_i32) inclusive step (%c1_i32) {
+ %0 = fir.alloca !fir.char<1,?>(%c6 : index)
+ fir.call @use_string(%0) : (!fir.ref<!fir.char<1,?>>) -> ()
+ omp.yield
+ }
+ }
+ omp.terminator
+ }
+ fir.call @use_index(%c6) : (index) -> ()
+ return
+}
|
Member
|
@llvm/pr-subscribers-flang-openmp Author: Tom Eccles (tblah) ChangesWhen hoisting the allocas with a constant integer size, the constant integer was moved to where the alloca is hoisted to unconditionally. By CodeGen there have been various iterations of mlir canonicalization and dead code elimination. This can cause lots of unrelated bits of code to share the same constant values. If for some reason the alloca couldn't be hoisted all of the way to the entry block of the function, moving the constant might result in it no-longer dominating some of the remaining uses. In theory, there should be dominance analysis to ensure the location of the constant does dominate all uses of it. But those constants are effectively free anyway (they aren't even separate instructions in LLVM IR), so it is less expensive just to leave the old one where it was and insert a new one we know for sure is immediately before the alloca. Full diff: https://github.com/llvm/llvm-project/pull/116251.diff 2 Files Affected:
diff --git a/flang/lib/Optimizer/CodeGen/CodeGen.cpp b/flang/lib/Optimizer/CodeGen/CodeGen.cpp
index d038efcb2eb42c..886ee6b6712772 100644
--- a/flang/lib/Optimizer/CodeGen/CodeGen.cpp
+++ b/flang/lib/Optimizer/CodeGen/CodeGen.cpp
@@ -278,7 +278,14 @@ struct AllocaOpConversion : public fir::FIROpConversion<fir::AllocaOp> {
mlir::Region *parentRegion = rewriter.getInsertionBlock()->getParent();
mlir::Block *insertBlock =
getBlockForAllocaInsert(parentOp, parentRegion);
- size.getDefiningOp()->moveBefore(&insertBlock->front());
+
+ // The old size might have had multiple users, some at a broader scope
+ // than we can safely outline the alloca to. As it is only an
+ // llvm.constant operation, it is faster to clone it than to calculate the
+ // dominance to see if it really should be moved.
+ mlir::Operation *clonedSize = rewriter.clone(*size.getDefiningOp());
+ size = clonedSize->getResult(0);
+ clonedSize->moveBefore(&insertBlock->front());
rewriter.setInsertionPointAfter(size.getDefiningOp());
}
diff --git a/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir b/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir
index 184abe24fe967d..353b76667e4194 100644
--- a/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir
+++ b/flang/test/Fir/convert-to-llvm-openmp-and-fir.fir
@@ -1065,3 +1065,51 @@ func.func @omp_map_common_block_using_common_block_members() {
}
fir.global common @var_common_(dense<0> : vector<8xi8>) {alignment = 4 : i64} : !fir.array<8xi8>
+
+// -----
+
+
+func.func @use_string(%arg0 : !fir.ref<!fir.char<1,?>>) {
+ return
+}
+
+func.func @use_index(%arg0 : index) {
+ return
+}
+
+// CHECK-LABEL: llvm.func @alloca_hoisting_openmp() {
+// CHECK: %[[VAL_0:.*]] = llvm.mlir.constant(6 : index) : i64
+// CHECK: %[[VAL_1:.*]] = llvm.mlir.constant(1 : i32) : i32
+// CHECK: %[[VAL_2:.*]] = llvm.mlir.constant(42 : i32) : i32
+// CHECK: omp.parallel {
+// CHECK: %[[VAL_3:.*]] = llvm.mlir.constant(6 : index) : i64
+// CHECK: %[[VAL_4:.*]] = llvm.alloca %[[VAL_3]] x i8 : (i64) -> !llvm.ptr
+// CHECK: omp.wsloop {
+// CHECK: omp.loop_nest (%[[VAL_5:.*]]) : i32 = (%[[VAL_1]]) to (%[[VAL_2]]) inclusive step (%[[VAL_1]]) {
+// CHECK: %[[VAL_6:.*]] = llvm.mlir.constant(1 : i64) : i64
+// CHECK: llvm.call @use_string(%[[VAL_4]]) : (!llvm.ptr) -> ()
+// CHECK: omp.yield
+// CHECK: }
+// CHECK: }
+// CHECK: omp.terminator
+// CHECK: }
+// CHECK: llvm.call @use_index(%[[VAL_0]]) : (i64) -> ()
+// CHECK: llvm.return
+// CHECK: }
+func.func @alloca_hoisting_openmp() {
+ %c6 = arith.constant 6 : index
+ %c1_i32 = arith.constant 1 : i32
+ %c42_i32 = arith.constant 42 : i32
+ omp.parallel {
+ omp.wsloop {
+ omp.loop_nest (%arg0) : i32 = (%c1_i32) to (%c42_i32) inclusive step (%c1_i32) {
+ %0 = fir.alloca !fir.char<1,?>(%c6 : index)
+ fir.call @use_string(%0) : (!fir.ref<!fir.char<1,?>>) -> ()
+ omp.yield
+ }
+ }
+ omp.terminator
+ }
+ fir.call @use_index(%c6) : (index) -> ()
+ return
+}
|
VijayKandiah
approved these changes
Nov 14, 2024
Contributor
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When hoisting the allocas with a constant integer size, the constant integer was moved to where the alloca is hoisted to unconditionally.
By CodeGen there have been various iterations of mlir canonicalization and dead code elimination. This can cause lots of unrelated bits of code to share the same constant values. If for some reason the alloca couldn't be hoisted all of the way to the entry block of the function, moving the constant might result in it no-longer dominating some of the remaining uses.
In theory, there should be dominance analysis to ensure the location of the constant does dominate all uses of it. But those constants are effectively free anyway (they aren't even separate instructions in LLVM IR), so it is less expensive just to leave the old one where it was and insert a new one we know for sure is immediately before the alloca.