Skip to content

Commit 59ce97b

Browse files
LancernLancern
committed
[mlir][LLVM] Add !invariant.group metadata to llvm.load and llvm.store
This patch adds support for the `!invariant.group` metadata to the `llvm.load` and the `llvm.store` operation.
1 parent 89aaf2c commit 59ce97b

File tree

5 files changed

+76
-5
lines changed

5 files changed

+76
-5
lines changed

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,7 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
351351
UnitAttr:$volatile_,
352352
UnitAttr:$nontemporal,
353353
UnitAttr:$invariant,
354+
UnitAttr:$invariantGroup,
354355
DefaultValuedAttr<
355356
AtomicOrdering, "AtomicOrdering::not_atomic">:$ordering,
356357
OptionalAttr<StrAttr>:$syncscope);
@@ -386,6 +387,7 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
386387
(`volatile` $volatile_^)? $addr
387388
(`atomic` (`syncscope` `(` $syncscope^ `)`)? $ordering^)?
388389
(`invariant` $invariant^)?
390+
(`invariant_group` $invariantGroup^)?
389391
attr-dict `:` qualified(type($addr)) `->` type($res)
390392
}];
391393
string llvmBuilder = [{
@@ -395,6 +397,10 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
395397
llvm::MDNode *metadata = llvm::MDNode::get(inst->getContext(), std::nullopt);
396398
inst->setMetadata(llvm::LLVMContext::MD_invariant_load, metadata);
397399
}
400+
if ($invariantGroup) {
401+
llvm::MDNode *metadata = llvm::MDNode::get(inst->getContext(), std::nullopt);
402+
inst->setMetadata(llvm::LLVMContext::MD_invariant_group, metadata);
403+
}
398404
}] # setOrderingCode
399405
# setSyncScopeCode
400406
# setAlignmentCode
@@ -408,13 +414,15 @@ def LLVM_LoadOp : LLVM_MemAccessOpBase<"load",
408414
alignment, loadInst->isVolatile(),
409415
loadInst->hasMetadata(llvm::LLVMContext::MD_nontemporal),
410416
loadInst->hasMetadata(llvm::LLVMContext::MD_invariant_load),
417+
loadInst->hasMetadata(llvm::LLVMContext::MD_invariant_group),
411418
convertAtomicOrderingFromLLVM(loadInst->getOrdering()),
412419
getLLVMSyncScope(loadInst));
413420
}];
414421
let builders = [
415422
OpBuilder<(ins "Type":$type, "Value":$addr,
416423
CArg<"unsigned", "0">:$alignment, CArg<"bool", "false">:$isVolatile,
417424
CArg<"bool", "false">:$isNonTemporal, CArg<"bool", "false">:$isInvariant,
425+
CArg<"bool", "false">:$isInvariantGroup,
418426
CArg<"AtomicOrdering", "AtomicOrdering::not_atomic">:$ordering,
419427
CArg<"StringRef", "StringRef()">:$syncscope)>
420428
];
@@ -431,6 +439,7 @@ def LLVM_StoreOp : LLVM_MemAccessOpBase<"store",
431439
OptionalAttr<I64Attr>:$alignment,
432440
UnitAttr:$volatile_,
433441
UnitAttr:$nontemporal,
442+
UnitAttr:$invariantGroup,
434443
DefaultValuedAttr<
435444
AtomicOrdering, "AtomicOrdering::not_atomic">:$ordering,
436445
OptionalAttr<StrAttr>:$syncscope);
@@ -464,10 +473,15 @@ def LLVM_StoreOp : LLVM_MemAccessOpBase<"store",
464473
let assemblyFormat = [{
465474
(`volatile` $volatile_^)? $value `,` $addr
466475
(`atomic` (`syncscope` `(` $syncscope^ `)`)? $ordering^)?
476+
(`invariant_group` $invariantGroup^)?
467477
attr-dict `:` type($value) `,` qualified(type($addr))
468478
}];
469479
string llvmBuilder = [{
470480
auto *inst = builder.CreateStore($value, $addr, $volatile_);
481+
if ($invariantGroup) {
482+
llvm::MDNode *metadata = llvm::MDNode::get(inst->getContext(), std::nullopt);
483+
inst->setMetadata(llvm::LLVMContext::MD_invariant_group, metadata);
484+
}
471485
}] # setOrderingCode
472486
# setSyncScopeCode
473487
# setAlignmentCode
@@ -480,13 +494,15 @@ def LLVM_StoreOp : LLVM_MemAccessOpBase<"store",
480494
$_op = $_builder.create<LLVM::StoreOp>($_location, $value, $addr,
481495
alignment, storeInst->isVolatile(),
482496
storeInst->hasMetadata(llvm::LLVMContext::MD_nontemporal),
497+
storeInst->hasMetadata(llvm::LLVMContext::MD_invariant_group),
483498
convertAtomicOrderingFromLLVM(storeInst->getOrdering()),
484499
getLLVMSyncScope(storeInst));
485500
}];
486501
let builders = [
487502
OpBuilder<(ins "Value":$value, "Value":$addr,
488503
CArg<"unsigned", "0">:$alignment, CArg<"bool", "false">:$isVolatile,
489504
CArg<"bool", "false">:$isNonTemporal,
505+
CArg<"bool", "false">:$isInvariantGroup,
490506
CArg<"AtomicOrdering", "AtomicOrdering::not_atomic">:$ordering,
491507
CArg<"StringRef", "StringRef()">:$syncscope)>
492508
];

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

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

