Skip to content

[mlir][memref] Add runtime verification for memref.atomic_rmw #130414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 30, 2025
+89 −0
Merged

[mlir][memref] Add runtime verification for memref.atomic_rmw #130414

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc034e0
[mlir][memref] Add runtime verification for `memref.atomic_rmw`
matthias-springer Mar 8, 2025
37749b6
address comments
matthias-springer Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions mlir/lib/Dialect/MemRef/Transforms/RuntimeOpVerification.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,10 +426,13 @@ void mlir::memref::registerRuntimeVerifiableOpInterfaceExternalModels(
DialectRegistry &registry) {
registry.addExtension(+[](MLIRContext *ctx, memref::MemRefDialect *dialect) {
AssumeAlignmentOp::attachInterface<AssumeAlignmentOpInterface>(*ctx);
AtomicRMWOp::attachInterface<LoadStoreOpInterface<AtomicRMWOp>>(*ctx);
CastOp::attachInterface<CastOpInterface>(*ctx);
CopyOp::attachInterface<CopyOpInterface>(*ctx);
DimOp::attachInterface<DimOpInterface>(*ctx);
ExpandShapeOp::attachInterface<ExpandShapeOpInterface>(*ctx);
GenericAtomicRMWOp::attachInterface<
LoadStoreOpInterface<GenericAtomicRMWOp>>(*ctx);
LoadOp::attachInterface<LoadStoreOpInterface<LoadOp>>(*ctx);
ReinterpretCastOp::attachInterface<ReinterpretCastOpInterface>(*ctx);
StoreOp::attachInterface<LoadStoreOpInterface<StoreOp>>(*ctx);
Expand Down
45 changes: 45 additions & 0 deletions mlir/test/Integration/Dialect/MemRef/atomic-rmw-runtime-verification.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// RUN: mlir-opt %s -generate-runtime-verification \
// RUN: -test-cf-assert \
// RUN: -expand-strided-metadata \
// RUN: -lower-affine \
// RUN: -convert-to-llvm | \
// RUN: mlir-runner -e main -entry-point-result=void \
// RUN: -shared-libs=%mlir_runner_utils 2>&1 | \
// RUN: FileCheck %s

func.func @store_dynamic(%memref: memref<?xf32>, %index: index) {
%cst = arith.constant 1.0 : f32
memref.atomic_rmw addf %cst, %memref[%index] : (f32, memref<?xf32>) -> f32
return
}

func.func @main() {
// Allocate a memref<10xf32>, but disguise it as a memref<5xf32>. This is
// necessary because "-test-cf-assert" does not abort the program and we do
// not want to segfault when running the test case.
%alloc = memref.alloca() : memref<10xf32>
%ptr = memref.extract_aligned_pointer_as_index %alloc : memref<10xf32> -> index
%ptr_i64 = arith.index_cast %ptr : index to i64
%ptr_llvm = llvm.inttoptr %ptr_i64 : i64 to !llvm.ptr
%c0 = llvm.mlir.constant(0 : index) : i64
%c1 = llvm.mlir.constant(1 : index) : i64
%c5 = llvm.mlir.constant(5 : index) : i64
%4 = llvm.mlir.poison : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%5 = llvm.insertvalue %ptr_llvm, %4[0] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%6 = llvm.insertvalue %ptr_llvm, %5[1] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%8 = llvm.insertvalue %c0, %6[2] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%9 = llvm.insertvalue %c5, %8[3, 0] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%10 = llvm.insertvalue %c1, %9[4, 0] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%buffer = builtin.unrealized_conversion_cast %10 : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)> to memref<5xf32>
%cast = memref.cast %buffer : memref<5xf32> to memref<?xf32>

// CHECK: ERROR: Runtime op verification failed
// CHECK-NEXT: "memref.atomic_rmw"(%{{.*}}, %{{.*}}, %{{.*}}) <{kind = 0 : i64}> : (f32, memref<?xf32>, index) -> f32
// CHECK-NEXT: ^ out-of-bounds access
// CHECK-NEXT: Location: loc({{.*}})
%c9 = arith.constant 9 : index
func.call @store_dynamic(%cast, %c9) : (memref<?xf32>, index) -> ()

return
}

45 changes: 45 additions & 0 deletions mlir/test/Integration/Dialect/MemRef/store-runtime-verification.mlir
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// RUN: mlir-opt %s -generate-runtime-verification \
// RUN: -test-cf-assert \
// RUN: -expand-strided-metadata \
// RUN: -lower-affine \
// RUN: -convert-to-llvm | \
// RUN: mlir-runner -e main -entry-point-result=void \
// RUN: -shared-libs=%mlir_runner_utils 2>&1 | \
// RUN: FileCheck %s

func.func @store_dynamic(%memref: memref<?xf32>, %index: index) {
%cst = arith.constant 1.0 : f32
memref.store %cst, %memref[%index] : memref<?xf32>
return
}

func.func @main() {
// Allocate a memref<10xf32>, but disguise it as a memref<5xf32>. This is
// necessary because "-test-cf-assert" does not abort the program and we do
// not want to segfault when running the test case.
%alloc = memref.alloca() : memref<10xf32>
%ptr = memref.extract_aligned_pointer_as_index %alloc : memref<10xf32> -> index
%ptr_i64 = arith.index_cast %ptr : index to i64
%ptr_llvm = llvm.inttoptr %ptr_i64 : i64 to !llvm.ptr
%c0 = llvm.mlir.constant(0 : index) : i64
%c1 = llvm.mlir.constant(1 : index) : i64
%c5 = llvm.mlir.constant(5 : index) : i64
%4 = llvm.mlir.poison : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%5 = llvm.insertvalue %ptr_llvm, %4[0] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%6 = llvm.insertvalue %ptr_llvm, %5[1] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%8 = llvm.insertvalue %c0, %6[2] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%9 = llvm.insertvalue %c5, %8[3, 0] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%10 = llvm.insertvalue %c1, %9[4, 0] : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)>
%buffer = builtin.unrealized_conversion_cast %10 : !llvm.struct<(ptr, ptr, i64, array<1 x i64>, array<1 x i64>)> to memref<5xf32>
%cast = memref.cast %buffer : memref<5xf32> to memref<?xf32>

// CHECK: ERROR: Runtime op verification failed
// CHECK-NEXT: "memref.store"(%{{.*}}, %{{.*}}, %{{.*}}) : (f32, memref<?xf32>, index) -> ()
// CHECK-NEXT: ^ out-of-bounds access
// CHECK-NEXT: Location: loc({{.*}})
%c9 = arith.constant 9 : index
func.call @store_dynamic(%cast, %c9) : (memref<?xf32>, index) -> ()

return
}