[llvm] [LV] Emit better debug and opt-report messages when vectorization is disallowed in the LoopVectorizer (PR #158513)
Tibor Győri via llvm-commits
llvm-commits at lists.llvm.org
Tue Sep 16 06:04:42 PDT 2025
https://github.com/TiborGY updated https://github.com/llvm/llvm-project/pull/158513
>From 81f1800118aab3462dbbd03023c2b052f7d455df Mon Sep 17 00:00:00 2001
From: GYT <tiborgyri at gmail.com>
Date: Sun, 14 Sep 2025 23:19:37 +0200
Subject: [PATCH 1/7] Emit better debug and opt-report messages when
vectorization is disallowed in the LoopVectorizer
formatting
formatting2
fix ;) vs. ); typos
formatting3
---
.../Vectorize/LoopVectorizationLegality.cpp | 35 ++++++++++++++++---
1 file changed, 31 insertions(+), 4 deletions(-)
diff --git a/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp b/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp
index ff35db14f7094..9010ca62aeee7 100644
--- a/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp
+++ b/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp
@@ -182,14 +182,41 @@ void LoopVectorizeHints::setAlreadyVectorized() {
bool LoopVectorizeHints::allowVectorization(
Function *F, Loop *L, bool VectorizeOnlyWhenForced) const {
if (getForce() == LoopVectorizeHints::FK_Disabled) {
- LLVM_DEBUG(dbgs() << "LV: Not vectorizing: #pragma vectorize disable.\n");
- emitRemarkWithHints();
+ if (Force.Value == LoopVectorizeHints::FK_Disabled) {
+ LLVM_DEBUG(dbgs() << "LV: Not vectorizing: #pragma vectorize disable.\n");
+ ORE.emit(OptimizationRemarkMissed(LV_NAME, "MissedExplicitlyDisabled",
+ TheLoop->getStartLoc(),
+ TheLoop->getHeader())
+ << "loop not vectorized: vectorization is explicitly disabled");
+ } else if (hasDisableAllTransformsHint(TheLoop)) {
+ LLVM_DEBUG(
+ dbgs() << "LV: Not vectorizing: loop hasDisableAllTransformsHint.\n");
+ ORE.emit(OptimizationRemarkMissed(LV_NAME, "MissedTrafoDisabled",
+ TheLoop->getStartLoc(),
+ TheLoop->getHeader())
+ << "loop not vectorized: loop transformations are disabled");
+ } else {
+ // This should be unreachable unless there is a bug.
+ LLVM_DEBUG(
+ dbgs() << "LV: [FIXME] Not vectorizing: loop vect disabled for "
+ "an unknown reason!\n");
+ ORE.emit(OptimizationRemarkMissed(LV_NAME, "MissedUnknown",
+ TheLoop->getStartLoc(),
+ TheLoop->getHeader())
+ << "loop not vectorized: unknown reason, please file a bug "
+ "report on the LLVM issue tracker");
+ }
return false;
}
if (VectorizeOnlyWhenForced && getForce() != LoopVectorizeHints::FK_Enabled) {
- LLVM_DEBUG(dbgs() << "LV: Not vectorizing: No #pragma vectorize enable.\n");
- emitRemarkWithHints();
+ LLVM_DEBUG(dbgs() << "LV: Not vectorizing: VectorizeOnlyWhenForced is set, "
+ "and no #pragma vectorize enable.\n");
+ ORE.emit(OptimizationRemarkMissed(LV_NAME, "MissedForceOnly",
+ TheLoop->getStartLoc(),
+ TheLoop->getHeader())
+ << "loop not vectorized: only vectorizing loops that "
+ "explicitly request it");
return false;
}
>From 6d941ff51d221e03a9d575086f4cec5efdf43dd2 Mon Sep 17 00:00:00 2001
From: GYT <tiborgyri at gmail.com>
Date: Mon, 15 Sep 2025 12:22:19 +0200
Subject: [PATCH 2/7] Trafo -> Transforms
---
llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp b/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp
index 9010ca62aeee7..2dbab7d485ec0 100644
--- a/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp
+++ b/llvm/lib/Transforms/Vectorize/LoopVectorizationLegality.cpp
@@ -191,7 +191,7 @@ bool LoopVectorizeHints::allowVectorization(
} else if (hasDisableAllTransformsHint(TheLoop)) {
LLVM_DEBUG(
dbgs() << "LV: Not vectorizing: loop hasDisableAllTransformsHint.\n");
- ORE.emit(OptimizationRemarkMissed(LV_NAME, "MissedTrafoDisabled",
+ ORE.emit(OptimizationRemarkMissed(LV_NAME, "MissedTransformsDisabled",
TheLoop->getStartLoc(),
TheLoop->getHeader())
<< "loop not vectorized: loop transformations are disabled");
>From c0e6aec88cd15bc307d7b9a63828ef4fb2cbe7bb Mon Sep 17 00:00:00 2001
From: GYT <tiborgyri at gmail.com>
Date: Mon, 15 Sep 2025 19:13:41 +0200
Subject: [PATCH 3/7] Testing part 1: explicitly disabled code path
---
.../check-disabled-vectorization-msgs.ll | 47 +++++++++++++++++++
1 file changed, 47 insertions(+)
create mode 100644 llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll
diff --git a/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll b/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll
new file mode 100644
index 0000000000000..be903d3ff61b8
--- /dev/null
+++ b/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll
@@ -0,0 +1,47 @@
+; This test checks that we emit only the correct debug message and
+; optimization remark when the loop vectorizer is disabled by loop metadata.
+
+; REQUIRES: asserts
+; RUN: opt -passes=loop-vectorize -pass-remarks=loop-vectorize \
+; RUN: -pass-remarks-missed=loop-vectorize \
+; RUN: -pass-remarks-analysis=loop-vectorize -debug -disable-output \
+; RUN: < %s 2>&1 | FileCheck %s
+; CHECK-NOT: LV: We can vectorize this loop
+; CHECK-NOT: LV: Not vectorizing: loop hasDisableAllTransformsHint
+; CHECK-NOT: LV: [FIXME] Not vectorizing: loop vect disabled for an unknown reason
+; CHECK-NOT: LV: Not vectorizing: VectorizeOnlyWhenForced is set
+; CHECK-NOT: LV: Not vectorizing: Disabled/already vectorized
+; CHECK-NOT: LV: Not vectorizing: Cannot prove legality
+; CHECK: LV: Loop hints: force=disabled
+; CHECK: LV: Not vectorizing: #pragma vectorize disable.
+; CHECK: remark:
+; CHECK-SAME: loop not vectorized: vectorization is explicitly disabled
+; CHECK: LV: Loop hints prevent vectorization
+
+define dso_local noundef nofpclass(nan inf) double @_Z15CompareDistmatsPKdS0_(ptr noundef readonly captures(none) %distmat1, ptr noundef readonly captures(none) %distmat2) local_unnamed_addr {
+entry:
+ br label %for.body
+
+for.cond.cleanup: ; preds = %for.body
+ %add.lcssa = phi double [ %add, %for.body ]
+ %div = fmul fast double %add.lcssa, 0x3FB1111111111111
+ %0 = tail call fast double @llvm.sqrt.f64(double %div)
+ ret double %0
+
+for.body: ; preds = %entry, %for.body
+ %i.014 = phi i64 [ 0, %entry ], [ %inc, %for.body ]
+ %RMSD.013 = phi double [ 0.000000e+00, %entry ], [ %add, %for.body ]
+ %arrayidx = getelementptr inbounds nuw double, ptr %distmat1, i64 %i.014
+ %1 = load double, ptr %arrayidx, align 8
+ %arrayidx1 = getelementptr inbounds nuw double, ptr %distmat2, i64 %i.014
+ %2 = load double, ptr %arrayidx1, align 8
+ %sub = fsub fast double %1, %2
+ %mul = fmul fast double %sub, %sub
+ %add = fadd fast double %mul, %RMSD.013
+ %inc = add nuw nsw i64 %i.014, 1
+ %exitcond.not = icmp eq i64 %inc, 15
+ br i1 %exitcond.not, label %for.cond.cleanup, label %for.body, !llvm.loop !0
+}
+
+!0 = distinct !{!0, !1}
+!1 = !{!"llvm.loop.vectorize.enable", i1 false}
\ No newline at end of file
>From c290becce4d3b7e1b1f7582fc2045621f63fc369 Mon Sep 17 00:00:00 2001
From: GYT <tiborgyri at gmail.com>
Date: Tue, 16 Sep 2025 01:19:25 +0200
Subject: [PATCH 4/7] Testing part 2: VectorizeOnlyWhenForced code path
---
.../check-disabled-vectorization-msgs.ll | 4 +-
.../check-vectorize-forced-only-msgs.ll | 46 +++++++++++++++++++
2 files changed, 48 insertions(+), 2 deletions(-)
create mode 100644 llvm/test/Transforms/LoopVectorize/check-vectorize-forced-only-msgs.ll
diff --git a/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll b/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll
index be903d3ff61b8..7ed1750d9d8d1 100644
--- a/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll
+++ b/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll
@@ -1,4 +1,4 @@
-; This test checks that we emit only the correct debug message and
+; This test checks that we emit only the correct debug messages and
; optimization remark when the loop vectorizer is disabled by loop metadata.
; REQUIRES: asserts
@@ -44,4 +44,4 @@ for.body: ; preds = %entry, %for.body
}
!0 = distinct !{!0, !1}
-!1 = !{!"llvm.loop.vectorize.enable", i1 false}
\ No newline at end of file
+!1 = !{!"llvm.loop.vectorize.enable", i1 false}
diff --git a/llvm/test/Transforms/LoopVectorize/check-vectorize-forced-only-msgs.ll b/llvm/test/Transforms/LoopVectorize/check-vectorize-forced-only-msgs.ll
new file mode 100644
index 0000000000000..18e398e2b0331
--- /dev/null
+++ b/llvm/test/Transforms/LoopVectorize/check-vectorize-forced-only-msgs.ll
@@ -0,0 +1,46 @@
+; This test checks that we emit only the correct debug messages and
+; optimization remark when the loop is not vectorized due to the
+; vectorize-forced-only pass option being set.
+
+; REQUIRES: asserts
+; RUN: opt -passes='loop-vectorize<vectorize-forced-only>' \
+; RUN: -pass-remarks=loop-vectorize \
+; RUN: -pass-remarks-missed=loop-vectorize \
+; RUN: -pass-remarks-analysis=loop-vectorize -debug -disable-output \
+; RUN: < %s 2>&1 | FileCheck %s
+; CHECK-NOT: LV: We can vectorize this loop
+; CHECK-NOT: LV: Not vectorizing: loop hasDisableAllTransformsHint
+; CHECK-NOT: LV: [FIXME] Not vectorizing: loop vect disabled for an unknown reason
+; CHECK-NOT: LV: Not vectorizing: #pragma vectorize disable
+; CHECK-NOT: LV: Not vectorizing: Disabled/already vectorized
+; CHECK-NOT: LV: Not vectorizing: Cannot prove legality
+; CHECK: LV: Loop hints: force=?
+; CHECK: LV: Not vectorizing: VectorizeOnlyWhenForced is set, and no #pragma vectorize enable
+; CHECK: remark:
+; CHECK-SAME: loop not vectorized: only vectorizing loops that explicitly request it
+; CHECK: LV: Loop hints prevent vectorization
+
+define dso_local noundef nofpclass(nan inf) double @_Z15CompareDistmatsPKdS0_(ptr noundef readonly captures(none) %distmat1, ptr noundef readonly captures(none) %distmat2) local_unnamed_addr {
+entry:
+ br label %for.body
+
+for.cond.cleanup: ; preds = %for.body
+ %add.lcssa = phi double [ %add, %for.body ]
+ %div = fmul fast double %add.lcssa, 0x3FB1111111111111
+ %0 = tail call fast double @llvm.sqrt.f64(double %div)
+ ret double %0
+
+for.body: ; preds = %entry, %for.body
+ %i.014 = phi i64 [ 0, %entry ], [ %inc, %for.body ]
+ %RMSD.013 = phi double [ 0.000000e+00, %entry ], [ %add, %for.body ]
+ %arrayidx = getelementptr inbounds nuw double, ptr %distmat1, i64 %i.014
+ %1 = load double, ptr %arrayidx, align 8
+ %arrayidx1 = getelementptr inbounds nuw double, ptr %distmat2, i64 %i.014
+ %2 = load double, ptr %arrayidx1, align 8
+ %sub = fsub fast double %1, %2
+ %mul = fmul fast double %sub, %sub
+ %add = fadd fast double %mul, %RMSD.013
+ %inc = add nuw nsw i64 %i.014, 1
+ %exitcond.not = icmp eq i64 %inc, 15
+ br i1 %exitcond.not, label %for.cond.cleanup, label %for.body
+}
>From 109b3fd0dabec169b693c7a9b80eba704531ae2a Mon Sep 17 00:00:00 2001
From: GYT <tiborgyri at gmail.com>
Date: Tue, 16 Sep 2025 14:31:37 +0200
Subject: [PATCH 5/7] Rename the two new tests so far to begin with diag-
---
...-vectorization-msgs.ll => diag-disabled-vectorization-msgs.ll} | 0
...ize-forced-only-msgs.ll => diag-vectorize-forced-only-msgs.ll} | 0
2 files changed, 0 insertions(+), 0 deletions(-)
rename llvm/test/Transforms/LoopVectorize/{check-disabled-vectorization-msgs.ll => diag-disabled-vectorization-msgs.ll} (100%)
rename llvm/test/Transforms/LoopVectorize/{check-vectorize-forced-only-msgs.ll => diag-vectorize-forced-only-msgs.ll} (100%)
diff --git a/llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll b/llvm/test/Transforms/LoopVectorize/diag-disabled-vectorization-msgs.ll
similarity index 100%
rename from llvm/test/Transforms/LoopVectorize/check-disabled-vectorization-msgs.ll
rename to llvm/test/Transforms/LoopVectorize/diag-disabled-vectorization-msgs.ll
diff --git a/llvm/test/Transforms/LoopVectorize/check-vectorize-forced-only-msgs.ll b/llvm/test/Transforms/LoopVectorize/diag-vectorize-forced-only-msgs.ll
similarity index 100%
rename from llvm/test/Transforms/LoopVectorize/check-vectorize-forced-only-msgs.ll
rename to llvm/test/Transforms/LoopVectorize/diag-vectorize-forced-only-msgs.ll
>From 3c4c8de8370e398d1b72c4b29e07e6c9a253f2bd Mon Sep 17 00:00:00 2001
From: GYT <tiborgyri at gmail.com>
Date: Tue, 16 Sep 2025 14:42:10 +0200
Subject: [PATCH 6/7] Testing part 3: hasDisableAllTransformsHint code path
---
.../diag-disable_nonforced-msgs.ll | 42 +++++++++++++++++++
1 file changed, 42 insertions(+)
create mode 100644 llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll
diff --git a/llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll b/llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll
new file mode 100644
index 0000000000000..1add46f951190
--- /dev/null
+++ b/llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll
@@ -0,0 +1,42 @@
+; This test checks that we emit only the correct debug messages and
+; optimization remark when the loop vectorizer is disabled by loop metadata
+; that requests no loop transformations.
+
+; REQUIRES: asserts
+; RUN: opt -passes=loop-vectorize -pass-remarks=loop-vectorize \
+; RUN: -pass-remarks-missed=loop-vectorize \
+; RUN: -pass-remarks-analysis=loop-vectorize -debug -disable-output \
+; RUN: -force-vector-interleave=1 -force-vector-width=2 \
+; RUN: < %s 2>&1 | FileCheck %s
+; CHECK-NOT: LV: We can vectorize this loop
+; CHECK-NOT: LV: Not vectorizing: #pragma vectorize disable.
+; CHECK-NOT: LV: [FIXME] Not vectorizing: loop vect disabled for an unknown reason
+; CHECK-NOT: LV: Not vectorizing: VectorizeOnlyWhenForced is set
+; CHECK-NOT: LV: Not vectorizing: Disabled/already vectorized
+; CHECK-NOT: LV: Not vectorizing: Cannot prove legality
+; CHECK: LV: Loop hints: force=disabled
+; CHECK: LV: Not vectorizing: loop hasDisableAllTransformsHint.
+; CHECK: remark:
+; CHECK-SAME: loop not vectorized: vectorization is explicitly disabled
+; CHECK: LV: Loop hints prevent vectorization
+target datalayout = "e-p:64:64:64-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:64-f32:32:32-f64:64:64-v64:64:64-v128:128:128-a0:0:64-s0:64:64-f80:128:128-n8:16:32:64-S128"
+define void @disable_nonforced(ptr nocapture %a, i32 %n) {
+entry:
+ %cmp4 = icmp sgt i32 %n, 0
+ br i1 %cmp4, label %for.body, label %for.end
+
+for.body:
+ %indvars.iv = phi i64 [ %indvars.iv.next, %for.body ], [ 0, %entry ]
+ %arrayidx = getelementptr inbounds i32, ptr %a, i64 %indvars.iv
+ %0 = trunc i64 %indvars.iv to i32
+ store i32 %0, ptr %arrayidx, align 4
+ %indvars.iv.next = add i64 %indvars.iv, 1
+ %lftr.wideiv = trunc i64 %indvars.iv.next to i32
+ %exitcond = icmp eq i32 %lftr.wideiv, %n
+ br i1 %exitcond, label %for.end, label %for.body, !llvm.loop !0
+
+for.end:
+ ret void
+}
+
+!0 = !{!0, !{!"llvm.loop.disable_nonforced"}}
>From fa19cccfe3fc524439cca5b2cc6444ba4b193f24 Mon Sep 17 00:00:00 2001
From: GYT <tiborgyri at gmail.com>
Date: Tue, 16 Sep 2025 15:04:27 +0200
Subject: [PATCH 7/7] fix test 3
---
.../Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll b/llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll
index 1add46f951190..df4905fd4595e 100644
--- a/llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll
+++ b/llvm/test/Transforms/LoopVectorize/diag-disable_nonforced-msgs.ll
@@ -17,7 +17,7 @@
; CHECK: LV: Loop hints: force=disabled
; CHECK: LV: Not vectorizing: loop hasDisableAllTransformsHint.
; CHECK: remark:
-; CHECK-SAME: loop not vectorized: vectorization is explicitly disabled
+; CHECK-SAME: loop not vectorized: loop transformations are disabled
; CHECK: LV: Loop hints prevent vectorization
target datalayout = "e-p:64:64:64-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:64-f32:32:32-f64:64:64-v64:64:64-v128:128:128-a0:0:64-s0:64:64-f80:128:128-n8:16:32:64-S128"
define void @disable_nonforced(ptr nocapture %a, i32 %n) {
More information about the llvm-commits
mailing list