[Mlir-commits] [mlir] 7b420a1 - [mlir][llvm] Add inbounds attriubte to the gep op.
Tobias Gysi
llvmlistbot at llvm.org
Wed Dec 14 01:50:34 PST 2022
Author: Tobias Gysi
Date: 2022-12-14T10:46:07+01:00
New Revision: 7b420a1ada0775b35c6600f58ac4d5775106a723
URL: https://github.com/llvm/llvm-project/commit/7b420a1ada0775b35c6600f58ac4d5775106a723
DIFF: https://github.com/llvm/llvm-project/commit/7b420a1ada0775b35c6600f58ac4d5775106a723.diff
LOG: [mlir][llvm] Add inbounds attriubte to the gep op.
The revision adds an inbounds attribute to the LLVM dialect
GEP operation. It extends the builders and the import and export
to support the optional inbounds attribute.
As all builders set inbounds to false by default, existing lowerings
from higher-level dialects to LLVM dialect are not affected by the
change. Canonicalization/folding remains untouched since it currently
does not implement any simplifications in case of undefined behavior
(the handling of undefined behavior is deferred to LLVM).
Reviewed By: ftynse
Differential Revision: https://reviews.llvm.org/D139821
Added:
Modified:
mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
mlir/lib/Dialect/LLVMIR/IR/LLVMDialect.cpp
mlir/lib/Target/LLVMIR/ConvertFromLLVMIR.cpp
mlir/test/Dialect/LLVMIR/canonicalize.mlir
mlir/test/Dialect/LLVMIR/roundtrip.mlir
mlir/test/Target/LLVMIR/Import/instructions.ll
mlir/test/Target/LLVMIR/Import/opaque.ll
mlir/test/Target/LLVMIR/llvmir.mlir
Removed:
################################################################################
diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
index 6e63a512a1bfb..4abd193c1d16e 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
@@ -257,7 +257,8 @@ def LLVM_GEPOp : LLVM_Op<"getelementptr", [Pure]> {
let arguments = (ins LLVM_ScalarOrVectorOf<LLVM_AnyPointer>:$base,
Variadic<LLVM_ScalarOrVectorOf<AnyInteger>>:$dynamicIndices,
DenseI32ArrayAttr:$rawConstantIndices,
- OptionalAttr<TypeAttr>:$elem_type);
+ OptionalAttr<TypeAttr>:$elem_type,
+ UnitAttr:$inbounds);
let results = (outs LLVM_ScalarOrVectorOf<LLVM_AnyPointer>:$res);
let skipDefaultBuilders = 1;
@@ -269,14 +270,17 @@ def LLVM_GEPOp : LLVM_Op<"getelementptr", [Pure]> {
as indices. In the case of indexing within a structure, it is required to
either use constant indices directly, or supply a constant SSA value.
+ An optional 'inbounds' attribute specifies the low-level pointer arithmetic
+ overflow behavior that LLVM uses after lowering the operation to LLVM IR.
+
Examples:
```mlir
// GEP with an SSA value offset
%0 = llvm.getelementptr %1[%2] : (!llvm.ptr<f32>, i64) -> !llvm.ptr<f32>
- // GEP with a constant offset
- %0 = llvm.getelementptr %1[3] : (!llvm.ptr<f32>) -> !llvm.ptr<f32>
+ // GEP with a constant offset and the inbounds attribute set
+ %0 = llvm.getelementptr inbounds %1[3] : (!llvm.ptr<f32>) -> !llvm.ptr<f32>
// GEP with constant offsets into a structure
%0 = llvm.getelementptr %1[0, 1]
@@ -286,14 +290,16 @@ def LLVM_GEPOp : LLVM_Op<"getelementptr", [Pure]> {
let builders = [
OpBuilder<(ins "Type":$resultType, "Type":$basePtrType, "Value":$basePtr,
- "ValueRange":$indices,
+ "ValueRange":$indices, CArg<"bool", "false">:$inbounds,
CArg<"ArrayRef<NamedAttribute>", "{}">:$attributes)>,
- OpBuilder<(ins "Type":$resultType, "Value":$basePtr, "ValueRange":$indices,
+ OpBuilder<(ins "Type":$resultType, "Value":$basePtr,
+ "ValueRange":$indices, CArg<"bool", "false">:$inbounds,
CArg<"ArrayRef<NamedAttribute>", "{}">:$attributes)>,
- OpBuilder<(ins "Type":$resultType, "Value":$basePtr, "ArrayRef<GEPArg>":$indices,
+ OpBuilder<(ins "Type":$resultType, "Value":$basePtr,
+ "ArrayRef<GEPArg>":$indices, CArg<"bool", "false">:$inbounds,
CArg<"ArrayRef<NamedAttribute>", "{}">:$attributes)>,
OpBuilder<(ins "Type":$resultType, "Type":$basePtrType, "Value":$basePtr,
- "ArrayRef<GEPArg>":$indices,
+ "ArrayRef<GEPArg>":$indices, CArg<"bool", "false">:$inbounds,
CArg<"ArrayRef<NamedAttribute>", "{}">:$attributes)>,
];
let llvmBuilder = [{
@@ -310,9 +316,10 @@ def LLVM_GEPOp : LLVM_Op<"getelementptr", [Pure]> {
}
Type baseElementType = op.getSourceElementType();
llvm::Type *elementType = moduleTranslation.convertType(baseElementType);
- $res = builder.CreateGEP(elementType, $base, indices);
+ $res = builder.CreateGEP(elementType, $base, indices, "", $inbounds);
}];
let assemblyFormat = [{
+ (`inbounds` $inbounds^)?
$base `[` custom<GEPIndices>($dynamicIndices, $rawConstantIndices) `]` attr-dict
`:` functional-type(operands, results) (`,` $elem_type^)?
}];
diff --git a/mlir/lib/Dialect/LLVMIR/IR/LLVMDialect.cpp b/mlir/lib/Dialect/LLVMIR/IR/LLVMDialect.cpp
index 1afd98feeafb0..0694f9b68eaf7 100644
--- a/mlir/lib/Dialect/LLVMIR/IR/LLVMDialect.cpp
+++ b/mlir/lib/Dialect/LLVMIR/IR/LLVMDialect.cpp
@@ -418,7 +418,7 @@ static Type extractVectorElementType(Type type) {
}
void GEPOp::build(OpBuilder &builder, OperationState &result, Type resultType,
- Value basePtr, ArrayRef<GEPArg> indices,
+ Value basePtr, ArrayRef<GEPArg> indices, bool inbounds,
ArrayRef<NamedAttribute> attributes) {
auto ptrType =
extractVectorElementType(basePtr.getType()).cast<LLVMPointerType>();
@@ -426,7 +426,7 @@ void GEPOp::build(OpBuilder &builder, OperationState &result, Type resultType,
"expected non-opaque pointer, provide elementType explicitly when "
"opaque pointers are used");
build(builder, result, resultType, ptrType.getElementType(), basePtr, indices,
- attributes);
+ inbounds, attributes);
}
/// Destructures the 'indices' parameter into 'rawConstantIndices' and
@@ -481,7 +481,7 @@ static void destructureIndices(Type currType, ArrayRef<GEPArg> indices,
void GEPOp::build(OpBuilder &builder, OperationState &result, Type resultType,
Type elementType, Value basePtr, ArrayRef<GEPArg> indices,
- ArrayRef<NamedAttribute> attributes) {
+ bool inbounds, ArrayRef<NamedAttribute> attributes) {
SmallVector<int32_t> rawConstantIndices;
SmallVector<Value> dynamicIndices;
destructureIndices(elementType, indices, rawConstantIndices, dynamicIndices);
@@ -490,6 +490,10 @@ void GEPOp::build(OpBuilder &builder, OperationState &result, Type resultType,
result.addAttributes(attributes);
result.addAttribute(getRawConstantIndicesAttrName(result.name),
builder.getDenseI32ArrayAttr(rawConstantIndices));
+ if (inbounds) {
+ result.addAttribute(getInboundsAttrName(result.name),
+ builder.getUnitAttr());
+ }
if (extractVectorElementType(basePtr.getType())
.cast<LLVMPointerType>()
.isOpaque())
@@ -499,17 +503,17 @@ void GEPOp::build(OpBuilder &builder, OperationState &result, Type resultType,
}
void GEPOp::build(OpBuilder &builder, OperationState &result, Type resultType,
- Value basePtr, ValueRange indices,
+ Value basePtr, ValueRange indices, bool inbounds,
ArrayRef<NamedAttribute> attributes) {
build(builder, result, resultType, basePtr, SmallVector<GEPArg>(indices),
- attributes);
+ inbounds, attributes);
}
void GEPOp::build(OpBuilder &builder, OperationState &result, Type resultType,
Type elementType, Value basePtr, ValueRange indices,
- ArrayRef<NamedAttribute> attributes) {
+ bool inbounds, ArrayRef<NamedAttribute> attributes) {
build(builder, result, resultType, elementType, basePtr,
- SmallVector<GEPArg>(indices), attributes);
+ SmallVector<GEPArg>(indices), inbounds, attributes);
}
static ParseResult
diff --git a/mlir/lib/Target/LLVMIR/ConvertFromLLVMIR.cpp b/mlir/lib/Target/LLVMIR/ConvertFromLLVMIR.cpp
index ec9bde22e58f6..12d6238cdfadc 100644
--- a/mlir/lib/Target/LLVMIR/ConvertFromLLVMIR.cpp
+++ b/mlir/lib/Target/LLVMIR/ConvertFromLLVMIR.cpp
@@ -1085,7 +1085,6 @@ LogicalResult Importer::convertOperation(OpBuilder &odsBuilder,
return success();
}
if (inst->getOpcode() == llvm::Instruction::GetElementPtr) {
- // FIXME: Support inbounds GEPs.
auto *gepInst = cast<llvm::GetElementPtrInst>(inst);
Type sourceElementType = convertType(gepInst->getSourceElementType());
FailureOr<Value> basePtr = convertValue(gepInst->getOperand(0));
@@ -1105,8 +1104,9 @@ LogicalResult Importer::convertOperation(OpBuilder &odsBuilder,
}
Type type = convertType(inst->getType());
- Value res = builder.create<GEPOp>(loc, type, sourceElementType,
- basePtr.value(), indices);
+ Value res =
+ builder.create<GEPOp>(loc, type, sourceElementType, basePtr.value(),
+ indices, gepInst->isInBounds());
mapValue(inst, res);
return success();
}
@@ -1116,7 +1116,6 @@ LogicalResult Importer::convertOperation(OpBuilder &odsBuilder,
LogicalResult Importer::processInstruction(llvm::Instruction *inst) {
// FIXME: Support uses of SubtargetData.
- // FIXME: Add support for inbounds GEPs.
// FIXME: Add support for fast-math flags and call / operand attributes.
// FIXME: Add support for the indirectbr, cleanupret, catchret, catchswitch,
// callbr, vaarg, landingpad, catchpad, cleanuppad instructions.
diff --git a/mlir/test/Dialect/LLVMIR/canonicalize.mlir b/mlir/test/Dialect/LLVMIR/canonicalize.mlir
index 570226cb8dfd2..9432edaf20660 100644
--- a/mlir/test/Dialect/LLVMIR/canonicalize.mlir
+++ b/mlir/test/Dialect/LLVMIR/canonicalize.mlir
@@ -102,11 +102,11 @@ llvm.func @fold_gep(%x : !llvm.ptr<i8>) -> !llvm.ptr<i8> {
// CHECK-LABEL: fold_gep_neg
// CHECK-SAME: %[[a0:arg[0-9]+]]
-// CHECK-NEXT: %[[RES:.*]] = llvm.getelementptr %[[a0]][0, 1]
+// CHECK-NEXT: %[[RES:.*]] = llvm.getelementptr inbounds %[[a0]][0, 1]
// CHECK-NEXT: llvm.return %[[RES]]
llvm.func @fold_gep_neg(%x : !llvm.ptr) -> !llvm.ptr {
%c0 = arith.constant 0 : i32
- %0 = llvm.getelementptr %x[%c0, 1] : (!llvm.ptr, i32) -> !llvm.ptr, !llvm.struct<(i32, i32)>
+ %0 = llvm.getelementptr inbounds %x[%c0, 1] : (!llvm.ptr, i32) -> !llvm.ptr, !llvm.struct<(i32, i32)>
llvm.return %0 : !llvm.ptr
}
diff --git a/mlir/test/Dialect/LLVMIR/roundtrip.mlir b/mlir/test/Dialect/LLVMIR/roundtrip.mlir
index 884a53dd40cd1..515215bb308c0 100644
--- a/mlir/test/Dialect/LLVMIR/roundtrip.mlir
+++ b/mlir/test/Dialect/LLVMIR/roundtrip.mlir
@@ -184,8 +184,8 @@ llvm.func @gep(%ptr: !llvm.ptr<struct<(i32, struct<(i32, f32)>)>>, %idx: i64,
%ptr2: !llvm.ptr<struct<(array<10 x f32>)>>) {
// CHECK: llvm.getelementptr %{{.*}}[%{{.*}}, 1, 0] : (!llvm.ptr<struct<(i32, struct<(i32, f32)>)>>, i64) -> !llvm.ptr<i32>
llvm.getelementptr %ptr[%idx, 1, 0] : (!llvm.ptr<struct<(i32, struct<(i32, f32)>)>>, i64) -> !llvm.ptr<i32>
- // CHECK: llvm.getelementptr %{{.*}}[%{{.*}}, 0, %{{.*}}] : (!llvm.ptr<struct<(array<10 x f32>)>>, i64, i64) -> !llvm.ptr<f32>
- llvm.getelementptr %ptr2[%idx, 0, %idx] : (!llvm.ptr<struct<(array<10 x f32>)>>, i64, i64) -> !llvm.ptr<f32>
+ // CHECK: llvm.getelementptr inbounds %{{.*}}[%{{.*}}, 0, %{{.*}}] : (!llvm.ptr<struct<(array<10 x f32>)>>, i64, i64) -> !llvm.ptr<f32>
+ llvm.getelementptr inbounds %ptr2[%idx, 0, %idx] : (!llvm.ptr<struct<(array<10 x f32>)>>, i64, i64) -> !llvm.ptr<f32>
llvm.return
}
diff --git a/mlir/test/Target/LLVMIR/Import/instructions.ll b/mlir/test/Target/LLVMIR/Import/instructions.ll
index ad4a981c7a6a1..bd44c28d008c2 100644
--- a/mlir/test/Target/LLVMIR/Import/instructions.ll
+++ b/mlir/test/Target/LLVMIR/Import/instructions.ll
@@ -440,8 +440,8 @@ define void @call_fn_ptr(void (i16) *%fn) {
; CHECK-SAME: %[[PTR:[a-zA-Z0-9]+]]
define void @gep_static_idx(float* %ptr) {
; CHECK: %[[IDX:.+]] = llvm.mlir.constant(7 : i32)
- ; CHECK: llvm.getelementptr %[[PTR]][%[[IDX]]] : (!llvm.ptr<f32>, i32) -> !llvm.ptr<f32>
- %1 = getelementptr float, float* %ptr, i32 7
+ ; CHECK: llvm.getelementptr inbounds %[[PTR]][%[[IDX]]] : (!llvm.ptr<f32>, i32) -> !llvm.ptr<f32>
+ %1 = getelementptr inbounds float, float* %ptr, i32 7
ret void
}
diff --git a/mlir/test/Target/LLVMIR/Import/opaque.ll b/mlir/test/Target/LLVMIR/Import/opaque.ll
index f732697dc93a9..2d20b2c0b7711 100644
--- a/mlir/test/Target/LLVMIR/Import/opaque.ll
+++ b/mlir/test/Target/LLVMIR/Import/opaque.ll
@@ -38,8 +38,8 @@ define ptr @opaque_ptr_alloca(i32 %0) {
; CHECK-LABEL: @opaque_ptr_gep
define ptr @opaque_ptr_gep(ptr %0, i32 %1) {
- ; CHECK: = llvm.getelementptr %{{.*}}[%{{.*}}] : (!llvm.ptr, i32) -> !llvm.ptr, f32
- %3 = getelementptr float, ptr %0, i32 %1
+ ; CHECK: = llvm.getelementptr inbounds %{{.*}}[%{{.*}}] : (!llvm.ptr, i32) -> !llvm.ptr, f32
+ %3 = getelementptr inbounds float, ptr %0, i32 %1
ret ptr %3
}
diff --git a/mlir/test/Target/LLVMIR/llvmir.mlir b/mlir/test/Target/LLVMIR/llvmir.mlir
index c767d8ebfcc74..fd2bd27541bd9 100644
--- a/mlir/test/Target/LLVMIR/llvmir.mlir
+++ b/mlir/test/Target/LLVMIR/llvmir.mlir
@@ -996,8 +996,8 @@ llvm.func @gep(%ptr: !llvm.ptr<struct<(i32, struct<(i32, f32)>)>>, %idx: i64,
%ptr2: !llvm.ptr<struct<(array<10 x f32>)>>) {
// CHECK: = getelementptr { i32, { i32, float } }, ptr %{{.*}}, i64 %{{.*}}, i32 1, i32 0
llvm.getelementptr %ptr[%idx, 1, 0] : (!llvm.ptr<struct<(i32, struct<(i32, f32)>)>>, i64) -> !llvm.ptr<i32>
- // CHECK: = getelementptr { [10 x float] }, ptr %{{.*}}, i64 %{{.*}}, i32 0, i64 %{{.*}}
- llvm.getelementptr %ptr2[%idx, 0, %idx] : (!llvm.ptr<struct<(array<10 x f32>)>>, i64, i64) -> !llvm.ptr<f32>
+ // CHECK: = getelementptr inbounds { [10 x float] }, ptr %{{.*}}, i64 %{{.*}}, i32 0, i64 %{{.*}}
+ llvm.getelementptr inbounds %ptr2[%idx, 0, %idx] : (!llvm.ptr<struct<(array<10 x f32>)>>, i64, i64) -> !llvm.ptr<f32>
llvm.return
}
More information about the Mlir-commits
mailing list