953953
void LoadOp::build(OpBuilder &builder, OperationState &state, Type type,
954954
Value addr, unsigned alignment, bool isVolatile,
955-
bool isNonTemporal, bool isInvariant,
955+
bool isNonTemporal, bool isInvariant, bool isInvariantGroup,
956956
AtomicOrdering ordering, StringRef syncscope) {
957957
build(builder, state, type, addr,
958958
alignment ? builder.getI64IntegerAttr(alignment) : nullptr, isVolatile,
959-
isNonTemporal, isInvariant, ordering,
959+
isNonTemporal, isInvariant, isInvariantGroup, ordering,
960960
syncscope.empty() ? nullptr : builder.getStringAttr(syncscope),
961961
/*access_groups=*/nullptr,
962962
/*alias_scopes=*/nullptr, /*noalias_scopes=*/nullptr,
@@ -991,11 +991,11 @@ LogicalResult StoreOp::verify() {
991991

992992
void StoreOp::build(OpBuilder &builder, OperationState &state, Value value,
993993
Value addr, unsigned alignment, bool isVolatile,
994-
bool isNonTemporal, AtomicOrdering ordering,
995-
StringRef syncscope) {
994+
bool isNonTemporal, bool isInvariantGroup,
995+
AtomicOrdering ordering, StringRef syncscope) {
996996
build(builder, state, value, addr,
997997
alignment ? builder.getI64IntegerAttr(alignment) : nullptr, isVolatile,
998-
isNonTemporal, ordering,
998+
isNonTemporal, isInvariantGroup, ordering,
999999
syncscope.empty() ? nullptr : builder.getStringAttr(syncscope),
10001000
/*access_groups=*/nullptr,
10011001
/*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
@@ -469,6 +469,20 @@ func.func @invariant_load(%ptr : !llvm.ptr) -> i32 {
469469
func.return %0 : i32
470470
}
471471

472+
// CHECK-LABEL: @invariant_group_load
473+
func.func @invariant_group_load(%ptr : !llvm.ptr) -> i32 {
474+
// CHECK: llvm.load %{{.+}} invariant_group {alignment = 4 : i64} : !llvm.ptr -> i32
475+
%0 = llvm.load %ptr invariant_group {alignment = 4 : i64} : !llvm.ptr -> i32
476+
func.return %0 : i32
477+
}
478+
479+
// CHECK-LABEL: @invariant_group_store
480+
func.func @invariant_group_store(%val: i32, %ptr : !llvm.ptr) {
481+
// CHECK: llvm.store %{{.+}}, %{{.+}} invariant_group : i32, !llvm.ptr
482+
llvm.store %val, %ptr invariant_group : i32, !llvm.ptr
483+
func.return
484+
}
485+
472486
llvm.mlir.global external constant @_ZTIi() : !llvm.ptr
473487
llvm.func @bar(!llvm.ptr, !llvm.ptr, !llvm.ptr)
474488
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: %[[V:[0-9]+]] = 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 %[[V]]
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)