Skip to content

Commit e887f82

Browse files
LancernLancern
authored
[mlir][LLVM] Add !invariant.group metadata to llvm.load and llvm.store (#115723)
This patch adds support for the `!invariant.group` metadata to the `llvm.load` and the `llvm.store` operation.
1 parent 37143fe commit e887f82

File tree

6 files changed

+77
-5
lines changed

6 files changed

+77
-5
lines changed

‎mlir/include/mlir/Dialect/LLVMIR/LLVMOpBase.td‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,13 @@ class LLVM_MemOpPatterns {
229229
inst->setMetadata(llvm::LLVMContext::MD_nontemporal, metadata);
230230
}
231231
}];
232+
code setInvariantGroupCode = [{
233+
if ($invariantGroup) {
234+
llvm::MDNode *metadata = llvm::MDNode::get(inst->getContext(),
235+
std::nullopt);
236+
inst->setMetadata(llvm::LLVMContext::MD_invariant_group, metadata);
237+
}
238+
}];
232239
code setAccessGroupsMetadataCode = [{
233240
moduleTranslation.setAccessGroupsMetadata(op, inst);
234241
}];

‎mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,7 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
350350
UnitAttr:$volatile_,
351351
UnitAttr:$nontemporal,
352352
UnitAttr:$invariant,
353+
UnitAttr:$invariantGroup,
353354
DefaultValuedAttr<
354355
AtomicOrdering, "AtomicOrdering::not_atomic">:$ordering,
355356
OptionalAttr<StrAttr>:$syncscope);
@@ -385,6 +386,7 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
385386
(`volatile` $volatile_^)? $addr
386387
(`atomic` (`syncscope` `(` $syncscope^ `)`)? $ordering^)?
387388
(`invariant` $invariant^)?
389+
(`invariant_group` $invariantGroup^)?
388390
attr-dict `:` qualified(type($addr)) `->` type($res)
389391
}];
390392
string llvmBuilder = [{
@@ -398,6 +400,7 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
398400
# setSyncScopeCode
399401
# setAlignmentCode
400402
# setNonTemporalMetadataCode
403+
# setInvariantGroupCode
401404
# setAccessGroupsMetadataCode
402405
# setAliasAnalysisMetadataCode;
403406
string mlirBuilder = [{
@@ -407,13 +410,15 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
407410
alignment, loadInst->isVolatile(),
408411
loadInst->hasMetadata(llvm::LLVMContext::MD_nontemporal),
409412
loadInst->hasMetadata(llvm::LLVMContext::MD_invariant_load),
413+
loadInst->hasMetadata(llvm::LLVMContext::MD_invariant_group),
410414
convertAtomicOrderingFromLLVM(loadInst->getOrdering()),
411415
getLLVMSyncScope(loadInst));
412416
}];
413417
let builders = [
414418
OpBuilder<(ins "Type":$type, "Value":$addr,
415419
CArg<"unsigned", "0">:$alignment, CArg<"bool", "false">:$isVolatile,
416420
CArg<"bool", "false">:$isNonTemporal, CArg<"bool", "false">:$isInvariant,
421+
CArg<"bool", "false">:$isInvariantGroup,
417422
CArg<"AtomicOrdering", "AtomicOrdering::not_atomic">:$ordering,
418423
CArg<"StringRef", "StringRef()">:$syncscope)>
419424
];
@@ -430,6 +435,7 @@ def LLVM_StoreOp : LLVM_MemAccessOpBase<"store",
430435
OptionalAttr<I64Attr>:$alignment,
431436
UnitAttr:$volatile_,
432437
UnitAttr:$nontemporal,
438+
UnitAttr:$invariantGroup,
433439
DefaultValuedAttr<
434440
AtomicOrdering, "AtomicOrdering::not_atomic">:$ordering,
435441
OptionalAttr<StrAttr>:$syncscope);
@@ -463,6 +469,7 @@ def LLVM_StoreOp : LLVM_MemAccessOpBase<"store",
463469
let assemblyFormat = [{
464470
(`volatile` $volatile_^)? $value `,` $addr
465471
(`atomic` (`syncscope` `(` $syncscope^ `)`)? $ordering^)?
472+
(`invariant_group` $invariantGroup^)?
466473
attr-dict `:` type($value) `,` qualified(type($addr))
467474
}];
468475
string llvmBuilder = [{
@@ -471,6 +478,7 @@ def LLVM_StoreOp : LLVM_MemAccessOpBase<"store",
471478
# setSyncScopeCode
472479
# setAlignmentCode
473480
# setNonTemporalMetadataCode
481+
# setInvariantGroupCode
474482
# setAccessGroupsMetadataCode
475483
# setAliasAnalysisMetadataCode;
476484
string mlirBuilder = [{
@@ -479,13 +487,15 @@ def LLVM_StoreOp : LLVM_MemAccessOpBase<"store",
479487
$_op = $_builder.create<LLVM::StoreOp>($_location, $value, $addr,
480488
alignment, storeInst->isVolatile(),
481489
storeInst->hasMetadata(llvm::LLVMContext::MD_nontemporal),
490+
storeInst->hasMetadata(llvm::LLVMContext::MD_invariant_group),
482491
convertAtomicOrderingFromLLVM(storeInst->getOrdering()),
483492
getLLVMSyncScope(storeInst));
484493
}];
485494
let builders = [
486495
OpBuilder<(ins "Value":$value, "Value":$addr,
487496
CArg<"unsigned", "0">:$alignment, CArg<"bool", "false">:$isVolatile,
488497
CArg<"bool", "false">:$isNonTemporal,
498+
CArg<"bool", "false">:$isInvariantGroup,
489499
CArg<"AtomicOrdering", "AtomicOrdering::not_atomic">:$ordering,
490500
CArg<"StringRef", "StringRef()">:$syncscope)>
491501
];

‎mlir/lib/Dialect/LLVMIR/IR/LLVMDialect.cpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -944,11 +944,11 @@ LogicalResult LoadOp::verify() {
944944

945945
void LoadOp::build(OpBuilder &builder, OperationState &state, Type type,
946946
Value addr, unsigned alignment, bool isVolatile,
947-
bool isNonTemporal, bool isInvariant,
947+
bool isNonTemporal, bool isInvariant, bool isInvariantGroup,
948948
AtomicOrdering ordering, StringRef syncscope) {
949949
build(builder, state, type, addr,
950950
alignment ? builder.getI64IntegerAttr(alignment) : nullptr, isVolatile,
951-
isNonTemporal, isInvariant, ordering,
951+
isNonTemporal, isInvariant, isInvariantGroup, ordering,
952952
syncscope.empty() ? nullptr : builder.getStringAttr(syncscope),
953953
/*access_groups=*/nullptr,
954954
/*alias_scopes=*/nullptr, /*noalias_scopes=*/nullptr,
@@ -983,11 +983,11 @@ LogicalResult StoreOp::verify() {
983983

984984
void StoreOp::build(OpBuilder &builder, OperationState &state, Value value,
985985
Value addr, unsigned alignment, bool isVolatile,
986-
bool isNonTemporal, AtomicOrdering ordering,
987-
StringRef syncscope) {
986+
bool isNonTemporal, bool isInvariantGroup,
987+
AtomicOrdering ordering, StringRef syncscope) {
988988
build(builder, state, value, addr,
989989
alignment ? builder.getI64IntegerAttr(alignment) : nullptr, isVolatile,
990-
isNonTemporal, ordering,
990+
isNonTemporal, isInvariantGroup, ordering,
991991
syncscope.empty() ? nullptr : builder.getStringAttr(syncscope),
992992
/*access_groups=*/nullptr,
993993
/*alias_scopes=*/nullptr, /*noalias_scopes=*/nullptr, /*tbaa=*/nullptr);

‎mlir/test/Dialect/LLVMIR/roundtrip.mlir‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,20 @@ func.func @invariant_load(%ptr : !llvm.ptr) -> i32 {
486486
func.return %0 : i32
487487
}
488488

489+
// CHECK-LABEL: @invariant_group_load
490+
func.func @invariant_group_load(%ptr : !llvm.ptr) -> i32 {
491+
// CHECK: llvm.load %{{.+}} invariant_group {alignment = 4 : i64} : !llvm.ptr -> i32
492+
%0 = llvm.load %ptr invariant_group {alignment = 4 : i64} : !llvm.ptr -> i32
493+
func.return %0 : i32
494+
}
495+
496+
// CHECK-LABEL: @invariant_group_store
497+
func.func @invariant_group_store(%val: i32, %ptr : !llvm.ptr) {
498+
// CHECK: llvm.store %{{.+}}, %{{.+}} invariant_group : i32, !llvm.ptr
499+
llvm.store %val, %ptr invariant_group : i32, !llvm.ptr
500+
func.return
501+
}
502+
489503
llvm.mlir.global external constant @_ZTIi() : !llvm.ptr
490504
llvm.func @bar(!llvm.ptr, !llvm.ptr, !llvm.ptr)
491505
llvm.func @__gxx_personality_v0(...) -> i32

‎mlir/test/Target/LLVMIR/Import/instructions.ll‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,33 @@ define float @invariant_load(ptr %ptr) {
383383

384384
; // -----
385385

386+
; CHECK-LABEL: @invariant_group_load
387+
; CHECK-SAME: %[[PTR:[a-zA-Z0-9]+]]
388+
define float @invariant_group_load(ptr %ptr) {
389+
; CHECK: %[[VAL:.+]] = llvm.load %[[PTR]] invariant_group {alignment = 4 : i64} : !llvm.ptr -> f32
390+
%1 = load float, ptr %ptr, align 4, !invariant.group !0
391+
; CHECK: llvm.return %[[VAL]]
392+
ret float %1
393+
}
394+
395+
!0 = !{}
396+
397+
; // -----
398+
399+
; CHECK-LABEL: @invariant_group_store
400+
; CHECK-SAME: %[[VAL:[a-zA-Z0-9]+]]
401+
; CHECK-SAME: %[[PTR:[a-zA-Z0-9]+]]
402+
define void @invariant_group_store(float %val, ptr %ptr) {
403+
; CHECK: llvm.store %[[VAL]], %[[PTR]] invariant_group {alignment = 4 : i64} : f32, !llvm.ptr
404+
store float %val, ptr %ptr, align 4, !invariant.group !0
405+
; CHECK: llvm.return
406+
ret void
407+
}
408+
409+
!0 = !{}
410+
411+
; // -----
412+
386413
; CHECK-LABEL: @atomic_load_store
387414
; CHECK-SAME: %[[PTR:[a-zA-Z0-9]+]]
388415
define void @atomic_load_store(ptr %ptr) {

‎mlir/test/Target/LLVMIR/llvmir.mlir‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1967,6 +1967,20 @@ llvm.func @nontemporal_store_and_load(%ptr : !llvm.ptr) -> i32 {
19671967

19681968
// -----
19691969

1970+
// Check that invariant group attribute is exported as metadata node.
1971+
llvm.func @nontemporal_store_and_load(%ptr : !llvm.ptr) -> i32 {
1972+
%val = llvm.mlir.constant(42 : i32) : i32
1973+
// CHECK: store i32 42, ptr %{{.*}} !invariant.group ![[NODE:[0-9]+]]
1974+
llvm.store %val, %ptr invariant_group : i32, !llvm.ptr
1975+
// CHECK: %{{.*}} = load i32, ptr %{{.*}} !invariant.group ![[NODE]]
1976+
%1 = llvm.load %ptr invariant_group : !llvm.ptr -> i32
1977+
llvm.return %1 : i32
1978+
}
1979+
1980+
// CHECK: ![[NODE]] = !{}
1981+
1982+
// -----
1983+
19701984
llvm.func @atomic_store_and_load(%ptr : !llvm.ptr) {
19711985
// CHECK: load atomic
19721986
// CHECK-SAME: acquire, align 4

0 commit comments

Comments
 (0)