[Mlir-commits] [mlir] e112dcc - [mlir][ptr] Add the `ptradd` and `type_offset` ops, and `generic_space` attr (#136434)
llvmlistbot at llvm.org
llvmlistbot at llvm.org
Tue Apr 22 15:32:19 PDT 2025
Author: Fabian Mora
Date: 2025-04-22T18:32:16-04:00
New Revision: e112dccc8ba49425c575a6b15325f2cbeef5c606
URL: https://github.com/llvm/llvm-project/commit/e112dccc8ba49425c575a6b15325f2cbeef5c606
DIFF: https://github.com/llvm/llvm-project/commit/e112dccc8ba49425c575a6b15325f2cbeef5c606.diff
LOG: [mlir][ptr] Add the `ptradd` and `type_offset` ops, and `generic_space` attr (#136434)
This patch adds the `ptr.ptradd` and `ptr.type_offset` operations. Given
a `ptr` value these operations can be used to compute new addresses. For
example:
```mlir
func.func @ops0(%ptr: !ptr.ptr<#ptr.int_space>) -> !ptr.ptr<#ptr.int_space> {
%off = ptr.type_offset f32 : index
%res = ptr.ptradd %ptr, %off : !ptr.ptr<#ptr.int_space>, index
return %res : !ptr.ptr<#ptr.int_space>
}
```
Additionally, this patch also adds the `#ptr.generic_space`. This memory
space allows loading and storing values to all types.
---------
Co-authored-by: Mehdi Amini <joker.eph at gmail.com>
Co-authored-by: Tobias Gysi <tobias.gysi at nextsilicon.com>
Added:
mlir/test/Dialect/Ptr/canonicalize.mlir
mlir/test/Dialect/Ptr/ops.mlir
Modified:
mlir/include/mlir/Dialect/Ptr/IR/PtrAttrDefs.td
mlir/include/mlir/Dialect/Ptr/IR/PtrAttrs.h
mlir/include/mlir/Dialect/Ptr/IR/PtrEnums.td
mlir/include/mlir/Dialect/Ptr/IR/PtrOps.h
mlir/include/mlir/Dialect/Ptr/IR/PtrOps.td
mlir/lib/Dialect/Ptr/IR/CMakeLists.txt
mlir/lib/Dialect/Ptr/IR/PtrAttrs.cpp
mlir/lib/Dialect/Ptr/IR/PtrDialect.cpp
Removed:
################################################################################
diff --git a/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrDefs.td b/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrDefs.td
index e75038f300f1a..4542f57a62d79 100644
--- a/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrDefs.td
+++ b/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrDefs.td
@@ -10,7 +10,9 @@
#define PTR_ATTRDEFS
include "mlir/Dialect/Ptr/IR/PtrDialect.td"
+include "mlir/Dialect/Ptr/IR/MemorySpaceInterfaces.td"
include "mlir/IR/AttrTypeBase.td"
+include "mlir/IR/BuiltinAttributeInterfaces.td"
// All of the attributes will extend this class.
class Ptr_Attr<string name, string attrMnemonic,
@@ -20,6 +22,31 @@ class Ptr_Attr<string name, string attrMnemonic,
let mnemonic = attrMnemonic;
}
+//===----------------------------------------------------------------------===//
+// GenericSpaceAttr
+//===----------------------------------------------------------------------===//
+
+def Ptr_GenericSpaceAttr :
+ Ptr_Attr<"GenericSpace", "generic_space", [
+ DeclareAttrInterfaceMethods<MemorySpaceAttrInterface>
+ ]> {
+ let summary = "Generic memory space";
+ let description = [{
+ The `generic_space` attribute defines a memory space attribute with the
+ following properties:
+ - Load and store operations are always valid, regardless of the type.
+ - Atomic operations are always valid, regardless of the type.
+ - Cast operations to `generic_space` are always valid.
+
+ Example:
+
+ ```mlir
+ #ptr.generic_space
+ ```
+ }];
+ let assemblyFormat = "";
+}
+
//===----------------------------------------------------------------------===//
// SpecAttr
//===----------------------------------------------------------------------===//
diff --git a/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrs.h b/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrs.h
index 5ffe23e45fe12..dc0a3ffd4ae33 100644
--- a/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrs.h
+++ b/mlir/include/mlir/Dialect/Ptr/IR/PtrAttrs.h
@@ -13,7 +13,12 @@
#ifndef MLIR_DIALECT_PTR_IR_PTRATTRS_H
#define MLIR_DIALECT_PTR_IR_PTRATTRS_H
+#include "mlir/IR/BuiltinAttributeInterfaces.h"
#include "mlir/IR/OpImplementation.h"
+#include "mlir/Interfaces/DataLayoutInterfaces.h"
+#include "llvm/Support/TypeSize.h"
+
+#include "mlir/Dialect/Ptr/IR/MemorySpaceInterfaces.h"
#define GET_ATTRDEF_CLASSES
#include "mlir/Dialect/Ptr/IR/PtrOpsAttrs.h.inc"
diff --git a/mlir/include/mlir/Dialect/Ptr/IR/PtrEnums.td b/mlir/include/mlir/Dialect/Ptr/IR/PtrEnums.td
index 0a8a7ede5d1ff..cc556c61e6416 100644
--- a/mlir/include/mlir/Dialect/Ptr/IR/PtrEnums.td
+++ b/mlir/include/mlir/Dialect/Ptr/IR/PtrEnums.td
@@ -66,4 +66,15 @@ def AtomicOrdering : I64EnumAttr<
let cppNamespace = "::mlir::ptr";
}
+//===----------------------------------------------------------------------===//
+// Ptr add flags enum properties.
+//===----------------------------------------------------------------------===//
+
+def Ptr_PtrAddFlags : I32Enum<"PtrAddFlags", "Pointer add flags", [
+ I32EnumCase<"none", 0>, I32EnumCase<"nusw", 1>, I32EnumCase<"nuw", 2>,
+ I32EnumCase<"inbounds", 3>
+ ]> {
+ let cppNamespace = "::mlir::ptr";
+}
+
#endif // PTR_ENUMS
diff --git a/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.h b/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.h
index 6a0c1429c6be9..8686cc7d316d4 100644
--- a/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.h
+++ b/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.h
@@ -18,6 +18,8 @@
#include "mlir/Dialect/Ptr/IR/PtrDialect.h"
#include "mlir/Dialect/Ptr/IR/PtrTypes.h"
#include "mlir/IR/OpDefinition.h"
+#include "mlir/Interfaces/SideEffectInterfaces.h"
+#include "mlir/Interfaces/ViewLikeInterface.h"
#define GET_OP_CLASSES
#include "mlir/Dialect/Ptr/IR/PtrOps.h.inc"
diff --git a/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.td b/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.td
index 02ea71f4322ef..791b95ad3559e 100644
--- a/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.td
+++ b/mlir/include/mlir/Dialect/Ptr/IR/PtrOps.td
@@ -11,7 +11,81 @@
include "mlir/Dialect/Ptr/IR/PtrDialect.td"
include "mlir/Dialect/Ptr/IR/PtrAttrDefs.td"
+include "mlir/Dialect/Ptr/IR/PtrEnums.td"
include "mlir/Dialect/Ptr/IR/MemorySpaceInterfaces.td"
+include "mlir/Interfaces/SideEffectInterfaces.td"
+include "mlir/Interfaces/ViewLikeInterface.td"
include "mlir/IR/OpAsmInterface.td"
+//===----------------------------------------------------------------------===//
+// PtrAddOp
+//===----------------------------------------------------------------------===//
+
+def Ptr_PtrAddOp : Pointer_Op<"ptr_add", [
+ Pure, AllTypesMatch<["base", "result"]>, ViewLikeOpInterface
+ ]> {
+ let summary = "Pointer add operation";
+ let description = [{
+ The `ptr_add` operation adds an integer offset to a pointer to produce a new
+ pointer. The input and output pointer types are always the same.
+
+ Example:
+
+ ```mlir
+ %x_off = ptr.ptr_add %x, %off : !ptr.ptr<0>, i32
+ %x_off0 = ptr.ptr_add nusw %x, %off : !ptr.ptr<0>, i32
+ ```
+ }];
+
+ let arguments = (ins
+ Ptr_PtrType:$base,
+ AnySignlessIntegerOrIndex:$offset,
+ DefaultValuedProp<EnumProp<Ptr_PtrAddFlags>, "PtrAddFlags::none">:$flags);
+ let results = (outs Ptr_PtrType:$result);
+ let assemblyFormat = [{
+ ($flags^)? $base `,` $offset attr-dict `:` type($base) `,` type($offset)
+ }];
+ let hasFolder = 1;
+ let extraClassDeclaration = [{
+ /// `ViewLikeOp::getViewSource` method.
+ Value getViewSource() { return getBase(); }
+ }];
+}
+
+//===----------------------------------------------------------------------===//
+// TypeOffsetOp
+//===----------------------------------------------------------------------===//
+
+def Ptr_TypeOffsetOp : Pointer_Op<"type_offset", [Pure]> {
+ let summary = "Type offset operation";
+ let description = [{
+ The `type_offset` operation produces an int or index-typed SSA value
+ equal to a target-specific constant representing the offset of a single
+ element of the given type.
+
+ Example:
+
+ ```mlir
+ // Return the offset between two f32 stored in memory
+ %0 = ptr.type_offset f32 : index
+ // Return the offset between two memref descriptors stored in memory
+ %1 = ptr.type_offset memref<12 x f64> : i32
+ ```
+ }];
+
+ let arguments = (ins TypeAttr:$elementType);
+ let results = (outs AnySignlessIntegerOrIndex:$result);
+ let builders = [
+ OpBuilder<(ins "Type":$elementType)>
+ ];
+ let assemblyFormat = [{
+ $elementType attr-dict `:` type($result)
+ }];
+ let extraClassDeclaration = [{
+ /// Returns the type offset according to `layout`. If `layout` is `nullopt`
+ /// the nearest layout the op will be used for the computation.
+ llvm::TypeSize getTypeSize(std::optional<DataLayout> layout = std::nullopt);
+ }];
+}
+
#endif // PTR_OPS
diff --git a/mlir/lib/Dialect/Ptr/IR/CMakeLists.txt b/mlir/lib/Dialect/Ptr/IR/CMakeLists.txt
index ba32a76273ed4..497468b9391db 100644
--- a/mlir/lib/Dialect/Ptr/IR/CMakeLists.txt
+++ b/mlir/lib/Dialect/Ptr/IR/CMakeLists.txt
@@ -14,4 +14,5 @@ add_mlir_dialect_library(
MLIRIR
MLIRDataLayoutInterfaces
MLIRMemorySlotInterfaces
+ MLIRViewLikeInterface
)
diff --git a/mlir/lib/Dialect/Ptr/IR/PtrAttrs.cpp b/mlir/lib/Dialect/Ptr/IR/PtrAttrs.cpp
index f8ce820d0bcbd..1770e4febf099 100644
--- a/mlir/lib/Dialect/Ptr/IR/PtrAttrs.cpp
+++ b/mlir/lib/Dialect/Ptr/IR/PtrAttrs.cpp
@@ -11,6 +11,7 @@
//===----------------------------------------------------------------------===//
#include "mlir/Dialect/Ptr/IR/PtrAttrs.h"
+#include "mlir/IR/BuiltinTypes.h"
#include "llvm/ADT/TypeSwitch.h"
using namespace mlir;
@@ -18,6 +19,51 @@ using namespace mlir::ptr;
constexpr const static unsigned kBitsInByte = 8;
+//===----------------------------------------------------------------------===//
+// GenericSpaceAttr
+//===----------------------------------------------------------------------===//
+
+LogicalResult GenericSpaceAttr::isValidLoad(
+ Type type, ptr::AtomicOrdering ordering, IntegerAttr alignment,
+ function_ref<InFlightDiagnostic()> emitError) const {
+ return success();
+}
+
+LogicalResult GenericSpaceAttr::isValidStore(
+ Type type, ptr::AtomicOrdering ordering, IntegerAttr alignment,
+ function_ref<InFlightDiagnostic()> emitError) const {
+ return success();
+}
+
+LogicalResult GenericSpaceAttr::isValidAtomicOp(
+ ptr::AtomicBinOp op, Type type, ptr::AtomicOrdering ordering,
+ IntegerAttr alignment, function_ref<InFlightDiagnostic()> emitError) const {
+ return success();
+}
+
+LogicalResult GenericSpaceAttr::isValidAtomicXchg(
+ Type type, ptr::AtomicOrdering successOrdering,
+ ptr::AtomicOrdering failureOrdering, IntegerAttr alignment,
+ function_ref<InFlightDiagnostic()> emitError) const {
+ return success();
+}
+
+LogicalResult GenericSpaceAttr::isValidAddrSpaceCast(
+ Type tgt, Type src, function_ref<InFlightDiagnostic()> emitError) const {
+ // TODO: update this method once the `addrspace_cast` op is added to the
+ // dialect.
+ assert(false && "unimplemented, see TODO in the source.");
+ return failure();
+}
+
+LogicalResult GenericSpaceAttr::isValidPtrIntCast(
+ Type intLikeTy, Type ptrLikeTy,
+ function_ref<InFlightDiagnostic()> emitError) const {
+ // TODO: update this method once the int-cast ops are added to the dialect.
+ assert(false && "unimplemented, see TODO in the source.");
+ return failure();
+}
+
//===----------------------------------------------------------------------===//
// SpecAttr
//===----------------------------------------------------------------------===//
diff --git a/mlir/lib/Dialect/Ptr/IR/PtrDialect.cpp b/mlir/lib/Dialect/Ptr/IR/PtrDialect.cpp
index ff231dae60c27..c21783011452f 100644
--- a/mlir/lib/Dialect/Ptr/IR/PtrDialect.cpp
+++ b/mlir/lib/Dialect/Ptr/IR/PtrDialect.cpp
@@ -12,7 +12,9 @@
#include "mlir/Dialect/Ptr/IR/PtrOps.h"
#include "mlir/IR/DialectImplementation.h"
+#include "mlir/IR/Matchers.h"
#include "mlir/IR/PatternMatch.h"
+#include "mlir/Interfaces/DataLayoutInterfaces.h"
#include "mlir/Transforms/InliningUtils.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/TypeSwitch.h"
@@ -39,6 +41,31 @@ void PtrDialect::initialize() {
>();
}
+//===----------------------------------------------------------------------===//
+// PtrAddOp
+//===----------------------------------------------------------------------===//
+
+/// Fold: ptradd ptr + 0 -> ptr
+OpFoldResult PtrAddOp::fold(FoldAdaptor adaptor) {
+ Attribute attr = adaptor.getOffset();
+ if (!attr)
+ return nullptr;
+ if (llvm::APInt value; m_ConstantInt(&value).match(attr) && value.isZero())
+ return getBase();
+ return nullptr;
+}
+
+//===----------------------------------------------------------------------===//
+// TypeOffsetOp
+//===----------------------------------------------------------------------===//
+
+llvm::TypeSize TypeOffsetOp::getTypeSize(std::optional<DataLayout> layout) {
+ if (layout)
+ return layout->getTypeSize(getElementType());
+ DataLayout dl = DataLayout::closest(*this);
+ return dl.getTypeSize(getElementType());
+}
+
//===----------------------------------------------------------------------===//
// Pointer API.
//===----------------------------------------------------------------------===//
diff --git a/mlir/test/Dialect/Ptr/canonicalize.mlir b/mlir/test/Dialect/Ptr/canonicalize.mlir
new file mode 100644
index 0000000000000..ad363d554f247
--- /dev/null
+++ b/mlir/test/Dialect/Ptr/canonicalize.mlir
@@ -0,0 +1,15 @@
+// RUN: mlir-opt --canonicalize %s | FileCheck %s
+
+/// Check `ptr_add` canonicalizer patterns.
+
+// CHECK-LABEL: @zero_offset
+// CHECK-SAME: (%[[PTR_0:.*]]: !ptr.ptr<#ptr.generic_space>)
+func.func @zero_offset(%ptr: !ptr.ptr<#ptr.generic_space>) -> !ptr.ptr<#ptr.generic_space> {
+ // CHECK-NOT: index.constant
+ // CHECK-NOT: ptr.ptr_add
+ // CHECK: return %[[PTR_0]] : !ptr.ptr<#ptr.generic_space>
+ // CHECK: }
+ %off = index.constant 0
+ %res0 = ptr.ptr_add %ptr, %off : !ptr.ptr<#ptr.generic_space>, index
+ return %res0 : !ptr.ptr<#ptr.generic_space>
+}
diff --git a/mlir/test/Dialect/Ptr/ops.mlir b/mlir/test/Dialect/Ptr/ops.mlir
new file mode 100644
index 0000000000000..d763ea221944b
--- /dev/null
+++ b/mlir/test/Dialect/Ptr/ops.mlir
@@ -0,0 +1,19 @@
+// RUN: mlir-opt %s --verify-roundtrip | FileCheck %s
+
+/// Check op assembly.
+// CHECK-LABEL: @ptr_add_type_offset
+func.func @ptr_add_type_offset(%ptr: !ptr.ptr<#ptr.generic_space>) -> !ptr.ptr<#ptr.generic_space> {
+ // CHECK: ptr.type_offset f32 : index
+ // CHECK-NEXT: ptr.ptr_add %{{.*}}, %{{.*}} : <#ptr.generic_space>, index
+ // CHECK-NEXT: ptr.ptr_add %{{.*}}, %{{.*}} : <#ptr.generic_space>, index
+ // CHECK-NEXT: ptr.ptr_add nusw %{{.*}}, %{{.*}} : <#ptr.generic_space>, index
+ // CHECK-NEXT: ptr.ptr_add nuw %{{.*}}, %{{.*}} : <#ptr.generic_space>, index
+ // CHECK-NEXT: ptr.ptr_add inbounds %{{.*}}, %{{.*}} : <#ptr.generic_space>, index
+ %off = ptr.type_offset f32 : index
+ %res = ptr.ptr_add %ptr, %off : !ptr.ptr<#ptr.generic_space>, index
+ %res0 = ptr.ptr_add none %ptr, %off : !ptr.ptr<#ptr.generic_space>, index
+ %res1 = ptr.ptr_add nusw %ptr, %off : !ptr.ptr<#ptr.generic_space>, index
+ %res2 = ptr.ptr_add nuw %ptr, %off : !ptr.ptr<#ptr.generic_space>, index
+ %res3 = ptr.ptr_add inbounds %ptr, %off : !ptr.ptr<#ptr.generic_space>, index
+ return %res : !ptr.ptr<#ptr.generic_space>
+}
More information about the Mlir-commits
mailing list